$Web IsIndex Parm Lstr: Difference between revisions

From m204wiki
Jump to navigation Jump to search
mNo edit summary
mNo edit summary
Line 2: Line 2:
<span class="pageSubtitle"><section begin="desc" />Value of URL parameter to longstring<section end="desc" /></span>
<span class="pageSubtitle"><section begin="desc" />Value of URL parameter to longstring<section end="desc" /></span>


$Web_IsIndex_Parm_Lstr retrieves the value of a URL parameter as a [[Longstrings|longstring]].  
<var>$Web_IsIndex_Parm_Lstr</var> retrieves the value of a URL parameter as a [[Longstrings|longstring]].  


Since isindex fields are more commonly called "URL parameters," you may want to use the synonym for this $function, <var>[[$Web_URL_Parm_Lstr]]</var>.
Since isindex fields are more commonly called "URL parameters," you may want to use the synonym for this $function, <var>[[$Web_URL_Parm_Lstr]]</var>.


$Web_IsIndex_Parm_Lstr takes two arguments and returns a longstring (or null for any error condition).
<var>$Web_IsIndex_Parm_Lstr</var> takes two arguments and returns a longstring (or null for any error condition).


==Syntax==
==Syntax==
Line 23: Line 23:
==Usage notes==
==Usage notes==
<ul>
<ul>
<li>$Web_IsIndex_Parm_Lstr works much like $Web_IsIndex_Parm, except for the following:
<li><var>$Web_IsIndex_Parm_Lstr</var> works much like $Web_IsIndex_Parm, except for the following:
<ul>
<ul>



Revision as of 15:38, 15 June 2012

<section begin="desc" />Value of URL parameter to longstring<section end="desc" />

$Web_IsIndex_Parm_Lstr retrieves the value of a URL parameter as a longstring.

Since isindex fields are more commonly called "URL parameters," you may want to use the synonym for this $function, $Web_URL_Parm_Lstr.

$Web_IsIndex_Parm_Lstr takes two arguments and returns a longstring (or null for any error condition).

Syntax

<section begin="syntax" />%string = $Web_IsIndex_Parm_Lstr( name, occurrence ) <section end="syntax" />

Syntax terms

name The name of the URL parameter, returned by $Web_IsIndex_Name. This is a required argument if occurrence is not specified; otherwise it is optional.
occurrence The occurrence number of a URL parameter, or the occurrence number of the URL parameter matching name, if name is specified. This is an optional argument if name is specified; otherwise it is required.


Usage notes

  • $Web_IsIndex_Parm_Lstr works much like $Web_IsIndex_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 the 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

If you have a URL that looks like:

http://myhost.edu/whatever?war=peace&love=hate

The following will retrieve the values of the War andLove fields into longstrings called %war and%love.

%war = $web_form_parm_lstr('WAR') %love = $web_form_parm_lstr('LOVE')


See also