XInputGetKeystroke-Funktion (xinput.h)

  • Artikel

Ruft ein Gamepad-Eingabeereignis ab.

Syntax

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

Parameter

dwUserIndex

[in] Index des angemeldeten Spielers, der dem Gerät zugeordnet ist. Kann ein Wert im Bereich 0–XUSER_MAX_COUNT − 1 sein, oder XUSER_INDEX_ANY, um das nächste verfügbare Eingabeereignis von einem beliebigen Benutzer abzurufen.

dwReserved

[in] Reserviert

pKeystroke

[out] Zeiger auf eine XINPUT_KEYSTROKE Struktur, die ein Eingabeereignis empfängt.

Rückgabewert

Wenn die Funktion erfolgreich ist, wird der Rückgabewert ERROR_SUCCESS.

Wenn keine neuen Tasten gedrückt wurden, wird der Rückgabewert ERROR_EMPTY.

Wenn der Controller nicht verbunden ist oder der Benutzer ihn nicht aktiviert hat, wird der Rückgabewert ERROR_DEVICE_NOT_CONNECTED. Weitere Informationen finden Sie weiter unten im Abschnitt Hinweise.

Wenn die Funktion fehlschlägt, ist der Rückgabewert ein in Winerror.h definierter Fehlercode. Die Funktion verwendet SetLastError nicht, um den Letzten Fehlercode des aufrufenden Threads festzulegen.

Hinweise

Drahtlose Controller gelten beim Systemstart nicht als aktiv, und Aufrufe einer der XInput-Funktionen , bevor ein Drahtloser Controller aktiv wird, geben ERROR_DEVICE_NOT_CONNECTED zurück. Spieltitel müssen den Rückgabecode untersuchen und darauf vorbereitet sein, diese Bedingung zu behandeln. Kabelcontroller werden automatisch aktiviert, wenn sie eingefügt werden. Drahtlose Controller werden aktiviert, wenn der Benutzer den Controller einschaltt.

Plattformanforderungen

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

Anforderungen

Anforderung Wert
Zielplattform Windows
Kopfzeile xinput.h
Bibliothek Xinput.lib
DLL Xinput1_4.dll

Weitere Informationen

XINPUT_KEYSTROKE

XInput-Funktionen