$Web Hdr Parm Lstr: Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
mNo edit summary |
||
| Line 2: | Line 2: | ||
<span class="pageSubtitle"><section begin="desc" />Value of header parameter to longstring<section end="desc" /></span> | <span class="pageSubtitle"><section begin="desc" />Value of header parameter to longstring<section end="desc" /></span> | ||
$Web_Hdr_Parm_Lstr retrieves the value of an HTTP header parameter as a longstring. | $Web_Hdr_Parm_Lstr retrieves the value of an HTTP header parameter as a [[Longstrings|longstring]]. | ||
$Web_Hdr_Parm_Lstr takes two arguments, and it returns a longstring (or null for any error condition). | |||
==Syntax== | ==Syntax== | ||
<p class="syntax"><section begin="syntax" /> %STRING = $Web_Hdr_Parm_Lstr( name, occurrence ) | <p class="syntax"><section begin="syntax" /> %STRING = $Web_Hdr_Parm_Lstr( name, occurrence ) | ||
<section end="syntax" /></p> | <section end="syntax" /></p> | ||
===Syntax terms=== | |||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>name</th> | <tr><th>name</th> | ||
| Line 16: | Line 18: | ||
</td></tr></table> | </td></tr></table> | ||
==Usage notes== | |||
<ul> | |||
<li>$Web_Hdr_Parm_Lstr works much like $WEB_HDR_PARM, except for the following: | |||
< | |||
$Web_Hdr_Parm_Lstr works much like $WEB_HDR_PARM, except for the following: | |||
<ul> | <ul> | ||
<li>It can return more than 255 bytes of data into a longstring. | <li>It can return more than 255 bytes of data into a longstring. | ||
<li>It causes request cancellation if the result would be truncated, either on assignment to a target STRING %variable, or as input to a STRING $function argument or subroutine parameter. | <li>It causes request cancellation if the result would be truncated, either on assignment to a target STRING %variable, or as input to a STRING $function argument or subroutine parameter. | ||
<li>It does not have position and length arguments (arguments 3 and 4). | <li>It does not have position and length arguments (arguments 3 and 4). | ||
</ul> | </ul></ul> | ||
==Examples== | |||
This example places the value of two header parameters into a User Language Longstring variable of the same name. | |||
<p class="code">%accept = $Web_Hdr_Parm_Lstr('ACCEPT') | |||
%referer = $Web_Hdr_Parm_Lstr('REFERER') | |||
</p> | |||
==See also== | |||
See also | |||
<ul> | <ul> | ||
<li><var>[[$Web_Hdr_Parm]]</var> | <li><var>[[$Web_Hdr_Parm]]</var> | ||
<li><var>[[$Web_Hdr_Name]]</var> | <li><var>[[$Web_Hdr_Name]]</var> | ||
Revision as of 21:41, 12 June 2012
<section begin="desc" />Value of header parameter to longstring<section end="desc" />
$Web_Hdr_Parm_Lstr retrieves the value of an HTTP header parameter as a longstring.
$Web_Hdr_Parm_Lstr takes two arguments, and it returns a longstring (or null for any error condition).
Syntax
<section begin="syntax" /> %STRING = $Web_Hdr_Parm_Lstr( name, occurrence ) <section end="syntax" />
Syntax terms
| name | The name of the header parameter, returned by $Web_Hdr_Name. This is a required argument if occurrence is not specified; otherwise it is optional. |
|---|---|
| occurrence | The occurrence number of a header parameter, or the occurrence number of the header parameter matching name, if name is specified. Optional argument if name is specified, otherwise it is required. |
Usage notes
- $Web_Hdr_Parm_Lstr works much like $WEB_HDR_PARM, except for the following:
- It can return more than 255 bytes of data into a longstring.
- It causes request cancellation if the result would be truncated, either on assignment to a target STRING %variable, or as input to a STRING $function argument or subroutine parameter.
- It does not have position and length arguments (arguments 3 and 4).
Examples
This example places the value of two header parameters into a User Language Longstring variable of the same name.
%accept = $Web_Hdr_Parm_Lstr('ACCEPT') %referer = $Web_Hdr_Parm_Lstr('REFERER')