XINPUT_KEYSTROKE

Specifies keystroke data returned by XInputGetKeystroke.

typedef struct _XINPUT_KEYSTROKE {
    WORD VirtualKey;
    WCHAR Unicode;
    WORD Flags;
    BYTE UserIndex;
    BYTE HidCode;
} XINPUT_KEYSTROKE, *PXINPUT_KEYSTROKE;

Members

VirtualKey

Virtual-key code of the key, button, or stick movement. See xam.h for a list of valid virtual-key (VK_xxx) codes. Also, see Remarks below.

Unicode

This member is unused and the value is zero.

Flags

Flags that indicate the keyboard state at the time of the input event. This member can be any combination of the following flags:

Value	Description
XINPUT_KEYSTROKE_KEYDOWN	The key was pressed.
XINPUT_KEYSTROKE_KEYUP	The key was released.
XINPUT_KEYSTROKE_REPEAT	A repeat of a held key.
XINPUT_KEYSTROKE_ALT	The left or right ALT key is down.
XINPUT_KEYSTROKE_CTRL	The left or right CTRL key is down.
XINPUT_KEYSTROKE_SHIFT	The left or right SHIFT key is down.
XINPUT_KEYSTROKE_REMOTE	The key is from the infrared remote.

UserIndex

Index of the signed-in gamer associated with the device. Can be a value in the range 0–3.

HidCode

HID code corresponding to the input. If there is no corresponding HID code, this value is zero.

Remarks

A virtual-key code is a byte value that represents a particular physical key on the keyboard, not the character or characters (possibly none) that the key can be mapped to based on keyboard state. The keyboard state at the time a virtual key is pressed modifies the character reported. For example, VK_4 might represent a "4" or a "$", depending on the state of the SHIFT key.

A reported keyboard event includes the virtual key that caused the event, whether the key was pressed or released (or is repeating), and the state of the keyboard at the time of the event. The keyboard state includes information about whether any CTRL, ALT, or SHIFT keys are down.

If the keyboard event represents an Unicode character (for example, pressing the "A" key), the Unicode member will contain that character. Otherwise, Unicode will contain the value zero.

The valid virtual-key (VK_xxx) codes are defined in xam.h. In addition to codes that indicate key presses, the following codes indicate controller input.

Requirements

Header: Declared in Xbox.h, for include use Xtl.h.

Import Library: Use Xapilib.lib.

See Also

XInputGetKeystroke