sys.set_fkhelp()

Purpose:

sys.set_fkhelp() allows you to modify the 4C environment variable XLFKHELPMSG.

Usage:

ret = sys.set_fkhelp(<fkhelp>);

Arguments:

alpha <fkhelp> - This can be "ON", "OFF", or "STATUS" Any other value is ignored and causes an error return.

Returns:

integer <ret>

0 - OK - XLFKHELPMSG set.

-1 - <fkhelp> Illegal Val.

Where Used:

sys.set_fkhelp() can be called from anywhere. It is most likely used in system programs that allow the user to change their environment.

Example:

In the system program sys.help.set, the EndFld PCL for ok calls sethelp() which in turn calls sys.set_fkhelp() to set the user specified value for XLFKHELPMSG. The entire sethelp() PCL follows:

sys.set_help(helpmsg);
sys.set_fkhelp(fkhelp);
sys.set_msgline1(msgl1);
sys.set_msgline2(msgl2);
sys.set_return(retsel);

Description:

sys.set_fkhelp() sets the value of the 4C environment variable XLFKHELPMSG. This env variable is used to control how function key help messages display automatically. If XLFKHELPMSG is set to "ON", then 4C will display as much function key help messages as will fit on XLMSGLINE2. If set to "OFF", then 4C does not display any function key help messages without the user explicitly requesting it. If set to "STATUS", then 4C will display an appropriate message indicating how to get the function key help. This message will display for any input field that has any function keys enabled.

Bugs/Features/Comments:

The values stored in the 4C Environment variables may be different than those at the shell. Calls to sys.set_help() etc do not modify the shell's environment, only 4C's internal copy. Even shells started from 4C will not share the same environment if the 4C environment has changed during running.

Of Course this is subject to change.

See Also: sys.get_fkhelp() sys.get_help() sys.get_msgline1() sys.get_msgline2() sys.get_return() sys.set_help() sys.set_msgline1() sys.set_msgline2() sys.set_return()