With this session parameter, you assign a helproutine or a help map to a field.
|Possible settings||See HE Parameter Syntax below.|
|Specification within session||yes|
Helproutines can be created with the Natural program editor, help maps with the Natural map editor.
The helproutine or help map may then be invoked during processing of an
INPUT statement or a
map by choosing either of the following methods:
In the field for which to invoke the help request, enter the help character in the leftmost position of the field and press ENTER. The default help character is a question mark (?).
If you enter the help character at a different position of the field or if you enter more than one character, the string is taken as user input and no help is invoked. If the field contains hexadecimal zeroes, it depends on the terminal emulation whether Natural can interpret the values as a help request.
Place the cursor in the field for which to invoke the help request and
press the PF key defined as help function key with the
SET KEY statement.
The following topics are covered below:
The syntax of this parameter is:
Operand Definition Table:
|Operand||Possible Structure||Possible Formats||Referencing Permitted||Dynamic Definition|
Syntax Element Description:
For additional information on using
|| You may specify 1 to 20 parameters
For additional information on using operand2 within a map, see the HE helproutine option described in Extended Field Editing in Map Editor in the Editors documentation.
|| The equals sign (
If the equals sign is used as a parameter, the corresponding parameter in the helproutine or help map must be specified with format/length A65.
ID) or by a comma. However, a comma must not be used for this purpose if the comma is defined as decimal character (with the session parameter
DEFINE DATA PARAMETERstatement which defines fields that correspond with the parameters in format and length.
DEFINE DATA PARAMETERstatement which corresponds in format and length with the original field. In the block of fields defined within the
DEFINE DATA PARAMETERstatement, this field must always be defined behind the parameters, if present.
DEFINE DATA PARAMETERstatement. You may specify up to three index parameters according to array dimensions.
If a helproutine or help map is requested - by entering a question mark
(?) in the field, or by pressing the help key (as defined with a
KEY statement), or via a
statement - all other data that may have been entered into fields are not
assigned to the program variables until all help requests have been
Only one help request per
INPUT statement is possible; that
is, if help is requested for more than one field (for example, by entering
question marks in multiple fields), only the first help request will be
/* MAIN PROGRAM DEFINE DATA 1 #A(A20/1:3) END-DEFINE ... SET KEY PF1=HELP ... INPUT #A (2) (HE='HELPA',=) ... END
/* HELP-ROUTINE 'HELPA' DEFINE DATA PARAMETER 1 #VARNAME (A65) 1 #PARM1 (A20) 1 #VARINDEX (I2) END-DEFINE ...
* Program 'PROGRAM1' * DEFINE DATA LOCAL 1 #PARM1 (A65) INIT <'valueparm1'> END-DEFINE SET KEY PF1 = HELP FORMAT KD=ON * INPUT (AD=M HE='HELP1',=) 'Enter ? for name of executed object:' / #PARM1 * INPUT (AD=M) 'Enter ? for field name:' / #PARM1 (HE='HELP1',=) * END
Parameter Data Area in Example Helproutine
* Helproutine 'HELP1' * DEFINE DATA PARAMETER 1 #FLD1 (A65) END-DEFINE ...