0 out of 2 rated this helpful - Rate this topic

HidD_SetOutputReport routine

The HidD_SetOutputReport routine sends an output report to a top-level collection.

Syntax


BOOLEAN __stdcall HidD_SetOutputReport(
  _In_  HANDLE HidDeviceObject,
  _In_  PVOID ReportBuffer,
  _In_  ULONG ReportBufferLength
);

Parameters

HidDeviceObject [in]

Specifies an open handle to a top-level collection.

ReportBuffer [in]

Pointer to a caller-allocated output report buffer that the caller uses to specify a report ID.

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

ReportBufferLength [in]

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

Return value

If HidD_SetOutputReport succeeds, it returns TRUE; otherwise, it returns FALSE.

Remarks

Before it calls the HidD_SetOutputReport 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 output report is referenced by the ReportBuffer parameter. Depending on the report ID, the caller prepares the report by calling one of the following functions:

For an example of how to prepare and a HID report and send it to a top-level collection, see the HClient sample application. This sample is located in the MSDN Code Gallery.

Only user-mode applications can call HidD_SetOutputReport. Kernel-mode drivers can use an IOCTL_HID_SET_OUTPUT_REPORT request.

For more information, see the following topics:

Sending HID Reports

Interpreting HID Reports

Requirements