Función XInputGetKeystroke (xinput.h)

Recupera un evento de entrada del controlador para juegos.

Sintaxis

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

Parámetros

dwUserIndex

[in] Índice del jugador que ha iniciado sesión asociado al dispositivo. Puede ser un valor del intervalo de 0 a XUSER_MAX_COUNT – 1 o XUSER_INDEX_ANY para capturar el siguiente evento de entrada disponible de cualquier usuario.

dwReserved

[in] Reservado

pKeystroke

[out] Puntero a una estructura XINPUT_KEYSTROKE que recibe un evento de entrada.

Valor devuelto

Si la función se ejecuta correctamente, el valor devuelto se ERROR_SUCCESS.

Si no se ha presionado ninguna nueva tecla, se ERROR_EMPTY el valor devuelto.

Si el controlador no está conectado o el usuario no lo ha activado, el valor devuelto es ERROR_DEVICE_NOT_CONNECTED. Consulte la sección Comentarios a continuación.

Si se produce un error en la función, el valor devuelto es un código de error definido en Winerror.h. La función no usa SetLastError para establecer el código de último error del subproceso que realiza la llamada.

Comentarios

Los controladores inalámbricos no se consideran activos durante el inicio del sistema, y las llamadas a cualquiera de las funciones XInput antes de que un controlador inalámbrico se realice el retorno activo ERROR_DEVICE_NOT_CONNECTED. Los títulos del juego deben examinar el código de retorno y estar preparados para controlar esta condición. Los controladores cableados se activan automáticamente cuando se insertan. Los controladores inalámbricos se activan cuando el usuario enciende el controlador.

Requisitos de la plataforma

Windows 8 (XInput 1.4), Sdk de DirectX (XInput 1.3)

Requisitos

Requisito	Value
Plataforma de destino	Windows
Encabezado	xinput.h
Library	Xinput.lib
Archivo DLL	Xinput1_4.dll

Consulte también

XINPUT_KEYSTROKE

Funciones XInput