IGameInputDevice::GetRawDeviceFeature

Reads a raw feature report from the device.

Syntax

HRESULT GetRawDeviceFeature(
    uint32_t reportId,
    IGameInputRawDeviceReport** report
);

Parameters

reportId _In_
Type: uint32_t ID of the feature report to read. Must match the id member of one of the reports returned by GetFeatureReportInfo. report _COM_Outptr_
Type: IGameInputRawDeviceReport** Receives a new IGameInputRawDeviceReport object that contains the feature report data read from the device. Set to nullptr on failure.

Return value

Type: HRESULT Returns S_OK on success. Returns E_NOTFOUND if the device doesn’t define a feature report with the specified ID, and GAMEINPUT_E_AGGREGATE_OPERATION_NOT_SUPPORTED if the device is an aggregate device. Returns other error codes if the report can’t be read from the device.

Remarks

The GetRawDeviceFeature method requests the current contents of a feature report from the device and returns them in a new IGameInputRawDeviceReport object. The kind member of the report’s GameInputRawDeviceReportInfo is GameInputRawFeatureReport, and its data size matches the size member of the corresponding element returned by GetFeatureReportInfo. Read the data by calling GetRawDataSize and IGameInputRawDeviceReport::GetRawData. Use GetFeatureReportCount and GetFeatureReportInfo to discover which feature reports a device defines. Feature reports are currently exposed for HID devices. For HID devices, the first byte of the report data is the report ID. Unlike the other raw report methods, GetRawDeviceFeature waits for the device to reply before it returns, so avoid calling it on time-critical threads such as your render or input-polling thread.

Microsoft::WRL::ComPtr<IGameInputRawDeviceReport> report;
if (SUCCEEDED(device->GetRawDeviceFeature(reportId, &report)))
{
    std::vector<uint8_t> data(report->GetRawDataSize());
    data.resize(report->GetRawData(data.size(), data.data()));
    // Parse the device-specific feature report data...
}

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::GetRawDeviceFeature (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