IGameInputRawDeviceReport::ResetItemValue

Note

This function is not yet implemented.

Resets a device report item to its original "rest" value.

Syntax

bool ResetItemValue(  
         uint32_t itemIndex  
)  

Parameters

itemIndex   _In_
Type: uint32_t

Index of the report item within the device report buffer.

Return value

Type: bool

Returns true on success; returns false otherwise.

Remarks

The original "rest" value is the initial value for the item when an output or feature report is created via the CreateRawDeviceReport method of the IGameInputDevice interface.

Valid indexes for report items are based on the itemCount member of GameInputRawDeviceReportInfo.

The SetItemValue, ResetItemValue, and ResetAllItems methods can be called only for output and feature reports. All of these methods return very quickly and are safe to call from any context.

Requirements

Header: GameInput.h

Library: xgameruntime.lib

Supported platforms: Windows, Xbox One family consoles and Xbox Series consoles

See also

Overview of GameInput
IGameInputRawDeviceReport
GameInput