HidD_SetFeature function

Description

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

Parameters

HidDeviceObject [in]

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]

The size of the report buffer in bytes. The report buffer must be large enough to hold the feature report plus one additional byte that specifies a nonzero report ID. If report ID is not used, the ID value is zero.

Return value

If HidD_SetFeature succeeds, it returns TRUE; otherwise, it returns FALSE. Use GetLastError to get extended error information.

Remarks

The correct _ReportBufferLength_ is specified by the _FeatureReportByteLength_ member of a top-level collection's HIDP_CAPS structure returned from HidP_GetCaps call.

Before it calls the HidD_SetFeature 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 feature report is referenced by the _ReportBuffer_ parameter. Depending on the report ID, the caller prepares the report by calling one of the following functions:
  • HidP_SetData
  • HidP_SetScaledUsageValue
  • HidP_SetUsages
  • HidP_SetUsageValue
  • HidP_SetUsageValueArray

For an example of how to prepare and a HID report and send it to a top-level collection, see the HClient sample application.

Only user-mode applications can call HidD_SetFeature. Kernel-mode drivers can use an IOCTL_HID_SET_FEATURE request.

See also

• Sending HID Reports
• Interpreting HID Reports
• HidD_GetFeature
• HidD_GetInputReport
• HidD_SetOutputReport
• HIDP_CAPS
• HidP_GetCaps
• IOCTL_HID_GET_FEATURE
• IOCTL_HID_GET_INPUT_REPORT
• IOCTL_HID_SET_FEATURE
• IOCTL_HID_SET_OUTPUT_REPORT