$Web Hdr Parm Lstr

<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')

See also

• $Web_Hdr_Parm
• $Web_Hdr_Name
• $Web_Hdr_Len