функция HidP_GetButtonCaps (hidpi.h)

Подпрограмма HidP_GetButtonCaps возвращает массив возможностей кнопок , описывающий все управляющие кнопки HID в коллекции верхнего уровня для указанного типа отчета HID.

Синтаксис

NTSTATUS HidP_GetButtonCaps(
  [in]      HIDP_REPORT_TYPE     ReportType,
  [out]     PHIDP_BUTTON_CAPS    ButtonCaps,
  [in, out] PUSHORT              ButtonCapsLength,
  [in]      PHIDP_PREPARSED_DATA PreparsedData
);

Параметры

[in] ReportType

Задает значение перечислителя HIDP_REPORT_TYPE , определяющее тип отчета.

[out] ButtonCaps

Указатель на буфер, выделенный вызывающим объектом, который подпрограмма использует для возврата массива возможностей кнопки для указанного типа отчета.

[in, out] ButtonCapsLength

Задает длину буфера, предоставленного в ButtonCaps, во входных элементах массива. В выходных данных этому параметру присваивается фактическое количество элементов, возвращаемых подпрограммой.

[in] PreparsedData

Указатель на подготовленные данные коллекции верхнего уровня.

Возвращаемое значение

HidP_GetButtonCaps возвращает одно из следующих значений состояния:

Код возврата Описание
HIDP_STATUS_SUCCESS
Подпрограмма успешно вернула данные о возможностях.
HIDP_STATUS_INVALID_PREPARSED_DATA
Готовые данные недопустимы.

Комментарии

HidP_GetButtonCaps возвращает возможность всех кнопок в коллекции верхнего уровня для указанного типа отчета.

ButtonCapsLength должно иметь значение элемента NumberXxxButtonCaps структуры HIDP_CAPS , возвращаемой HidP_GetCaps, где xxx указывает тип отчета.

Чтобы получить подмножество возможностей кнопки, выбранных по использованию, странице использования или коллекции ссылок, используйте HidP_GetSpecificButtonCaps.

Дополнительные сведения о возможностях коллекции см. в разделе Получение сведений о коллекции.

См. также коллекции HID.

Требования

Требование Значение
Минимальная версия клиента Доступно в Windows 2000 и более поздних версиях Windows.
Целевая платформа Универсальное
Верхняя часть hidpi.h (включая Hidpi.h)
Библиотека Hidparse.lib
IRQL PASSIVE_LEVEL

См. также раздел

HIDP_BUTTON_CAPS

HidP_GetCaps

HidP_GetSpecificButtonCaps

_HIDP_PREPARSED_DATA