|
36 | 36 | <remarks>
|
37 | 37 | <format type="text/markdown"><![CDATA[
|
38 | 38 |
|
39 |
| -## Remarks |
40 |
| - The <xref:System.Net.HttpStatusCode> enumeration contains the values of the status codes defined in RFC 2616 for HTTP 1.1. |
41 |
| - |
42 |
| - The status of an HTTP request is contained in the <xref:System.Net.HttpWebResponse.StatusCode%2A?displayProperty=nameWithType> property. |
43 |
| - |
44 |
| - |
| 39 | +## Remarks |
| 40 | +
|
| 41 | +The <xref:System.Net.HttpStatusCode> enumeration contains the values of the status codes defined in RFC 2616 for HTTP 1.1. |
45 | 42 |
|
| 43 | +The status of an HTTP request is contained in the <xref:System.Net.HttpWebResponse.StatusCode%2A?displayProperty=nameWithType> property. |
| 44 | +If the <xref:System.Net.HttpWebRequest.AllowAutoRedirect%2A?displayProperty=nameWithType> property is `false`, the following enumeration values cause an exception to be thrown: |
| 45 | + |
| 46 | +- `Ambiguous` |
| 47 | +- `Found` |
| 48 | +- `MultipleChoices` |
| 49 | +- `Redirect` |
| 50 | +- `RedirectKeepVerb` |
| 51 | +- `RedirectMethod` |
| 52 | +- `SeeOther` |
| 53 | +- `TemporaryRedirect` |
| 54 | +
|
46 | 55 | ## Examples
|
47 | 56 | The following example compares the status returned by an <xref:System.Net.HttpWebResponse> with a member of the <xref:System.Net.HttpStatusCode> class to determine the status of a response.
|
48 | 57 |
|
|
159 | 168 | </ReturnValue>
|
160 | 169 | <MemberValue>300</MemberValue>
|
161 | 170 | <Docs>
|
162 |
| - <summary>Equivalent to HTTP status 300. <see cref="F:System.Net.HttpStatusCode.Ambiguous" /> indicates that the requested information has multiple representations. The default action is to treat this status as a redirect and follow the contents of the Location header associated with this response.</summary> |
163 |
| - <remarks> |
164 |
| - <format type="text/markdown"><![CDATA[ |
165 |
| - |
166 |
| -## Remarks |
167 |
| - If the <xref:System.Net.HttpWebRequest.AllowAutoRedirect%2A?displayProperty=nameWithType> property is `false`, Ambiguous will cause an exception to be thrown. |
168 |
| - |
169 |
| - Ambiguous is a synonym for MultipleChoices. |
170 |
| - |
171 |
| - ]]></format> |
172 |
| - </remarks> |
| 171 | + <summary>Equivalent to HTTP status 300. <see cref="F:System.Net.HttpStatusCode.Ambiguous" /> indicates that the requested information has multiple representations. The default action is to treat this status as a redirect and follow the contents of the Location header associated with this response. <c>Ambiguous</c> is a synonym for <c>MultipleChoices</c>.</summary> |
| 172 | + <remarks>To be added.</remarks> |
173 | 173 | </Docs>
|
174 | 174 | </Member>
|
175 | 175 | <Member MemberName="BadGateway">
|
|
541 | 541 | </ReturnValue>
|
542 | 542 | <MemberValue>302</MemberValue>
|
543 | 543 | <Docs>
|
544 |
| - <summary>Equivalent to HTTP status 302. <see cref="F:System.Net.HttpStatusCode.Found" /> indicates that the requested information is located at the URI specified in the Location header. The default action when this status is received is to follow the Location header associated with the response. When the original request method was POST, the redirected request will use the GET method.</summary> |
545 |
| - <remarks> |
546 |
| - <format type="text/markdown"><![CDATA[ |
547 |
| - |
548 |
| -## Remarks |
549 |
| - If the <xref:System.Net.HttpWebRequest.AllowAutoRedirect%2A?displayProperty=nameWithType> property is `false`, Found will cause an exception to be thrown. |
550 |
| - |
551 |
| - Found is a synonym for Redirect. |
552 |
| - |
553 |
| - ]]></format> |
554 |
| - </remarks> |
| 544 | + <summary>Equivalent to HTTP status 302. <see cref="F:System.Net.HttpStatusCode.Found" /> indicates that the requested information is located at the URI specified in the Location header. The default action when this status is received is to follow the Location header associated with the response. When the original request method was POST, the redirected request will use the GET method. <c>Found</c> is a synonym for <c>Redirect</c>.</summary> |
| 545 | + <remarks>To be added.</remarks> |
555 | 546 | </Docs>
|
556 | 547 | </Member>
|
557 | 548 | <Member MemberName="GatewayTimeout">
|
|
974 | 965 | </ReturnValue>
|
975 | 966 | <MemberValue>301</MemberValue>
|
976 | 967 | <Docs>
|
977 |
| - <summary>Equivalent to HTTP status 301. <see cref="F:System.Net.HttpStatusCode.Moved" /> indicates that the requested information has been moved to the URI specified in the Location header. The default action when this status is received is to follow the Location header associated with the response. When the original request method was POST, the redirected request will use the GET method.</summary> |
978 |
| - <remarks> |
979 |
| - <format type="text/markdown"><![CDATA[ |
980 |
| - |
981 |
| -## Remarks |
982 |
| - Moved is a synonym for MovedPermanently. |
983 |
| - |
984 |
| - ]]></format> |
985 |
| - </remarks> |
| 968 | + <summary>Equivalent to HTTP status 301. <see cref="F:System.Net.HttpStatusCode.Moved" /> indicates that the requested information has been moved to the URI specified in the Location header. The default action when this status is received is to follow the Location header associated with the response. When the original request method was POST, the redirected request will use the GET method. <c>Moved</c> is a synonym for <c>MovedPermanently</c>.</summary> |
| 969 | + <remarks>To be added.</remarks> |
986 | 970 | </Docs>
|
987 | 971 | </Member>
|
988 | 972 | <Member MemberName="MovedPermanently">
|
|
1021 | 1005 | </ReturnValue>
|
1022 | 1006 | <MemberValue>301</MemberValue>
|
1023 | 1007 | <Docs>
|
1024 |
| - <summary>Equivalent to HTTP status 301. <see cref="F:System.Net.HttpStatusCode.MovedPermanently" /> indicates that the requested information has been moved to the URI specified in the Location header. The default action when this status is received is to follow the Location header associated with the response.</summary> |
1025 |
| - <remarks> |
1026 |
| - <format type="text/markdown"><![CDATA[ |
1027 |
| - |
1028 |
| -## Remarks |
1029 |
| - MovedPermanently is a synonym for Moved. |
1030 |
| - |
1031 |
| - ]]></format> |
1032 |
| - </remarks> |
| 1008 | + <summary>Equivalent to HTTP status 301. <see cref="F:System.Net.HttpStatusCode.MovedPermanently" /> indicates that the requested information has been moved to the URI specified in the Location header. The default action when this status is received is to follow the Location header associated with the response. <c>MovedPermanently</c> is a synonym for <c>Moved</c>.</summary> |
| 1009 | + <remarks>To be added.</remarks> |
1033 | 1010 | </Docs>
|
1034 | 1011 | </Member>
|
1035 | 1012 | <Member MemberName="MultipleChoices">
|
|
1068 | 1045 | </ReturnValue>
|
1069 | 1046 | <MemberValue>300</MemberValue>
|
1070 | 1047 | <Docs>
|
1071 |
| - <summary>Equivalent to HTTP status 300. <see cref="F:System.Net.HttpStatusCode.MultipleChoices" /> indicates that the requested information has multiple representations. The default action is to treat this status as a redirect and follow the contents of the Location header associated with this response.</summary> |
1072 |
| - <remarks> |
1073 |
| - <format type="text/markdown"><![CDATA[ |
1074 |
| - |
1075 |
| -## Remarks |
1076 |
| - If the <xref:System.Net.HttpWebRequest.AllowAutoRedirect%2A?displayProperty=nameWithType> property is `false`, MultipleChoices will cause an exception to be thrown. |
1077 |
| - |
1078 |
| - MultipleChoices is a synonym for Ambiguous. |
1079 |
| - |
1080 |
| - ]]></format> |
1081 |
| - </remarks> |
| 1048 | + <summary>Equivalent to HTTP status 300. <see cref="F:System.Net.HttpStatusCode.MultipleChoices" /> indicates that the requested information has multiple representations. The default action is to treat this status as a redirect and follow the contents of the Location header associated with this response. <c>MultipleChoices</c> is a synonym for <c>Ambiguous</c>.</summary> |
| 1049 | + <remarks>To be added.</remarks> |
1082 | 1050 | </Docs>
|
1083 | 1051 | </Member>
|
1084 | 1052 | <Member MemberName="MultiStatus">
|
|
1726 | 1694 | </ReturnValue>
|
1727 | 1695 | <MemberValue>302</MemberValue>
|
1728 | 1696 | <Docs>
|
1729 |
| - <summary>Equivalent to HTTP status 302. <see cref="F:System.Net.HttpStatusCode.Redirect" /> indicates that the requested information is located at the URI specified in the Location header. The default action when this status is received is to follow the Location header associated with the response. When the original request method was POST, the redirected request will use the GET method.</summary> |
1730 |
| - <remarks> |
1731 |
| - <format type="text/markdown"><![CDATA[ |
1732 |
| - |
1733 |
| -## Remarks |
1734 |
| - If the <xref:System.Net.HttpWebRequest.AllowAutoRedirect%2A?displayProperty=nameWithType> property is `false`, Redirect will cause an exception to be thrown. |
1735 |
| - |
1736 |
| - Redirect is a synonym for Found. |
1737 |
| - |
1738 |
| - ]]></format> |
1739 |
| - </remarks> |
| 1697 | + <summary>Equivalent to HTTP status 302. <see cref="F:System.Net.HttpStatusCode.Redirect" /> indicates that the requested information is located at the URI specified in the Location header. The default action when this status is received is to follow the Location header associated with the response. When the original request method was POST, the redirected request will use the GET method. <c>Redirect</c> is a synonym for <c>Found</c>.</summary> |
| 1698 | + <remarks>To be added.</remarks> |
1740 | 1699 | </Docs>
|
1741 | 1700 | </Member>
|
1742 | 1701 | <Member MemberName="RedirectKeepVerb">
|
|
1775 | 1734 | </ReturnValue>
|
1776 | 1735 | <MemberValue>307</MemberValue>
|
1777 | 1736 | <Docs>
|
1778 |
| - <summary>Equivalent to HTTP status 307. <see cref="F:System.Net.HttpStatusCode.RedirectKeepVerb" /> indicates that the request information is located at the URI specified in the Location header. The default action when this status is received is to follow the Location header associated with the response. When the original request method was POST, the redirected request will also use the POST method.</summary> |
1779 |
| - <remarks> |
1780 |
| - <format type="text/markdown"><![CDATA[ |
1781 |
| - |
1782 |
| -## Remarks |
1783 |
| - If the <xref:System.Net.HttpWebRequest.AllowAutoRedirect%2A?displayProperty=nameWithType> property is `false`, RedirectKeepVerb will cause an exception to be thrown. |
1784 |
| - |
1785 |
| - RedirectKeepVerb is a synonym for TemporaryRedirect. |
1786 |
| - |
1787 |
| - ]]></format> |
1788 |
| - </remarks> |
| 1737 | + <summary>Equivalent to HTTP status 307. <see cref="F:System.Net.HttpStatusCode.RedirectKeepVerb" /> indicates that the request information is located at the URI specified in the Location header. The default action when this status is received is to follow the Location header associated with the response. When the original request method was POST, the redirected request will also use the POST method. <c>RedirectKeepVerb</c> is a synonym for <c>TemporaryRedirect</c>.</summary> |
| 1738 | + <remarks>To be added.</remarks> |
1789 | 1739 | </Docs>
|
1790 | 1740 | </Member>
|
1791 | 1741 | <Member MemberName="RedirectMethod">
|
|
1824 | 1774 | </ReturnValue>
|
1825 | 1775 | <MemberValue>303</MemberValue>
|
1826 | 1776 | <Docs>
|
1827 |
| - <summary>Equivalent to HTTP status 303. <see cref="F:System.Net.HttpStatusCode.RedirectMethod" /> automatically redirects the client to the URI specified in the Location header as the result of a POST. The request to the resource specified by the Location header will be made with a GET.</summary> |
1828 |
| - <remarks> |
1829 |
| - <format type="text/markdown"><![CDATA[ |
1830 |
| - |
1831 |
| -## Remarks |
1832 |
| - If the <xref:System.Net.HttpWebRequest.AllowAutoRedirect%2A?displayProperty=nameWithType> property is `false`, RedirectMethod will cause an exception to be thrown. |
1833 |
| - |
1834 |
| - RedirectMethod is a synonym for SeeOther. |
1835 |
| - |
1836 |
| - ]]></format> |
1837 |
| - </remarks> |
| 1777 | + <summary>Equivalent to HTTP status 303. <see cref="F:System.Net.HttpStatusCode.RedirectMethod" /> automatically redirects the client to the URI specified in the Location header as the result of a POST. The request to the resource specified by the Location header will be made with a GET. <c>RedirectMethod</c> is a synonym for <c>SeeOther</c>.</summary> |
| 1778 | + <remarks>To be added.</remarks> |
1838 | 1779 | </Docs>
|
1839 | 1780 | </Member>
|
1840 | 1781 | <Member MemberName="RequestedRangeNotSatisfiable">
|
|
2098 | 2039 | </ReturnValue>
|
2099 | 2040 | <MemberValue>303</MemberValue>
|
2100 | 2041 | <Docs>
|
2101 |
| - <summary>Equivalent to HTTP status 303. <see cref="F:System.Net.HttpStatusCode.SeeOther" /> automatically redirects the client to the URI specified in the Location header as the result of a POST. The request to the resource specified by the Location header will be made with a GET.</summary> |
2102 |
| - <remarks> |
2103 |
| - <format type="text/markdown"><![CDATA[ |
2104 |
| - |
2105 |
| -## Remarks |
2106 |
| - If the <xref:System.Net.HttpWebRequest.AllowAutoRedirect%2A?displayProperty=nameWithType> property is `false`, SeeOther will cause an exception to be thrown. |
2107 |
| - |
2108 |
| - SeeOther is a synonym for RedirectMethod. |
2109 |
| - |
2110 |
| - ]]></format> |
2111 |
| - </remarks> |
| 2042 | + <summary>Equivalent to HTTP status 303. <see cref="F:System.Net.HttpStatusCode.SeeOther" /> automatically redirects the client to the URI specified in the Location header as the result of a POST. The request to the resource specified by the Location header will be made with a GET. <c>SeeOther</c> is a synonym for <c>RedirectMethod</c></summary> |
| 2043 | + <remarks>To be added.</remarks> |
2112 | 2044 | </Docs>
|
2113 | 2045 | </Member>
|
2114 | 2046 | <Member MemberName="ServiceUnavailable">
|
|
2225 | 2157 | </ReturnValue>
|
2226 | 2158 | <MemberValue>307</MemberValue>
|
2227 | 2159 | <Docs>
|
2228 |
| - <summary>Equivalent to HTTP status 307. <see cref="F:System.Net.HttpStatusCode.TemporaryRedirect" /> indicates that the request information is located at the URI specified in the Location header. The default action when this status is received is to follow the Location header associated with the response. When the original request method was POST, the redirected request will also use the POST method.</summary> |
2229 |
| - <remarks> |
2230 |
| - <format type="text/markdown"><![CDATA[ |
2231 |
| - |
2232 |
| -## Remarks |
2233 |
| - If the <xref:System.Net.HttpWebRequest.AllowAutoRedirect%2A?displayProperty=nameWithType> property is `false`, TemporaryRedirect will cause an exception to be thrown. |
2234 |
| - |
2235 |
| - TemporaryRedirect is a synonym for RedirectKeepVerb. |
2236 |
| - |
2237 |
| - ]]></format> |
2238 |
| - </remarks> |
| 2160 | + <summary>Equivalent to HTTP status 307. <see cref="F:System.Net.HttpStatusCode.TemporaryRedirect" /> indicates that the request information is located at the URI specified in the Location header. The default action when this status is received is to follow the Location header associated with the response. When the original request method was POST, the redirected request will also use the POST method. <c>TemporaryRedirect</c> is a synonym for <c>RedirectKeepVerb</c>.</summary> |
| 2161 | + <remarks>To be added.</remarks> |
2239 | 2162 | </Docs>
|
2240 | 2163 | </Member>
|
2241 | 2164 | <Member MemberName="TooManyRequests">
|
|
0 commit comments