$Web Form Parm Num Line: Difference between revisions
mNo edit summary |
m (→Syntax) |
||
| (6 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
{{DISPLAYTITLE:$Web_Form_Parm_Num_Line}} | {{DISPLAYTITLE:$Web_Form_Parm_Num_Line}} | ||
<span class="pageSubtitle" | <span class="pageSubtitle">Number of form field lines</span> | ||
<var>$Web_Form_Parm_Num_Line</var> retrieves the number of lines in a form field. It is especially useful for ''textarea'' input fields. <var>$Web_Form_Parm_Num_Line</var> is a short synonym for <var>$Web_Form_Parm_Num_Line</var>. | <var>$Web_Form_Parm_Num_Line</var> retrieves the number of lines in a form field. It is especially useful for ''textarea'' input fields. <var>$Web_Form_Parm_Num_Line</var> is a short synonym for <var>$Web_Form_Parm_Num_Line</var>. | ||
| Line 7: | Line 7: | ||
==Syntax== | ==Syntax== | ||
<p class="syntax">< | <p class="syntax"><span class="term">%string</span> = $Web_Form_[Parm_]Num_Line( <span class="term">fieldname, occurrence</span> ) | ||
< | </p> | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>fieldname</th> | <tr><th>fieldname</th> | ||
<td>The name of the form field, returned by $Web_Form_Name. Required argument if occurrence not specified, otherwise optional.</td></tr> | <td>The name of the form field, returned by <var>$Web_Form_Name</var>. Required argument if <var class="term">occurrence</var> not specified, otherwise optional.</td></tr> | ||
<tr><th>occurrence</th> | <tr><th>occurrence</th> | ||
<td>The occurrence number of a form field, or the occurrence number of the form field matching | <td>The occurrence number of a form field, or the occurrence number of the form field matching <var class="term">fieldname</var>, if <var class="term">fieldname</var> is specified. Optional argument if <var class="term">fieldname</var> is specified, otherwise it is required. | ||
</td></tr></table> | </td></tr></table> | ||
Latest revision as of 22:36, 5 June 2013
Number of form field lines
$Web_Form_Parm_Num_Line retrieves the number of lines in a form field. It is especially useful for textarea input fields. $Web_Form_Parm_Num_Line is a short synonym for $Web_Form_Parm_Num_Line.
$Web_Form_Parm_Num_Line takes two arguments and returns either the number of lines in the form field or a 0 indicating either that there were no lines in the form field or that some other error has occurred. Possible errors would be the form field not being found or the function being invoked on a non-web server thread.
Syntax
%string = $Web_Form_[Parm_]Num_Line( fieldname, occurrence )
| fieldname | The name of the form field, returned by $Web_Form_Name. Required argument if occurrence not specified, otherwise optional. |
|---|---|
| occurrence | The occurrence number of a form field, or the occurrence number of the form field matching fieldname, if fieldname is specified. Optional argument if fieldname is specified, otherwise it is required. |
Usage notes
- A line is considered to be a block of text that is terminated by either an ASCII carriage return (X'0D') or a carriage return followed by a line feed (X'0A'). This is what is ordinarily sent by a browser to mark the end of each line of a textarea input field.
Examples
This example checks if the number of lines returned in a textarea exceeds the size of the array meant to hold the input from the textarea.
%LINES = $Web_Form_Parm_Num_Line('COMMENTS') IF %LINES GT %MAXLINES THEN AUDIT 'Maximum lines exceeded for ' WITH - $Web_Hdr_Parm('URL') WITH - ' - input will be truncated' %LINES = %MAXLINES END IF