XInputGetKeystroke
检索游戏板输入事件。
语法
DWORD XInputGetKeystroke(
DWORD dwUserIndex,
_Reserved_ dwReserved,
XINPUT_KEYSTROKE* pKeystroke
)
参数
dwUserIndex _In_
类型：DWORD
与设备关联的已登录玩家的索引。 一个在 0-XUSER_MAX_COUNT 到 1 范围内的值； XUSER_INDEX_ANY 用于从任何用户处提取下一个可用的输入事件。
dwReserved
类型：Reserved
此参数没有使用。
pKeystroke _Out_
类型：XINPUT_KEYSTROKE*
指向接收输入事件的 XINPUT_KEYSTROKE 结构的指针。
返回值
类型：DWORD
- 如果该函数成功，则将返回 ERROR_SUCCESS。
- 如果未按下任何新键，则该函数将返回 ERROR_EMPTY。
- 如果控制器未连接或者用户尚未激活它，则该函数将返回 ERROR_DEVICE_NOT_CONNECTED；请查看下面“备注”部分。
- 如果该函数失败，则将返回在 Winerror.h 中定义的错误代码。
备注
无线控制器在系统启动时不会被视作活动；如果在无线控制器处于活动状态之前调用任何 XInput 函数，该调用将返回 ERROR_DEVICE_NOT_CONNECTED。 游戏必须检查返回代码并必须做好处理这种情况的准备。 有线控制器在插入后将自动激活。 当用户按“开始”或“指南”按钮打开控制器时，将激活无线控制器。
如果您将从 XInput 移植到 GameInput 的代码未调用 GetKeyStroke 函数，则您可以通过定义 XINPUT_ON_GAMEINPUT_NO_XINPUTGETKEYSTROKE 来减小 XInput 包装器的大小。 有关详细信息，请参阅从 XInput 移植到 GameInput。
要求
头文件：XInputOnGameInput.h
库：xgameruntime.lib
支持的平台：Xbox One 系列主机和 Xbox Series 主机