IGameInputRawDeviceReport::GetItemValue

Article
06/22/2023

Note

This function is not yet implemented.

Reads an individual item from the report buffer.

Syntax

bool GetItemValue(  
         uint32_t itemIndex,  
         int64_t* value  
)

Parameters

itemIndex _In_
Type: uint32_t

Index for the report item.

value _Out_
Type: int64_t*

Value of the item read from the device report buffer.

Return value

Type: bool

This function is not yet implemented.

Once implemented, false is returned if the requested item index is out of range.

Remarks

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

Rarely, reports may contain items that are large byte arrays (indicated by the GameInputBufferedItem flag in the item's GameInputRawDeviceReportItemInfo structure). These items are not supported by the GetItemValue and SetItemValue methods, and can only be accessed via the full report buffer by using the GetRawData and SetRawData methods. Attempting to get or set the value of such items using the GetItemValue and SetItemValue methods results in false being returned.

Requirements

Header: GameInput.h

Library: xgameruntime.lib

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