Поделиться через

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

  • Статья

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

Синтаксис

NTSTATUS HidP_GetSpecificButtonCaps(
  [in]      HIDP_REPORT_TYPE     ReportType,
  [in]      USAGE                UsagePage,
  [in]      USHORT               LinkCollection,
  [in]      USAGE                Usage,
  [out]     PHIDP_BUTTON_CAPS    ButtonCaps,
  [in, out] PUSHORT              ButtonCapsLength,
  [in]      PHIDP_PREPARSED_DATA PreparsedData
);

Параметры

[in] ReportType

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

[in] UsagePage

Указывает страницу использования в качестве условий поиска. Если UsagePage не является нулевым, возвращаются только кнопки, указывающие эту страницу использования.

[in] LinkCollection

Указывает коллекцию ссылок в качестве условия поиска. Если linkCollection не является нулевым, возвращаются только кнопки, входящие в эту коллекцию ссылок.

[in] Usage

Указывает использование HID в качестве условия поиска. Если значение "Использование " не равно нулю, будут возвращены только кнопки, указывающие это использование.

[out] ButtonCaps

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

[in, out] ButtonCapsLength

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

[in] PreparsedData

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

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

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

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

Комментарии

Требуемый размер массива ButtonCaps определяется элементами NumberXxxButtonCaps структуры HIDP_CAPS коллекции верхнего уровня.

При вызове HidP_GetSpecificButtonCaps указание нуля для UsagePage, Usage и LinkCollection эквивалентно вызову HidP_GetButtonCaps.

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

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

Требования

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

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

HIDP_BUTTON_CAPS

HidP_GetButtonCaps

HidP_GetCaps

_HIDP_PREPARSED_DATA