$Web_Form_Parm_Line

From m204wiki
Jump to: navigation, search

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