HidP_InitializeReportForID function (hidpi.h)

The HidP_InitializeReportForID routine initializes a HID report.

Syntax

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

Parameters

[in] ReportType

Specifies a HIDP_REPORT_TYPE enumerator that indicates the type of HID report located at Report.

[in] ReportID

Specifies a report ID.

[in] PreparsedData

Pointer to the preparsed data of the top-level collection associated with the HID report located at Report.

[out] Report

Pointer to the caller-allocated buffer containing the HID report that HidP_InitializeReportForID initializes.

[in] ReportLength

Specifies the size, in bytes, of the HID report located at Report. ReportLength must be equal to the collection's report length for the specified report type, as specified by the XxxReportByteLength members of a collection's HIDP_CAPS structure.

Return value

HidP_InitializeReportForID returns one of the following status values:

Remarks

Initializing a HID report sets all control data to zero or a control's null value, as defined by the USB HID standard. (Sending or receiving a null value indicates that the current value of a control should not be modified.)

HidP_InitializeReportForID does the following:

• Sets to zero the bitfields of all buttons and values without null values.
• Sets the bitfield of all controls with null values to their corresponding null value.

Requirements

See also

HIDP_CAPS

HIDP_REPORT_TYPE

HidP_GetCaps

_HIDP_PREPARSED_DATA