Export (0) Print
Expand All

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:

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

Version

Available in Windows XP and later versions of Windows.

Header

Hidsdi.h (include Hidsdi.h)

Library

Hid.lib

See also

HidD_GetFeature
HidD_GetInputReport
HidD_SetFeature
IOCTL_HID_GET_FEATURE
IOCTL_HID_GET_INPUT_REPORT
IOCTL_HID_SET_FEATURE
IOCTL_HID_SET_OUTPUT_REPORT

 

 

Send comments about this topic to Microsoft

Show:
© 2014 Microsoft