$Web Cookie Parm: Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
(Automatically generated page update) |
||
| Line 1: | Line 1: | ||
{{DISPLAYTITLE:$Web_Cookie_Parm}} | {{DISPLAYTITLE:$Web_Cookie_Parm}} | ||
<span class="pageSubtitle" | <span class="pageSubtitle">Value of cookie</span> | ||
<var>$Web_Cookie_Parm</var> takes four arguments and returns a string, or null for any error condition. <var>[[$Web_Get_Cookie]]</var> is a synonym for <var>$Web_Cookie_Parm</var>. | <var>$Web_Cookie_Parm</var> takes four arguments and returns a string, or null for any error condition. <var>[[$Web_Get_Cookie]]</var> is a synonym for <var>$Web_Cookie_Parm</var>. | ||
==Syntax== | ==Syntax== | ||
<p class="syntax" | <p class="syntax">%string = $Web_Cookie_Parm( name, occurrence, [start], [len] ) | ||
</p> | |||
===Syntax terms=== | ===Syntax terms=== | ||
Revision as of 13:52, 9 April 2013
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 of "PUB", in the following code:
%rc = $Web_Set_Cookie( 'FOO', 'BAR') %FOO = $Web_Cookie_Parm( 'FOO' )
%FOOwould be set toPUB.
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' )