$Web_IsIndex_Parm_Lstr

Value of URL parameter to longstring

$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

%string = $Web_IsIndex_Parm_Lstr( name, occurrence )

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

• $Web_IsIndex_Parm
• $Web_IsIndex_Name
• $Web_IsIndex_Parm_Line