XInputGetKeystroke 函数 (xinput.h)

检索游戏板输入事件。

语法

DWORD XInputGetKeystroke(
  DWORD             dwUserIndex,
  DWORD             dwReserved,
  PXINPUT_KEYSTROKE pKeystroke
);

dwUserIndex

[in]与设备关联的已登录玩家的索引。可以是 0–XUSER_MAX_COUNT • 1 范围内的值，也可以XUSER_INDEX_ANY从任何用户获取下一个可用输入事件。

dwReserved

[in]保留

pKeystroke

[out]指向接收输入事件的 XINPUT_KEYSTROKE 结构的指针。

如果函数成功，则返回值 ERROR_SUCCESS。

如果未按任何新键，则 返回值ERROR_EMPTY。

如果控制器未连接或用户尚未激活，则返回值 ERROR_DEVICE_NOT_CONNECTED。请参阅下面的“备注”部分。

如果函数失败，则返回值为 Winerror.h 中定义的错误代码。函数不使用 SetLastError 设置调用线程的最后错误代码。

无线控制器在系统启动时不被视为活动状态，在将无线控制器设为主动返回之前调用任何 XInput 函数 ERROR_DEVICE_NOT_CONNECTED。游戏必须检查返回代码，并准备好处理这种情况。插入有线控制器时，它们会自动激活。当用户打开控制器电源时，无线控制器将激活。

Windows 8 (XInput 1.4) 、DirectX SDK (XInput 1.3)