GETFKEY

GETFKEY

Returns the command that is assigned to a function key

Category: Keys

Syntax
Details
Examples
	Example 1: Using GETFKEY When the Function Key Name Is Unknown
	Example 2: Using GETFKEY When the Function Key Name Is Known
See Also

Syntax

key-command=GETFKEY(key-name);

key-command

returns the command that is currently assigned to the function key.

Type: Character

key-name

specifies the name of the function key as listed in the KEYS window. Function key names vary according to the device. Use FKEYNAME to retrieve the name of a function key.

Type: Character

Details

GETFKEY returns the command that is assigned to a function key for the current window. This is the same as the text displayed for the key in the KEYS window.

You can use this function only in entries that have a DISPLAY window.

Examples

Example 1: Using GETFKEY When the Function Key Name Is Unknown

Return the command assigned to the first function key if the name of the function key is not known:

command=getfkey(fkeyname(1));

Example 2: Using GETFKEY When the Function Key Name Is Known

If the value of the first function key is F1, return the command that is assigned to the first function key:

command=getfkey('F1');

See Also

FKEYNAME

NUMFKEYS

SETFKEY

Chapter Contents
Previous
Next
Top of Page