*F1HELP (GETMODE)

PLBCMP GUI Only

*F1HELP={value}

The *F1HELP control reports the use of the F1 key.

If set to ON, the F1 key is the Windows help key. If the F1 key is pressed and there exists a HELPID for the current object that has the focus, the help file is accessed using the HELPID of the current object. The HELPID relates to index values in the program help file. If there is no HELPID for the object with the focus, nothing happens. The F1 key cannot be used in the program.

The help file is associated to the program using the *HELPLIB control or by naming the help file the same name as the program with a file extension of HLP. On a Windows Vista system, the default to extension is CHM.

If set to OFF, the F1 key is treated as any other function key in the program. This is the default mode.

{value} is a previously defined Numeric Variable that contains the F1HELP mode.

The {value} returned is one of the following:

See Also: List Controls (GETMODE), GETMODE