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

Статья
02/07/2025

Подпрограмма 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 определяется числомXxxButtonCaps элементами HIDP_CAPS коллекции верхнего уровня.

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

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

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

Требования

Требование	Ценность
минимальные поддерживаемые клиентские	Доступно в Windows 2000 и более поздних версиях Windows.
целевая платформа	Всеобщий
заголовка	hidpi.h (include Hidpi.h)
библиотеки	Hidparse.lib
IRQL	PASSIVE_LEVEL

См. также

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