HidD_GetInputReport function

The HidD_GetInputReport routine returns an input reports from a top-level collection.

Syntax

BOOLEAN HidD_GetInputReport(
  HANDLE HidDeviceObject,
  PVOID  ReportBuffer,
  ULONG  ReportBufferLength
);

Parameters

HidDeviceObject

Specifies an open handle to a top-level collection.

ReportBuffer

Pointer to a caller-allocated input report buffer that the caller uses to specify a HID report ID and HidD_GetInputReport uses to return the specified input report.

For more information about this parameter, see the Remarks section.

ReportBufferLength

Specifies the size, in bytes, of the report buffer. The report buffer must be large enough to hold the input report -- excluding its report ID, if report IDs are used -- plus one additional byte that specifies a nonzero report ID or zero.

Return Value

HidD_GetInputReport returns TRUE if it succeeds; otherwise, it returns FALSE.

Remarks

Before it calls the HidD_GetInputReport routine, the caller must do the following:

  • If the top-level collection includes report IDs, the caller must set the first byte of the ReportBuffer parameter to a nonzero report ID.

  • If the top-level collection does not include report IDs, the caller must set the first byte of the ReportBuffer parameter to zero.

The input report is returned in the ReportBuffer parameter. Depending on the report ID, the caller parses the report by calling one of the following functions:

For an example of how to parse a HID report, see the HClient sample application. This sample is located in the MSDN Code Gallery.

Only user-mode applications can call HidD_GetInputReport. Kernel-mode drivers can use an IOCTL_HID_GET_INPUT_REPORT request.

For more information, see <a href="https://msdn.microsoft.com/10f8c3a1-ad60-4c99-a425-fa8c9a3be0e1">Interpreting HID Reports</a>.

Requirements

   
Minimum supported client Available in Windows XP and later versions of Windows.
Target Platform Universal
Header hidsdi.h (include Hidsdi.h)
Library Hid.lib
DLL Hid.dll

See Also

HidD_GetFeature

HidD_SetFeature

HidD_SetOutputReport

IOCTL_HID_GET_FEATURE

IOCTL_HID_GET_INPUT_REPORT

IOCTL_HID_SET_FEATURE

IOCTL_HID_SET_OUTPUT_REPORT