IGameInputDevice::SetRawDeviceFeature

Sends a raw feature report to the device.

Syntax

HRESULT SetRawDeviceFeature(
    IGameInputRawDeviceReport* report
);

Parameters

report _In_
Type: IGameInputRawDeviceReport* The feature report to send. Create it by calling CreateRawDeviceReport with GameInputRawFeatureReport, and fill it by calling IGameInputRawDeviceReport::SetRawData.

Return value

Type: HRESULT Returns S_OK if the report was submitted to the device. Returns GAMEINPUT_E_AGGREGATE_OPERATION_NOT_SUPPORTED if the device is an aggregate device, or another error code if the report can’t be submitted.

Remarks

The SetRawDeviceFeature method writes a feature report to the device. The report ID is taken from the report’s GameInputRawDeviceReportInfo, and the payload is the data set with IGameInputRawDeviceReport::SetRawData. Use GetFeatureReportCount and GetFeatureReportInfo to discover which feature reports a device defines and how large each one is. Feature reports are currently exposed for HID devices. For HID devices, the first byte of the report data is the report ID. SetRawDeviceFeature queues the report for delivery and returns without waiting for the device to process it. A successful return value means the report was submitted, not that the device accepted it. To confirm the new state, read the report back by calling GetRawDeviceFeature.

Microsoft::WRL::ComPtr<IGameInputRawDeviceReport> report;
if (SUCCEEDED(device->CreateRawDeviceReport(reportId, GameInputRawFeatureReport, &report)))
{
    // The first byte of a HID feature report is the report ID.
    uint8_t data[] = { static_cast<uint8_t>(reportId), 0x01, 0x00 };
    if (report->SetRawData(sizeof(data), data))
    {
        device->SetRawDeviceFeature(report.Get());
    }
}

For intermediate and advanced use cases of the GameInput API, see Advanced GameInput topics.

Requirements

Header: GameInput.h Library: gameinput.lib Supported platforms: Windows, XBOX One family consoles and XBOX Series consoles

Version History

Version	Changes
v4	Re-introduced.
v1	Removed.
v0	Introduced (not implemented).

Appendix: Previous versions

v0

In GameInput v0, this method was declared with the same signature but wasn’t implemented. For more information, see IGameInputDevice::SetRawDeviceFeature (Deprecated).

Chat API reference

Developer kit only API reference

Graphics API reference

Input API reference

Lighting API reference

Networking API reference

XBOX PC remote iteration API reference

System API reference

Tools API reference

Windows device portal REST API reference

XBOX services API reference

MicrosoftGame.config reference

Additional pages

Reference

Syntax

Parameters

Return value

Remarks

Requirements

See also

Version History

Appendix: Previous versions

v0

​Syntax

​Parameters

​Return value

​Remarks

​Requirements

​See also

​Version History

​Appendix: Previous versions

​v0

Syntax

Parameters

Return value

Remarks

Requirements

See also

Version History

Appendix: Previous versions

v0