Функция XInputGetKeystroke (xinput.h)
Извлекает событие ввода геймпада.
Синтаксис
DWORD XInputGetKeystroke(
DWORD dwUserIndex,
DWORD dwReserved,
PXINPUT_KEYSTROKE pKeystroke
);
Параметры
dwUserIndex
[in] Индекс вошедшего игрока, связанного с устройством. Может быть значением в диапазоне от 0 до XUSER_MAX_COUNT − 1 или XUSER_INDEX_ANY для получения следующего доступного события ввода от любого пользователя.
dwReserved
[in] Зарезервировано.
pKeystroke
[out] Указатель на структуру XINPUT_KEYSTROKE , получающую входное событие.
Возвращаемое значение
Если функция выполнена успешно, возвращаемое значение будет ERROR_SUCCESS.
Если новые клавиши не были нажаты, возвращаемое значение будет ERROR_EMPTY.
Если контроллер не подключен или пользователь не активировал его, возвращаемое значение будет ERROR_DEVICE_NOT_CONNECTED. См. раздел "Примечания" ниже.
Если функция завершается сбоем, возвращаемое значение представляет собой код ошибки, определенный в Winerror.h. Функция не использует SetLastError для задания кода последней ошибки вызывающего потока.
Комментарии
Беспроводные контроллеры не считаются активными при запуске системы, и вызовы любой из функций XInput до того, как беспроводной контроллер становится активным , возвращают ERROR_DEVICE_NOT_CONNECTED. Игры должны проверять код возврата и быть готовыми к обработке этого условия. Проводные контроллеры автоматически активируются при их вставке. Беспроводные контроллеры активируются при включении контроллера пользователем.
Требования к платформе
Windows 8 (XInput 1.4), пакет SDK для DirectX (XInput 1.3)Требования
| Требование | Значение |
|---|---|
| Целевая платформа | Windows |
| Header | xinput.h |
| Библиотека | Xinput.lib |
| DLL | Xinput1_4.dll |