$Web Cookie Parm: Difference between revisions

Latest revision as of 17:20, 16 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.

%string = $Web_Cookie_Parm( name, occurrence, [start]], [len] )

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.

$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, %FOO would be set to PUB:
%rc = $Web_Set_Cookie( 'FOO', 'BAR') %FOO = $Web_Cookie_Parm( 'FOO' )

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

@@ Line 1: / Line 1: @@
 {{DISPLAYTITLE:$Web_Cookie_Parm}}
-<span class="pageSubtitle"><section begin="desc" />Value of cookie<section end="desc" /></span>
+<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>.
 ==Syntax==
-<p class="syntax"><section begin="syntax" />%string = $Web_Cookie_Parm( name, occurrence, [start], [len] )
+<p class="syntax"><span class="term">%string</span> = <span class="literal">$Web_Cookie_Parm</span>( <span class="term">name</span>, <span class="term">occurrence</span>, [<span class="term">start</span>]], [<span class="term">len</span>] )
-<section end="syntax" /></p>
+</p>
 ===Syntax terms===
@@ Line 25: / Line 25: @@
 <ul>
 <li><var>$Web_Cookie_Parm</var> returns the value of a cookie '''sent by the browser''' and is not affected by <var>$Web_Set_Cookie</var> calls before the <var>$Web_Cookie_Parm</var> call.
-For example, if a browser sent a cookie called "FOO" with a value of "PUB", in the following code:
+For example, if a browser sent a cookie called <code>FOO</code> with a value of <code>PUB</code>, in the following code, <code>%FOO</code> would be set to <code>PUB</code>:
 <p class="code">%rc = $Web_Set_Cookie( 'FOO', 'BAR')
 %FOO = $Web_Cookie_Parm( 'FOO' )
 </p>
-<code>%FOO</code> would be set to <code>PUB</code>.
 </ul>