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 來設定呼叫線程的最後一個錯誤碼。

無線控制器在系統啟動時不會被視為作用中，而且在無線控制器成為作用中傳回ERROR_DEVICE_NOT_CONNECTED之前呼叫任何 XInput 函式。遊戲標題必須檢查傳回碼，並準備好處理此條件。插入有線控制器時會自動啟動。當用戶開啟控制器電源時，就會啟動無線控制器。

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