MaxRedirects (HttpRequest property): Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
m (1 revision) |
||
| Line 2: | Line 2: | ||
This method lets you request automatic handling of redirects that a | This method lets you request automatic handling of redirects that a | ||
<var>[[Get ( | <var>[[Get (HttpRequest function)|Get]]</var>, <var>[[Post (HttpRequest function)|Post]]</var>, | ||
or <var>[[Send ( | or <var>[[Send (HttpRequest function)|Send]]</var> method call receives from the server. | ||
Since redirects may be chained, that is, the location to which a redirect | Since redirects may be chained, that is, the location to which a redirect | ||
leads can also return a redirect, <var>MaxRedirects</var> specifies the maximum number of | leads can also return a redirect, <var>MaxRedirects</var> specifies the maximum number of | ||
| Line 12: | Line 12: | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>%httpreq</th> | <tr><th>%httpreq</th> | ||
<td>An instantiated <var> | <td>An instantiated <var>HttpRequest</var> object. | ||
</td></tr> | </td></tr> | ||
<tr><th>value</th> | <tr><th>value</th> | ||
| Line 28: | Line 28: | ||
moved and that the client process should fetch it from a new location. | moved and that the client process should fetch it from a new location. | ||
A server indicates this case by returning a response code in the 300s and | A server indicates this case by returning a response code in the 300s and | ||
by returning a response header named &amp;amp;ldquo;location&amp;amp;rdquo; that indicates the new | by returning a response header named &amp;amp;amp;ldquo;location&amp;amp;amp;rdquo; that indicates the new | ||
location of the page or resource. | location of the page or resource. | ||
The <var class="product">HTTP Helper</var> returns such a response code | The <var class="product">HTTP Helper</var> returns such a response code | ||
| Line 51: | Line 51: | ||
For more details concerning HTTP Response codes, | For more details concerning HTTP Response codes, | ||
see http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html. | see http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html. | ||
<li>To facilitate working with redirects, the <var>[[Url ( | <li>To facilitate working with redirects, the <var>[[Url (HttpRequest property)|Url]]</var> | ||
method of the <var>HTTPResponse</var> object | method of the <var>HTTPResponse</var> object | ||
returns the actual URL from which a response was obtained. | returns the actual URL from which a response was obtained. | ||
Revision as of 20:17, 16 June 2011
Automatically handle redirects (HttpRequest class)
This method lets you request automatic handling of redirects that a
Get, Post,
or Send method call receives from the server.
Since redirects may be chained, that is, the location to which a redirect
leads can also return a redirect, MaxRedirects specifies the maximum number of
times a redirect is followed when it is returned from a web server.
Syntax
%currentNumber = httpRequest:MaxRedirects httpRequest:MaxRedirects = newNumber
Syntax terms
| %httpreq | An instantiated HttpRequest object. |
|---|---|
| value | A numeric expression that evaluates to an integer from 0 through 100, which indicates the maximum number of times a redirect is followed on one Get, Post, or Send call.
If an invalid or out of range value is specified, the request is canceled. A value of 0 (the default) means redirects are not automatically handled. |
| %curr | The numeric variable for the assignment of the current value of MaxRedirects. |
Usage notes
- An HTTP server may return an indication that a page has moved and that the client process should fetch it from a new location. A server indicates this case by returning a response code in the 300s and by returning a response header named &amp;amp;ldquo;location&amp;amp;rdquo; that indicates the new location of the page or resource. The HTTP Helper returns such a response code to the application and takes no further action.
- If the maximum number of redirections have been followed, and the last response is still a redirection response code, the last redirection response code is returned to the HTTP Helper application.
- When MaxRedirects is set to a value greater than zero, the following
HTTP redirection response codes are automatically handled:
- 301
- Moved Permanently
- 302
- Found
- 303
- See Other
- 307
- Temporary Redirect
For more details concerning HTTP Response codes, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html.
- To facilitate working with redirects, the Url method of the HTTPResponse object returns the actual URL from which a response was obtained.