> ## 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

Recupera um evento de entrada do gamepad.

## Sintaxe

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

### Parâmetros

*dwUserIndex*   \_In\_\
Tipo: DWORD

Índice do jogador conectado associado ao dispositivo. Um valor no intervalo de 0-XUSER\_MAX\_COUNT a 1; XUSER\_INDEX\_ANY é usado para buscar o próximo evento de entrada disponível de qualquer usuário.

*dwReserved*   \
Tipo: *Reserved*

Esse parâmetro não é usado.

*pKeystroke*   \_Out\_\
Tipo: [XINPUT\_KEYSTROKE\*](/pt-BR/reference/input/xinputongameinput/structs/xinput_keystroke)

Ponteiro para uma estrutura [XINPUT\_KEYSTROKE](/pt-BR/reference/input/xinputongameinput/structs/xinput_keystroke) que recebe um evento de entrada.

### Valor retornado

Tipo: DWORD

* Se a função for bem-sucedida, ela retornará **ERROR\_SUCCESS**.
* Se nenhuma nova tecla tiver sido pressionada, a função retornará **ERROR\_EMPTY**.
* Se o controle não estiver conectado ou o usuário não o tiver ativado, a função retornará **ERROR\_DEVICE\_NOT\_CONNECTED**; consulte a seção Comentários abaixo.
* Se a função falhar, ela retornará um código de erro definido em Winerror.h.

## Comentários

Os controles sem fio não são considerados ativos na inicialização do sistema; se uma chamada for feita a qualquer uma das funções do XInput antes que um controle sem fio seja ativado, essa chamada retornará **ERROR\_DEVICE\_NOT\_CONNECTED**. Os títulos de jogos devem examinar o código de retorno e estar preparados para lidar com essa condição. Os controles com fio são ativados automaticamente quando são conectados. Os controles sem fio são ativados quando o usuário pressiona o botão START ou Guia para ligar o controle.

Se o código que você está portando do XInput para o GameInput não chamar a função GetKeyStroke, você poderá reduzir o tamanho do wrapper XInput definindo XINPUT\_ON\_GAMEINPUT\_NO\_XINPUTGETKEYSTROKE. Para obter mais informações, consulte [Portabilidade do XInput para o GameInput](/pt-BR/build/core-features/common/input/porting/input-porting-xinput#optimizingSection).

## Requisitos

**Cabeçalho:** XInputOnGameInput.h

**Biblioteca:** xgameruntime.lib

**Plataformas com suporte:** consoles da família XBOX One e consoles XBOX Series

## Confira também

[Portar o XInput para o GameInput](/pt-BR/build/core-features/common/input/porting/input-porting-xinput)\
[XInputOnGameInput](/pt-BR/reference/input/xinputongameinput/xinputongameinput_members)


## Related topics

- [XINPUT_KEYSTROKE](/pt-BR/reference/input/xinputongameinput/structs/xinput_keystroke.md)
- [XInputOnGameInput](/pt-BR/reference/input/xinputongameinput/xinputongameinput_members.md)
- [Portabilidade do XInput para o GameInput](/pt-BR/build/core-features/common/input/porting/input-porting-xinput.md)
- [XInputGetState](/pt-BR/reference/input/xinputongameinput/functions/xinputgetstate.md)
- [XInputGetCapabilities](/pt-BR/reference/input/xinputongameinput/functions/xinputgetcapabilities.md)