HidP_InitializeReportForID (Compact 2013)

3/26/2014

This function initializes a HID report.

Syntax

NTSTATUSHidP_InitializeReportForID(
  HIDP_REPORT_TYPE ReportType,
  UCHAR ReportID,
  PHIDP_PREPARSED_DATA PreparsedData,
  PCHAR Report,
  ULONG ReportLength
);

Parameters

• ReportType
  [in] HIDP_REPORT_TYPE enumerator that indicates the type of HID report located at Report.

• ReportID
  [in] Report identifier.

• PreparsedData
  [in] Pointer to the preparsed data of the top-level collection associated with the HID report located at Report.

• Report
  [in, out] On input, initializes the parameter. On output, pointer to the caller-allocated buffer containing the HID report that HidP_InitializeReportForID initializes.

• ReportLength
  [in] 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

The following table shows the possible return 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 nothing should modify the current value of a control.

HidP_InitializeReportForID sets the bit fields of all buttons and values without NULL values to zero and sets the bit fields of all controls with NULL values to their corresponding NULL value.

Requirements

See Also

Reference

HID Parser Functions
HIDP_CAPS
HIDP_REPORT_TYPE