AddHeader (HttpRequest subroutine): Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
m (1 revision) |
||
| Line 1: | Line 1: | ||
{{Template:HTTPRequest:AddHeader subtitle}} | |||
This method lets you add an HTTP request header | This method lets you add an HTTP request header | ||
to the HTTP request that will be sent to the HTTP server. | to the HTTP request that will be sent to the HTTP server. | ||
==Syntax== | ==Syntax== | ||
{{Template:HTTPRequest:AddHeader syntax}} | |||
===Syntax terms=== | ===Syntax terms=== | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
| Line 14: | Line 11: | ||
</td></tr> | </td></tr> | ||
<tr><th>header</th> | <tr><th>header</th> | ||
<td>A string expression that names an HTTP request header such as “accept-encoding.” Header names are case insensitive. | <td>A string expression that names an HTTP request header such as &ldquo;accept-encoding.&rdquo; Header names are case insensitive. | ||
Passing multiple occurrences is allowed: if a same-named header is already present, an additional occurrence is added. <br>'''Note:''' Do not specify “content-length”; an attempt to do so results in cancellation of the request. The HTTP Helper automatically calculates the number of bytes in the non-header data, and it inserts a Content-Length header on Post calls. | Passing multiple occurrences is allowed: if a same-named header is already present, an additional occurrence is added. <br>'''Note:''' Do not specify &ldquo;content-length&rdquo;; an attempt to do so results in cancellation of the request. The HTTP Helper automatically calculates the number of bytes in the non-header data, and it inserts a Content-Length header on Post calls. | ||
</td></tr> | </td></tr> | ||
<tr><th>value</th> | <tr><th>value</th> | ||
| Line 24: | Line 21: | ||
<ul> | <ul> | ||
<li>For HTTP Version 1.1 mode only, | <li>For HTTP Version 1.1 mode only, | ||
the HTTP Request header “connection: close” is automatically | the HTTP Request header &ldquo;connection: close&rdquo; is automatically | ||
sent on GETs and POSTs to ensure that the server closes the | sent on GETs and POSTs to ensure that the server closes the | ||
connection with the client when the HTTP Request completes. | connection with the client when the HTTP Request completes. | ||
| Line 37: | Line 34: | ||
is suppressed to ensure that an extra connection header is not sent. | is suppressed to ensure that an extra connection header is not sent. | ||
</ul> | </ul> | ||
==See also== | |||
{{Template:HTTPRequest:AddHeader footer}} | |||
Revision as of 18:21, 15 June 2011
Template:HTTPRequest:AddHeader subtitle
This method lets you add an HTTP request header to the HTTP request that will be sent to the HTTP server.
Syntax
Template:HTTPRequest:AddHeader syntax
Syntax terms
| %httpreq | A previously defined and instantiated HTTPRequest object. |
|---|---|
| header | A string expression that names an HTTP request header such as “accept-encoding.” Header names are case insensitive.
Passing multiple occurrences is allowed: if a same-named header is already present, an additional occurrence is added. |
| value | A string expression that yields a value for the request header. |
Usage notes
- For HTTP Version 1.1 mode only,
the HTTP Request header “connection: close” is automatically
sent on GETs and POSTs to ensure that the server closes the
connection with the client when the HTTP Request completes.
The HTTP Helper does not support persistent connections.
If you try to set a "connection" header using
AddHeader, any value
except
closeresults in request cancellation.
Note: If you explicitly set "connection" toclose, the automatic generation of "Connection: close" is suppressed to ensure that an extra connection header is not sent.