$Web_Form_Parm_Lstr
<section begin="desc" />Value of form field to longstring<section end="desc" />
$Web_Form_Parm_Lstr retrieves the value of an HTML form field as a longstring.
Syntax
<section begin="syntax" /> %STRING = $Web_Form_Parm_Lstr( name, occurrence ) <section end="syntax" />
$Web_Form_Parm_Lstr takes two arguments and returns a longstring or null for any error condition.
| name | The name of the form field, returned by $Web_Form_Name. Required argument if occurrence is not specified, otherwise optional. |
|---|---|
| occurrence | The occurrence number of a form field, or the occurrence number of the form field matching name, if name is specified. This is an optional argument if name is specified; otherwise it is required. |
If you have an HTML form defined as follows:
<form method="POST" action="myUrl">
Foo:<input type="text" name="foo" size="20">
Bar:<input type="text" name="bar" size="20">
</form>
The following will retrieve the values of the Foo andBar fields into longstrings called %foo and%bar.
%foo = $web_form_parm_lstr('FOO') %bar = $web_form_parm_lstr('BAR')
$Web_Form_Parm_Lstr works much like $WEB_FORM_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).
$Web_Form_Parm_Lstr is only available in Sirius Mods Version 6.7 and later. For more information about longstrings see the Sirius Functions Reference Manual.
See also: