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

Статья
08/07/2023

Подпрограмма HidP_GetExtendedAttributes возвращает расширенные атрибуты элемента управления HID.

Синтаксис

NTSTATUS HidP_GetExtendedAttributes(
  [in]      HIDP_REPORT_TYPE          ReportType,
  [in]      USHORT                    DataIndex,
  [in]      PHIDP_PREPARSED_DATA      PreparsedData,
  [out]     PHIDP_EXTENDED_ATTRIBUTES Attributes,
  [in, out] PULONG                    LengthAttributes
);

Параметры

[in] ReportType

Задает значение перечислителя HIDP_REPORT_TYPE , указывающее тип отчета HID, связанного с элементом управления HID, заданным dataIndex.

[in] DataIndex

Указывает индекс данных элемента управления HID.

[in] PreparsedData

Указывает подготовленные данные для коллекции верхнего уровня , содержащей указанный элемент управления.

[out] Attributes

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

[in, out] LengthAttributes

Задает размер буфера атрибутов (в байтах), который должен быть больше или равен размеру sizeof(HIDP_EXTENDED_ATTRIBUTES).

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

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

Код возврата	Описание
HIDP_STATUS_SUCCESS	Подпрограмма успешно вернула все расширенные сведения об атрибутах элемента управления.
HIDP_STATUS_BUFFER_TOO_SMALL	Буфер атрибутов не был достаточно велик для хранения всех расширенных сведений об атрибутах.
HIDP_STATUS_DATA_INDEX_NOT_FOUND	Указанный индекс данных недопустим.

HidP_GetExtendedAttributes возвращает структуру переменной длины HIDP_EXTENDED_ATTRIBUTES в буфере атрибутов . Структура расширенных атрибутов содержит в последовательном порядке члены фиксированной длины (NumGlobalUnknowns, Reserved и GlobalUnknowns), за которыми следует массив переменной длины HIDP_UNKNOWN_TOKEN структур. Первый элемент неизвестного массива маркеров находится в (PHIDP_UNKNOWN_TOKEN*)&(Attributes-Data>).

Подпрограмма возвращает столько байтов сведений о расширенных атрибутах, сколько может хранить буфер атрибутов . Если буфер слишком мал, подпрограмма усекает возвращаемую информацию. Чтобы определить количество неизвестных маркеров в массиве переменной длины, вызывающий объект может сначала использовать буфер Атрибуты для возврата значения элемента NumGlobalUnknowns расширенных атрибутов .

Дополнительные сведения см. в разделе Коллекции HID.

Требования

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

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

HIDP_EXTENDED_ATTRIBUTES

HIDP_UNKNOWN_TOKEN

_HIDP_PREPARSED_DATA

Share via