XUserGetState

Retrieves the state of a user.

Syntax

HRESULT XUserGetState(  
         XUserHandle user,  
         XUserState* state  
)  

Parameters

user _In_
Type: XUserHandle A handle to the user to retrieve the state for. state _Out_
Type: XUserState* Contains the state of a specific user.

Return value

Type: HRESULT HRESULT success or error code.
For a list of error codes, see Error Codes.

Remarks

A user can exist in three states within a game title. For details, visit XUserState. To monitor changes to a user’s state or information, call the XUserRegisterForChangeEvent function. The function subscribes to an XUserChangeEvent enumeration.

Requirements

Header: XUser.h Library: xgameruntime.lib Supported platforms: Windows, Steam Deck, XBOX One family consoles and XBOX Series consoles

(all) API references

Error codes

Audio API reference

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

XUserGetState

XUserGetState

Syntax

Parameters

Return value

Remarks

Requirements

See also

​XUserGetState

​Syntax

​Parameters

​Return value

​Remarks

​Requirements

​See also

XUserGetState

Syntax

Parameters

Return value

Remarks

Requirements

See also