$Web Hdr Parm Lstr: Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (1 revision)
(Automatically generated page update)
 
(14 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{DISPLAYTITLE:$Web_Hdr_Parm_Lstr}}
{{DISPLAYTITLE:$Web_Hdr_Parm_Lstr}}
<span class="pageSubtitle"><section begin="desc" />Value of header parameter to longstring<section end="desc" /></span>
<span class="pageSubtitle">Value of header parameter to longstring</span>
 
<var>$Web_Hdr_Parm_Lstr</var> retrieves the value of an HTTP header parameter as a [[Longstrings|longstring]].
 
<var>$Web_Hdr_Parm_Lstr</var> takes two arguments, and it returns a longstring (or null for any error condition).


$Web_Hdr_Parm_Lstr retrieves the value of an HTTP header parameter as a longstring.
==Syntax==
==Syntax==
<p class="syntax"><section begin="syntax" /> %STRING = $Web_Hdr_Parm_Lstr( name, occurrence )
<p class="syntax"><span class="term">%string</span> = <span class="literal">$Web_Hdr_Parm_Lstr</span>( <span class="term">name</span>, <span class="term">occurrence</span> )
<section end="syntax" /></p>
</p>
 


$Web_Hdr_Parm_Lstr takes two arguments, and it returns a longstring (or null for any error condition).
===Syntax terms===
<table class="syntaxTable">
<table class="syntaxTable">
<tr><th>name</th>
<tr><th>name</th>
<td>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.</td></tr>
<td>The name of the header parameter, returned by <var>$Web_Hdr_Name</var>. This is a required argument if ''occurrence'' is not specified; otherwise it is optional.</td></tr>
<tr><th>occurrence</th>
<tr><th>occurrence</th>
<td>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.
<td>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.
</td></tr></table>
</td></tr></table>


 
==Usage notes==
 
<ul>
This example places the value of two header parameters into a User Language Longstring variable of the same name.
<li><var>$Web_Hdr_Parm_Lstr</var> works much like <var>$Web_Hdr_Parm</var>, except for the following:
<p class="code"> %accept = $Web_Hdr_Parm_Lstr('ACCEPT')
%referer = $Web_Hdr_Parm_Lstr('REFERER')
</p>
 
 
$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 <var class="product">User Language</var> Longstring variable of the same name.
<p class="code">%accept = $Web_Hdr_Parm_Lstr('ACCEPT')
%referer = $Web_Hdr_Parm_Lstr('REFERER')
</p>


$Web_Hdr_Parm_Lstr is only available in ''[[Sirius Mods]]'' Version 6.7 and later.
==See also==
 
For more information about longstrings, see the ''Sirius Functions Reference Manual''.
 
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>  

Latest revision as of 02:03, 16 April 2013

Value of header parameter to longstring

$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

%string = $Web_Hdr_Parm_Lstr( name, occurrence )

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

Retrieved from "https://m204wiki.rocketsoftware.com/index.php?title=$Web_Hdr_Parm_Lstr&oldid=56000"