HeaderValue (HttpResponse function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (1 revision)
m (1 revision)
Line 1: Line 1:
 
{{Template:HttpResponse:HeaderValue subtitle}}
<span class="pageSubtitle"><section begin=dpl_desc/><section end=dpl_desc/></span>
[[Category:HttpResponse methods|HeaderValue function]]
<p>
<var>HeaderValue</var> is a member of the <var>[[HttpResponse class|HttpResponse]]</var> class.
</p>


This method helps you retrieve the HTTP
This method helps you retrieve the HTTP
Line 12: Line 7:
of a header.
of a header.
==Syntax==
==Syntax==
<p class="syntax">%st = %httpresp:HeaderValue(name, [sub])
{{Template:HttpResponse:HeaderValue syntax}}
</p>
 
===Syntax terms===
===Syntax terms===
<table class="syntaxTable">
<table class="syntaxTable">
Line 31: Line 24:


</td></tr></table>
</td></tr></table>
==See also==
{{Template:HttpResponse:HeaderValue footer}}

Revision as of 19:41, 17 June 2011

HTTP response header value (HttpResponse class)


This method helps you retrieve the HTTP response headers returned by an HTTP request. HeaderValue returns the value of the header whose name you specify, and it can optionally return the value of a particular occurrence of a header.

Syntax

%string = httpResponse:HeaderValue( name, [occurrence])

Syntax terms

%st A string or longstring variable for the assignment of the header value (or a zero-length string, if the requested header is not present).
%httpresp A reference to an HTTPResponse object that was returned by a Get, Post, or Send method of an HTTPRequest object.
name A string expression that yields the name of an HTTP response header. If name is not present, HeaderValue returns a zero-length string.
sub Identifies a particular occurrence of header name. It is a numeric expression that must evaluate to an integer from 1 through the number of occurrences of the header. The number of occurrences is available from HeaderCount(name), as described in HeaderCount.

If you specify a non-positive or non-numeric value, the request is cancelled. If sub is not explicitly specified, its default is 1.

See also