$Web_Hdr_Parm
<section begin="desc" />Value of request header field<section end="desc" />
$Web_Hdr_Parm retrieves the value of a request header field.
Syntax
<section begin="syntax" /> %STRING = $Web_Hdr_Parm( fieldname, occurrence, - start, length ) <section end="syntax" />
$Web_Hdr_Parm takes four arguments and returns a string, or null for any error condition.
| fieldname | The name of the header field, returned by $Web_Hdr_Name. Required argument if occurrence not specified, otherwise optional. |
|---|---|
| occurrence | The occurrence number of a header field, or the occurrence number of the header field matching fieldname, if fieldname is specified. Optional argument if fieldname is specified, otherwise it is required. |
| start | Starting position within the field. Optional argument which defaults to 1. |
| length | Length to return. This is an optional argument which defaults to the length of the header field. The length of a header field can be determined with $Web_Hdr_Len. |
The following example places the value of each header parameter into a User Language %variable of the same name.
* Stash the header values in matching fields. %METHOD = $Web_Hdr_Parm( 'METHOD' ) %URL = $Web_Hdr_Parm( 'URL' ) %VERSION = $Web_Hdr_Parm( 'VERSION' )
See also:
- [[$Web_Hdr_Len]]
- [[$Web_Hdr_Name]]
- [[$Web_Num_Hdr]]
- [[$Web_Hdr_Parm_Lstr]]