$Web Form Parm Line: Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (1 revision)
 
(8 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{DISPLAYTITLE:$Web_Form_Parm_Line}}
{{DISPLAYTITLE:$Web_Form_Parm_Line}}
<span class="pageSubtitle"><section begin="desc" />Value of line in form field<section end="desc" /></span>
<span class="pageSubtitle">Value of line in form field</span>


<var>$Web_Form_Parm_Line</var> retrieves the value of a specific line in a form field. It is especially useful for ''textarea'' input fields. <var>$Web_Form_Line</var> is a short synonym for <var>$Web_Form_Parm_Line</var>.


<var>$Web_Form_Parm_Line</var> takes three arguments and returns a string, or null for any error condition.


$Web_Form_Parm_Line retrieves the value of a specific line in a form field. It is especially useful for ''textarea'' input fields. <var>$Web_Form_Line</var> is a short synonym for $Web_Form_Parm_Line.
==Syntax==
==Syntax==
<p class="syntax"><section begin="syntax" /> %STRING = $WEB_FORM_[PARM_]LINE( fieldname, occurrence, -
<p class="syntax"><span class="term">%string</span> = $Web_Form_[Parm_]Line( <span class="term">fieldname, occurrence, line_num</span> )
line_num )
</p>
<section end="syntax" /></p>


 
===Syntax terms===
$Web_Form_Parm_Line takes three arguments and returns a string, or null for any error condition.
<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 occurrence 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 'fieldname', if fieldname is specified. Optional argument if fieldname is specified, otherwise it is required.</td></tr>
<td>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.</td></tr>
<tr><th>line_num</th>
<tr><th>line_num</th>
<td>Line number in the form field for which data is to be returned. This is an optional argument and defaults to 1.
<td>Line number in the form field for which data is to be returned. This is an optional argument and defaults to 1.
</td></tr></table>
</td></tr></table>


==Usage notes==
<ul>
<li>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.
</ul>


 
==Example==
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.
 
This example places each line of a textarea form field into an occurrence of a multiply occurring field.
This example places each line of a textarea form field into an occurrence of a multiply occurring field.
<p class="code">  
<p class="code">FOR 1 RECORD IN ORDER_RECORD
FOR 1 RECORD IN ORDER_RECORD
  FOR %I FROM 1 TO $Web_Form_Parm_Num_Line'COMMENTS')
FOR %I FROM 1 TO $Web_Form_Parm_Num_Line( -
      %COMMENT = $Web_Form_Parm_Line('COMMENTS', , %I)  
'COMMENTS')
      ADD COMMENT = %COMMENT
%COMMENT = $Web_Form_Parm_Line( -
  END FOR
'COMMENTS', , %I)
END FOR
ADD COMMENT = %COMMENT
END FOR
END FOR
</p>
</p>


 
==See also==
See also:
<ul>
<ul>
 
<li><var>[[$Web_Form_Parm_Len]]</var>
<li>[[$Web_Form_Parm_Len]]  
<li><var>[[$Web_Form_Name]]</var>
<li>[[$Web_Form_Name]]  
<li><var>[[$Web_Num_Form]]</var>
<li>[[$Web_Num_Form]]  
<li><var>[[$Web_Form_Parm_Num_Line]]</var>
<li>[[$Web_Form_Parm_Num_Line]]
</ul>
</ul>


[[Category:Janus Web Server $functions|$Web_Form_Parm_Line]]
[[Category:Janus Web Server $functions|$Web_Form_Parm_Line]]

Latest revision as of 22:33, 5 June 2013

Value of line in form field

$Web_Form_Parm_Line retrieves the value of a specific line in a form field. It is especially useful for textarea input fields. $Web_Form_Line is a short synonym for $Web_Form_Parm_Line.

$Web_Form_Parm_Line takes three arguments and returns a string, or null for any error condition.

Syntax

%string = $Web_Form_[Parm_]Line( fieldname, occurrence, line_num )

Syntax terms

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.
line_num Line number in the form field for which data is to be returned. This is an optional argument and defaults to 1.

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.

Example

This example places each line of a textarea form field into an occurrence of a multiply occurring field.

FOR 1 RECORD IN ORDER_RECORD FOR %I FROM 1 TO $Web_Form_Parm_Num_Line'COMMENTS') %COMMENT = $Web_Form_Parm_Line('COMMENTS', , %I) ADD COMMENT = %COMMENT END FOR END FOR

See also

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