.getkey Method

Function:

When kp.genkpevent = 0 — NO, calling this method attempts to fetch one keypad event from the keypad event FIFO.  

Syntax:

kp.getkey(byref key_event as pl_kp_event_codes, byref key_code as byte) as ok_ng

Returns:

0 — OK: there was a keypad event, and it has been returned through the key_event and key_code byref arguments.

1 — NG: there was no keypad event waiting in the FIFO.

See Also:

Receiving Keypad Events Using the kp.getkey Method


Part

Description

key_event

This is a byref argument, through which the kp.getkey method returns the state transition portion of the keypad event extracted from the keypad event FIFO. This argument will only contain a valid value if the method returns 0 — OK.

key_code

This is a byref argument, through which the kp.getkey method returns the key code portion of the keypad event extracted from the keypad event FIFO. This argument will only contain a valid value if the method returns 0 — OK.