GetKeyState

Description

This function retrieves the status of the specified virtual key. The status specifies whether the key is up, down, or toggled (on, off - alternating each time the key is pressed).

Syntax

short GetKeyState( int nVirtKey )

Parameters

nVirtKey

[input] Specifies a virtual key. If the desired virtual key is a letter or digit (A through Z, a through z, or 0 through 9), nVirtKey must be set to the ASCII value of that character.

For other keys, it must be a virtual-key code. For example : VK_TAB

Return

The return value specifies the status of the specified virtual key, as follows:

If the high-order bit is 1, the key is down; otherwise, it is up.

If the low-order bit is 1, the key is toggled. A key, such as the CAPS LOCK key,

is toggled if it is turned on. The key is off and untoggled if the low-order bit is 0.

A toggle key's indicator light (if any) on the keyboard will be on when the key is toggled,

and off when the key is untoggled.

Examples

EX1

//This function get the state of the Tab key.
int GetKeyState_ex1()  
{
    short i = GetKeyState(VK_TAB);
    printf("%d",i);
    return 1;
}

Remark

See Also

header to Include

origin.h

Reference