_ninput.utl Utility - Standard Input

Parameter

Description

input_template$,

Templated string that controls how the input operation looks and works. _lkeymap.utl must first be called to create the template. For a list of the fields, see Input Template below.

data_value$

Default input value to be passed to the application program.

control_value

Control key value, according to the table under Key Maps.

Using 0 causes dialog messages to be displayed in a window. Otherwise, it uses the last line of the current window.

alternate_input_program$

Name of a developer-supplied program to control data input when this utility does not provide the control desired. The alternate program must have a parameter list identical to that of _ninput.utl, except for the alternate_input value.

Field

Description

COL:N(1*)

Place input window at this column.

ROW:N(1*)

Place input window at this row.

COLS:N(1*)

Number of columns for the input window.

ROWS:N(1*)

Reserved for future use.

LENGTH:N(1*)

Maximum length of this input field. If LENGTH<0, then use PRO/5 READ RECORD logic to get one character at a time.

TYPE:N(1*)

Reserved for future use.

PROMPT:C(1*)

Help prompt to display on the last line of the window.

HELPFILE:C(1*)

Names the file that contains help information. (Refer to the discussion on HELP processing.)

HELPITEM:C(1*)

Names the help item within a searchable ASCII Help file to display if the user presses <HELP>.

COLPOS:N(1*)

Initial column position within the field. Either 0 or 1 will start at the first column.

ROWPOS:N(1*)

Reserved for future use.

PAD:C(1*)

Pad character. See INPUTE in the Commands Manual.

DMASK:C(1*)

Display mask. If specified, this will be displayed in background mode as the user is typing.

IMASK:C(1*)

Input mask.

OMASK:C(1*)

Output mask.

Field

Description

IATTR:C(1*)

Input attributes (during data entry).

OATTR:C(1*)

Output attributes (during display).

ICOLOR:C(1*)

Input color (used to override IATTR$ color-RGB value).

OCOLOR:C(1*)

Output color (used to override OATTR$ color-RGB value).

ARG:C(1*)

Argument String used to modify program behavior.

TIMEOUT:N(1*)

Timeout in integer seconds, 1 to 255, or 0 for no timeout.

SEARCH:N(1*)

Reserved for future use.