XInputGetKeystroke 関数 (xinput.h)

ゲームパッド入力イベントを取得します。

構文

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

パラメーター

dwUserIndex

[入力]デバイスに関連付けられているサインインしているゲーマーのインデックス。 0 ~ XUSER_MAX_COUNT - 1 の範囲の値を指定するか、XUSER_INDEX_ANYして任意のユーザーから次に使用可能な入力イベントをフェッチできます。

dwReserved

[入力]予約

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)

要件

要件	値
対象プラットフォーム	Windows
ヘッダー	xinput.h
Library	Xinput.lib
[DLL]	Xinput1_4.dll

こちらもご覧ください

XINPUT_KEYSTROKE

XInput 関数