GetKeyState

The GetKeyState function returns the state of a Windows virtual key. Use this function to poll the status of keyboard keys or mouse keys.

Syntax

nState = GetKeyState( Code )

• Code is the numeric code for the target key. See Remarks, below.
• nState is the returned state of the key, either up, down, or toggled.
• On success, the key state nState is returned.

• On failure because Code was not specified, 0 is returned.

Remarks

This function returns the state of a Windows virtual key. The returned value is described in the following table. The states Up and Down refer to the state of "normal", non-toggle keys. A toggle key is one that locks down, such as [Caps Lock] or [Num Lock].

Key State Return Values

The virtual key may be an ASCII key code or a Window virtual key code. An ASCII key code is a number in the range 48 (or 0x30) through 96 (0x5a). For example, to test the letter A, specify Code = 65. These numbers may be found in an ASCII code table. Virtual key codes for non-printable keys like [F1] or [Ctrl] fall outside the range of "normal" characters to use up the number range 0 through 255.

The supported virtual key codes are listed in the table below. The number in the Code column is what you specify as the argument to the GetKeyState function. Consult Windows documentation for further details on virtual keys.

Supported Windows Virtual Keys

Example

The following script fragment returns the key status when the user is holding down the left [Shift] key:

Related Topics