$Web_Cookie_Parm
Value of cookie
$Web_Cookie_Parm takes four arguments and returns a string, or null for any error condition. $Web_Get_Cookie is a synonym for $Web_Cookie_Parm.
Syntax
%string = $Web_Cookie_Parm( name, occurrence, [start], [len] )
Syntax terms
name | The name of the cookie, returned by $Web_Cookie_Name. A required argument if occurrence is not specified, otherwise it is optional. |
---|---|
occurrence | The occurrence number of a cookie, or the occurrence number of the cookie matching name, if name is specified. An optional argument if name is specified, otherwise it is required. |
start | Starting position within the name. This is an optional argument that defaults to 1. |
len | Length to return. This is an optional argument, provided in case a cookie exceeds 255 bytes. The length of a cookie can be determined with $Web_Cookie_Len. The default is the length of the cookie. |
Usage notes
- $Web_Cookie_Parm returns the value of a cookie sent by the browser and is not affected by $Web_Set_Cookie calls before the $Web_Cookie_Parm call.
For example, if a browser sent a cookie called
FOO
with a value ofPUB
, in the following code,%FOO
would be set toPUB
:%rc = $Web_Set_Cookie( 'FOO', 'BAR') %FOO = $Web_Cookie_Parm( 'FOO' )
Examples
This example places the value of each cookie into a User Language %variable of the same name.
%ARTIST = $Web_Cookie_Parm( 'ARTIST' ) %GENRE = $Web_Cookie_Parm( 'GENRE' )