Fonction XInputGetState (xinput.h)

Article
03/09/2024

Récupère l’état actuel du contrôleur spécifié.

Syntaxe

DWORD XInputGetState(
  [in]  DWORD        dwUserIndex,
  [out] XINPUT_STATE *pState
);

Paramètres

[in] dwUserIndex

Index du contrôleur de l’utilisateur. Peut être une valeur comprise entre 0 et 3. Pour plus d’informations sur la façon dont cette valeur est déterminée et sur la façon dont la valeur est mappée aux indicateurs sur le contrôleur, consultez Plusieurs contrôleurs.

[out] pState

Pointeur vers une structure XINPUT_STATE qui reçoit l’état actuel du contrôleur.

Valeur retournée

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

Si le contrôleur n’est pas connecté, la valeur de retour est ERROR_DEVICE_NOT_CONNECTED.

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

Lorsque XInputGetState est utilisé pour récupérer les données du contrôleur, les déclencheurs gauche et droit sont signalés séparément. Pour des raisons héritées, lorsque DirectInput récupère les données du contrôleur, les deux déclencheurs partagent le même axe. Le comportement hérité est perceptible dans l’Panneau de configuration d’appareil de jeu actuel, qui utilise DirectInput pour l’état du contrôleur.