Skip to main content

XInputGetKeystroke

Recupera um evento de entrada do gamepad.

Sintaxe

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*
Ponteiro para uma estrutura 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.

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
XInputOnGameInput
Last modified on October 6, 2026