FKeyI_H Function (ROM Call 0x592)

AMS 2.02 or higher menus.h

short FKeyI_H (HANDLE ExecHandle, short Key);

Returns the corresponding menu item for a function key.

FKeyI_H returns the corresponding index to the function key given in Key of the menu associated with the ExecHandle handle, or returns M_NOTMENUKEY for function keys not used in the given menu. The ExecHandle handle should have been returned from MenuBegin.

Key should be a function key (i.e. KEY_Fx) given in the enum CommonKeys. KEY_F1 will return 0 for the first top-level entry if it exists, KEY_F2 will return 1 for the second top-level entry if it exists, and so on.

FKeyI_H can be useful in combination with MenuKey.


Uses: HeapDeref
Used by: MenuKey, cmd_toolbar, ROM Call 0x421


See also: MenuBegin, MenuKey