Fonction XInputGetKeystroke (xinput.h)

Récupère un événement d’entrée de boîtier de commande.

Syntaxe

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

Paramètres

dwUserIndex

[in] Index du joueur connecté associé à l’appareil. Il peut s’agir d’une valeur comprise entre 0 et XUSER_MAX_COUNT 1 ou XUSER_INDEX_ANY pour extraire l’événement d’entrée disponible suivant à partir de n’importe quel utilisateur.

dwReserved

[in] Réservé

pKeystroke

[out] Pointeur vers une structure XINPUT_KEYSTROKE qui reçoit un événement d’entrée.

Valeur retournée

Si la fonction réussit, la valeur de retour est ERROR_SUCCESS.

Si aucune nouvelle touche n’a été enfoncée, la valeur de retour est ERROR_EMPTY.

Si le contrôleur n’est pas connecté ou si l’utilisateur ne l’a pas activé, la valeur de retour est ERROR_DEVICE_NOT_CONNECTED. Consultez la section Notes ci-dessous.

Si la fonction échoue, la valeur de retour est un code d’erreur défini dans Winerror.h. La fonction n’utilise pas SetLastError pour définir le code de dernière erreur du thread appelant.

Remarques

Les contrôleurs sans fil ne sont pas considérés comme actifs au démarrage du système, et les appels à l’une des fonctions XInput avant qu’un contrôleur sans fil ne soit activé retournent ERROR_DEVICE_NOT_CONNECTED. Les titres de jeu doivent examiner le code de retour et être prêts à gérer cette condition. Les contrôleurs câblés sont automatiquement activés lorsqu’ils sont insérés. Les contrôleurs sans fil sont activés lorsque l’utilisateur met le contrôleur sous tension.

Configuration requise pour la plateforme

Windows 8 (XInput 1.4), Kit de développement logiciel (SDK) DirectX (XInput 1.3)

Configuration requise

Condition requise	Valeur
Plateforme cible	Windows
En-tête	xinput.h
Bibliothèque	Xinput.lib
DLL	Xinput1_4.dll

Voir aussi

XINPUT_KEYSTROKE

Fonctions XInput