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


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

Программа 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 должно быть равно длине отчета коллекции для указанного типа отчета, как указано в xxxReportByteLength членов структуры HIDP_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 (include Hidpi.h)
библиотеки Hidparse.lib
IRQL <= DISPATCH_LEVEL

См. также

HIDP_CAPS

HIDP_REPORT_TYPE

HidP_GetCaps

_HIDP_PREPARSED_DATA