Função XInputGetKeystroke (xinput.h)

Recupera um evento de entrada do gamepad.

Sintaxe

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

Parâmetros

dwUserIndex

[in] Índice do gamer conectado associado ao dispositivo. Pode ser um valor no intervalo de 0 a XUSER_MAX_COUNT – 1 ou XUSER_INDEX_ANY buscar o próximo evento de entrada disponível de qualquer usuário.

dwReserved

[in] Reservados

pKeystroke

[out] Ponteiro para uma estrutura XINPUT_KEYSTROKE que recebe um evento de entrada.

Retornar valor

Se a função for bem-sucedida, o valor retornado será ERROR_SUCCESS.

Se nenhuma nova tecla tiver sido pressionada, o valor retornado será ERROR_EMPTY.

Se o controlador não estiver conectado ou o usuário não o ativou, o valor retornado será ERROR_DEVICE_NOT_CONNECTED. Consulte a seção Comentários abaixo.

Se a função falhar, o valor retornado será um código de erro definido em Winerror.h. A função não usa SetLastError para definir o código de último erro do thread de chamada.

Comentários

Os controladores sem fio não são considerados ativos na inicialização do sistema e chamadas para qualquer uma das funções XInput antes que um controlador sem fio seja ERROR_DEVICE_NOT_CONNECTED de retorno ativo. Os títulos do jogo devem examinar o código de retorno e estar preparados para lidar com essa condição. Os controladores com fio são ativados automaticamente quando são inseridos. Os controladores sem fio são ativados quando o usuário ligar o controlador.

Requisitos da plataforma

Windows 8 (XInput 1.4), SDK do DirectX (XInput 1.3)

Requisitos

Requisito	Valor
Plataforma de Destino	Windows
Cabeçalho	xinput.h
Biblioteca	Xinput.lib
DLL	Xinput1_4.dll

Confira também

XINPUT_KEYSTROKE

Funções XInput