Previous Topic: Action=DISPLAY Class=DATA

Next Topic: Action=DISPLAY Class=LIST


Action=DISPLAY Class=HELP

This statement displays online help. You determine the application, the function, the field, and the window on which the user requires help, and supply the values to the DISPLAY HELP function to display the appropriate help. If the required help has not been added, the function displays the next more general help in the order field-level help, window-level help, function-level help, and application-level help.

This statement has the following format:

&CONTROL NOSHRVARS
-EXEC $CACALL   OPT=ACTION
                ACTION=DISPLAY
                CLASS=HELP
                NAME=‘APPL=application id
                       [FUNC=function name]
                       [FIELD=field name]
                [PARMS=‘CROW=cursor row
                        CCOL=cursor column’
                        MODE={VIEW | BROWSE}]
APPL=application id

A required parameter giving the identifier of the application for which help is to be displayed.

FUNC=function name

An optional parameter (required if either the FIELD=, CROW= or CCOL= keywords are specified) giving the name of the function for which help is to be displayed.

FIELD=field name

An optional parameter giving the name of the field for which help is to be displayed.

CROW=cursor row

An optional parameter giving the cursor row position when help was requested. This defaults to the value of &CURSROW.

CCOL=cursor column

An optional parameter giving the cursor column position when help was requested. This defaults to the value of &CURSCOL.

Input Variables

This statement has no input variables.

Return Variables

This statement contains the following return variables:

&SYSMSG

System message. Contains the error message (for return code 8).

Feedback Codes

If a return code of 8 is set, then additional information is available as one of the following feedback codes, set in &$CAFDBK:

8

Processing error

10

Nesting level exceeded

Example

The following statements display the field-level help for the ZPRSTATUS field for the UPDATE function in the application identified by the identifier ZPR if the help is available; otherwise, the next more general help is displayed:

&CONTROL NOSHRVARS
-EXEC $CACALL   OPT=ACTION +
                ACTION=DISPLAY +
                CLASS=HELP +
                NAME=‘APPL=ZPR +
                      FUNC=UPDATE +
                      FIELD=ZPRSTATUS’