You are here:

HELP clause

HELP clause is an optional clause that specifies the number of the help message that is associated with the CONSTRUCT statement.

Integer Expression

A 4GL expression that returns a positive integer greater than 0 and less than 32,767

The message may contain the instructions for the user on how to make a query. The message defined in this clause appears in the help message window when the user presses the Help key from any of the fields in the field list. The Help key may be defined in the OPTIONS statement in the body of the program, by default CONTROL-W is the help key.

The integer expression identifies the message within the help file. The help file which contains the help message must be specified in the HELP FILE clause of the OPTIONS statement that precedes the CONSTRUCT statement. If 4GL cannot open the specified help file, if the indicated number is greater than 32,767, or if the number is absent from the help file an error message will appear. The qmsg command can be used in the command line environment to create a compiled version of the help file.

A non-compiled help file is a message file with the extension .msg (help_file.msg). Only a compiled message file can be referenced as a help file. Pay attention that a compiled help file has another extention, e.g. .erm (help_file.erm).

To provide a specific help message for a specific field, use the OK KEY clause of the CONSTRUCT input control block with the infield() operator and showhelp() function. If the help is provided for the specified fields, the help messages should be displayed in a 4GL window within the 4GL screen and not in a separate help window.