Success (HttpResponse function): Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
m (match syntax table to syntax template; edits, tags and links) |
||
| Line 1: | Line 1: | ||
{{Template:HttpResponse:Success subtitle}} | {{Template:HttpResponse:Success subtitle}} | ||
The <var>Success</var> method lets you check the status code value in the status line of the result of the most recent <var>[[Get (HttpRequest function)|Get]]</var>, <var>[[Post (HttpRequest function)|Post]]</var>, or <var>[[Send (HttpRequest function)|Send]]</var> operation. | |||
==Syntax== | ==Syntax== | ||
{{Template:HttpResponse:Success syntax}} | {{Template:HttpResponse:Success syntax}} | ||
===Syntax terms=== | ===Syntax terms=== | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>% | <tr><th>%number</th> | ||
<td>A numeric variable for the assignment of the Success value of | <td>A numeric variable for the assignment of the Success value of <var class="term">httpResponse</var>. Success returns 1 (True) if the HTTP status code is in the 200s (success range), and it returns 0 (False) otherwise. | ||
</td></tr> | </td></tr> | ||
<tr><th> | <tr><th>httpResponse</th> | ||
<td>A reference to an | <td>A reference to an <var>[[HttpResponse_class|HttpResponse]]</var> object that was returned by a <var>Get</var>, <var>Post</var>, or <var>Send</var> method of an <var>[[HttpRequest_class|HttpRequest]]</var> object.</td></tr> | ||
</table> | |||
==Usage notes== | ==Usage notes== | ||
<ul> | |||
<li>If <var>Success</var> returns 1 (True), content was retrieved and is available via the <var>[[Content (HttpResponse function)|Content]]</var> and <var>[[ParseXml (HttpResponse function)|ParseXml]]</var> methods. | |||
</ul> | |||
==See also== | ==See also== | ||
{{Template:HttpResponse:Success footer}} | {{Template:HttpResponse:Success footer}} | ||
Revision as of 06:55, 19 June 2011
Check status code value of most recent request (HttpResponse class)
The Success method lets you check the status code value in the status line of the result of the most recent Get, Post, or Send operation.
Syntax
%number = httpResponse:Success
Syntax terms
| %number | A numeric variable for the assignment of the Success value of httpResponse. Success returns 1 (True) if the HTTP status code is in the 200s (success range), and it returns 0 (False) otherwise. |
|---|---|
| httpResponse | A reference to an HttpResponse object that was returned by a Get, Post, or Send method of an HttpRequest object. |
Usage notes
- If Success returns 1 (True), content was retrieved and is available via the Content and ParseXml methods.