Mlarocca: Mlarocca moved page $ENTER to $Enter: Lower case change

2014-07-17T13:36:59Z

Mlarocca moved page $ENTER to $Enter: Lower case change

← Older revision	Revision as of 13:36, 17 July 2014
(No difference)

Alex: Automatically generated page update

2013-04-20T13:18:59Z

Automatically generated page update

New page

The $ENTER function provides efficient terminal dialogue with users of data entry applications. 
Syntax
The format of the $ENTER function is: 
$ENTER (number of values, prompt string,
default value, separator, name prefix)

$ENTER prompts the terminal operator with the value entered in the prompt string argument. If this argument is omitted, this prompt appears:
ENTER DATA

The operator enters a single line of input which is read by <var class="product">Model 204</var>. This line is parsed into individual values using the value of the separator argument as the delimiter.
<ul>
<li>The separator argument must be a single character. If it is omitted, a comma is used as the default separator. If an input value is longer than 255 characters, a warning message is issued and the value is truncated. The input values are assigned in the order of %variables using the value of the name prefix argument as follows:</li>
%name prefix 01, %name prefix 02, %name prefix 03,...
</li>
<li>If the name prefix argument is omitted, the %variables are named %01, %02, %03, and so on. All %variable names generated by $ENTER must appear elsewhere in the request so that the variables can be allocated during compilation.</li>
</li>
<li>The number of values argument is required; it indicates the number of values assigned by $ENTER. If any values are omitted, the value specified in the default value argument is assigned to the appropriate %variables. If the default value argument is omitted, a single blank character is the default.</li>
</li>
</ul>
If $ENTER completes successfully, it returns a value of 0. If it fails for any of these reasons, $ENTER returns a value of 1 and prints an explanatory message:
<ul>
<li>Too many values are included on the input line.</li>
</li>
<li>The number of values argument is less than 1 or greater than 99.</li>
</li>
<li>Required %variables were not allocated during compilation (a %variable used in $ENTER does not appear elsewhere in the request). </li>
</li>
</ul>
Example 1
Suppose a request contains the following function call:
%X = $ENTER(3, 'ENTER 3 VALUES', '99999' ,, 'ZZ')

The following prompt is displayed at the terminal:
ENTER 3 VALUES

The user enters:
A1,,C3

$ENTER returns a value of 0. This result is equivalent to the following:
%ZZ01 = 'A1'
%ZZ02 = '99999'
%ZZ03 = 'C3'

Example 2
%Y = $ENTER (4,,,'/',)

This default prompt is displayed:
ENTER DATA

The user enters:
ONE/TWO/THREE/FOUR

$ENTER returns a value of 0, which is equivalent to:
%01 = 'ONE'
%02 = 'TWO'
%03 = 'THREE'
%04 = 'FOUR'

[[Category:SOUL $functions]]

$Enter - Revision history

Mlarocca: Mlarocca moved page $ENTER to $Enter: Lower case change

Alex: Automatically generated page update