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

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

Подпрограмма 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 (include Hidpi.h)
библиотеки Hidparse.lib
IRQL <= DISPATCH_LEVEL

См. также

HIDP_DATA

HidP_MaxDataListLength

HidP_SetData

_HIDP_PREPARSED_DATA

  • Last updated on