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

Статья
08/07/2023

Подпрограмма HidP_InitializeReportForID инициализирует отчет HID.

Синтаксис

NTSTATUS HidP_InitializeReportForID(
  [in]  HIDP_REPORT_TYPE     ReportType,
  [in]  UCHAR                ReportID,
  [in]  PHIDP_PREPARSED_DATA PreparsedData,
  [out] PCHAR                Report,
  [in]  ULONG                ReportLength
);

Параметры

[in] ReportType

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

[in] ReportID

Указывает идентификатор отчета.

[in] PreparsedData

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

[out] Report

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

[in] ReportLength

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

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

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

Код возврата	Описание
HIDP_STATUS_SUCCESS	Отчет успешно инициализирован.
HIDP_STATUS_INVALID_PREPARSED_DATA	Готовые данные недопустимы.
HIDP_STATUS_INVALID_REPORT_LENGTH	Указанная длина отчета не равна длине отчета коллекции для указанного типа отчета.
HIDP_STATUS_INVALID_REPORT_TYPE	Недопустимый тип отчета.
HIDP_STATUS_REPORT_DOES_NOT_EXIST	Указанный идентификатор отчета недопустим.

При инициализации отчета HID все данные элемента управления задаются равным нулю или значению NULL элемента управления, как определено стандартом USB HID. (Отправка или получение значения NULL указывает, что текущее значение элемента управления не должно изменяться.)

HidP_InitializeReportForID выполняет следующие действия.

Устанавливает равным нулю битовые поля всех кнопок и значений без значений NULL.
Задает битовое поле всех элементов управления со значениями NULL для соответствующего значения NULL.

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

Требования

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

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

Share via