HLPCMDKEY (Help Command Key) Keyword for Display Files

Use this record-level keyword to return control to your application program after a command attention (CA) or command function (CF) key is pressed on an application help record format. This keyword is specified on the application help record format. For control to return, the command key must be specified on both the application record format and the application help record format.

This keyword has no parameters.

A CA or CF key must be specified either at the file level or on the help record containing the HLPCMDKEY keyword. If no CAnn or CFnn keys are specified at the file level or on the help record, a warning message (severity 10) is issued. If all the CAnn and CFnn keys specified at the file level and on the same help record as the HLPCMDKEY keyword have option indicators, a warning message (severity 10) is issued. When a response indicator is specified on a CA or CF key on the application help record format, a warning message (severity 10) is issued and the response indicator will be ignored.

If you specify this keyword on the help record and the display station user presses one of the command keys that is specified on both the application record and the application help record, the following happens:

The command key must be specified on both the application record format and the application help record format. If the command key is specified only on the application record format, the command key will not be allowed when the application help record format is displayed. If the command key is specified only on the application help record format, the command key will function as the Enter key and control will not return to the application program.

You cannot specify HLPCMDKEY on subfile (SFL keyword), subfile control (SFLCTL keyword), or user-defined (USRDFN keyword) record formats.

You cannot specify the HLPCMDKEY keyword in a file containing the USRDSPMGT keyword.

Option indicators are not valid for this keyword.