HidD_SetFeature routine

The HidD_SetFeature routine sends a feature report to a top-level collection.

Syntax


BOOLEAN __stdcall HidD_SetFeature(
  _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 feature report buffer that the caller uses to specify a HID 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 feature 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_SetFeature succeeds, it returns TRUE; otherwise, it returns FALSE.

Remarks

Before it calls the HidD_SetFeature 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_SetFeature. 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

Target platform

Universal

Version

Available in Windows 2000 and later versions of Windows.

Header

Hidsdi.h (include Hidsdi.h)

Library

Hid.lib

DLL

Hid.dll

See also

HidD_GetFeature
HidD_GetInputReport
HidD_SetOutputReport
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: