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

Статья
08/07/2023

Подпрограмма HidP_GetData возвращает для указанного отчета массив HIDP_DATA структур, определяющих индексы данных всех кнопок управления HID, для которых в настоящее время задано значение ON (1), а также индексы данных и данные, связанные со всеми значениями элемента управления HID.

Синтаксис

NTSTATUS HidP_GetData(
  [in]      HIDP_REPORT_TYPE     ReportType,
  [out]     PHIDP_DATA           DataList,
  [in, out] PULONG               DataLength,
  [in]      PHIDP_PREPARSED_DATA PreparsedData,
  [in]      PCHAR                Report,
  [in]      ULONG                ReportLength
);

Параметры

[in] ReportType

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

[out] DataList

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

[in, out] DataLength

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

[in] PreparsedData

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

[in] Report

Указатель на отчет HID.

[in] ReportLength

Указывает размер (в байтах) отчета HID, расположенного в разделе Отчет, который должен быть равен длине отчета для указанного типа отчета, возвращаемого HidP_GetCaps в структуре HIDP_CAPS коллекции.

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

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

Код возврата	Описание
HIDP_STATUS_SUCCESS	Все данные управления были успешно возвращены.
HIDP_STATUS_INVALID_REPORT_TYPE	Недопустимый тип отчета, указанный параметром ReportType
HIDP_STATUS_INVALID_PREPARSED_DATA	Готовые данные, указанные в PreparsedData , недопустимы.
HIDP_STATUS_INVALID_REPORT_LENGTH	Размер отчета HID в байтах не равен длине, указанной в структуре HIDP_CAPS коллекции для указанного типа отчета.
HIDP_STATUS_REPORT_DOES_NOT_EXIST	В коллекции верхнего уровня нет отчета указанного типа.
HIDP_STATUS_BUFFER_TOO_SMALL	Массив DataList слишком мал, чтобы описать все кнопки, которые в настоящее время заданы как ON, и все значения в отчете HID.

Приложения пользовательского режима и драйверы в режиме ядра вызывают HidP_MaxDataListLength , чтобы определить максимально возможное количество HIDP_DATA структур, которые могут вернуть HidP_GetData .

HidP_GetData не возвращает данные для массивов значений использования.

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

Требования

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

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

HIDP_DATA

HidP_MaxDataListLength

HidP_SetData

_HIDP_PREPARSED_DATA

Share via