Skip to main content

XInputGetKeystroke

检索游戏手柄输入事件。

语法

参数

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。游戏必须检查返回码,并做好处理此情况的准备。有线控制器在插入时会自动激活。当用户按下 START 或 Guide 按钮以打开控制器时,无线控制器即被激活。 如果从 XInput 移植到 GameInput 的代码不调用 GetKeyStroke 函数,则可以通过定义 XINPUT_ON_GAMEINPUT_NO_XINPUTGETKEYSTROKE 来减小 XInput 包装器的大小。有关详细信息,请参阅 从 XInput 移植到 GameInput

要求

头文件: XInputOnGameInput.h 库: xgameruntime.lib 支持的平台: XBOX One 系列主机和 XBOX Series 主机

另请参阅

将 XInput 移植到 GameInput
XInputOnGameInput
最后修改于 2026年8月24日