> ## Documentation Index
> Fetch the complete documentation index at: https://devdocs.xbox.com/llms.txt
> Use this file to discover all available pages before exploring further.

# XInputGetKeystroke

> XInputGetKeystroke

# XInputGetKeystroke

Récupère un événement d'entrée de la manette.

## Syntaxe

```cpp theme={null}
DWORD XInputGetKeystroke(  
         DWORD dwUserIndex,  
         _Reserved_ dwReserved,  
         XINPUT_KEYSTROKE* pKeystroke  
)  
```

### Paramètres

*dwUserIndex*   \_In\_\
Type : DWORD

Index du joueur connecté associé à l'appareil. Valeur comprise entre 0-XUSER\_MAX\_COUNT et 1; XUSER\_INDEX\_ANY sert à récupérer le prochain événement d'entrée disponible de n'importe quel utilisateur.

*dwReserved*   \
Type : *Reserved*

Ce paramètre n'est pas utilisé.

*pKeystroke*   \_Out\_\
Type : [XINPUT\_KEYSTROKE\*](/fr-CA/reference/input/xinputongameinput/structs/xinput_keystroke)

Pointeur vers une structure [XINPUT\_KEYSTROKE](/fr-CA/reference/input/xinputongameinput/structs/xinput_keystroke) qui reçoit un événement d'entrée.

### Valeur de retour

Type : DWORD

* Si la fonction réussit, elle retourne **ERROR\_SUCCESS**.
* Si aucune nouvelle touche n'a été enfoncée, la fonction retourne **ERROR\_EMPTY**.
* Si la manette n'est pas connectée ou si l'utilisateur ne l'a pas activée, la fonction retourne **ERROR\_DEVICE\_NOT\_CONNECTED**; consultez la section Remarques ci-dessous.
* Si la fonction échoue, elle retourne un code d'erreur défini dans Winerror.h.

## Remarques

Les manettes sans fil ne sont pas considérées comme actives au démarrage du système; si une fonction XInput est appelée avant qu'une manette sans fil soit activée, cet appel retourne **ERROR\_DEVICE\_NOT\_CONNECTED**. Les titres de jeux doivent examiner le code de retour et être prêts à gérer cette situation. Les manettes avec fil sont automatiquement activées lorsqu'elles sont branchées. Les manettes sans fil sont activées lorsque l'utilisateur appuie sur le bouton START ou Guide pour allumer la manette.

Si le code que vous portez d'XInput vers GameInput n'appelle pas la fonction GetKeyStroke, vous pouvez réduire la taille du wrapper XInput en définissant XINPUT\_ON\_GAMEINPUT\_NO\_XINPUTGETKEYSTROKE. Pour plus d'informations, consultez [Portage d'XInput vers GameInput](/fr-CA/build/core-features/common/input/porting/input-porting-xinput#optimizingSection).

## Configuration requise

**En-tête :** XInputOnGameInput.h

**Bibliothèque :** xgameruntime.lib

**Plateformes prises en charge :** consoles de la famille XBOX One et consoles XBOX Series

## Voir aussi

[Porter XInput vers GameInput](/fr-CA/build/core-features/common/input/porting/input-porting-xinput)\
[XInputOnGameInput](/fr-CA/reference/input/xinputongameinput/xinputongameinput_members)


## Related topics

- [XInputGetKeystroke](/reference/input/xinputongameinput/functions/xinputgetkeystroke.md)
- [XINPUT_KEYSTROKE](/reference/input/xinputongameinput/structs/xinput_keystroke.md)