XUser

Reference material for XUser APIs.

Functions

Function Description
XUserAddAsync Asynchronously adds a user to a game session.
XUserAddByIdWithUiAsync Asynchronously adds a user to a game session based on a XUID from a game invite. This function should only be used in response to a game invite.
XUserAddByIdWithUiResult Retrieves a handle to the user that XUserAddByIdWithUiAsync creates. This function should only be used in response to a game invite.
XUserAddResult Retrieves a handle to a user that XUserAddAsync creates.
XUserChangeEventCallback A callback that an application defines for a user change event.
XUserCheckPrivilege Determines if a user has a specific privilege.
XUserCloseHandle Closes a specific user handle.
XUserCloseSignOutDeferralHandle Closes a specific user sign out deferral handle.
XUserCompare Compares two user handles for equality.
XUserDefaultAudioEndpointUtf16ChangedCallback A callback that an application defines and invokes when the default audio endpoint for a user changes.
XUserDeviceAssociationChangedCallback A callback that invokes when the user-device association changes.
XUserDuplicateHandle Duplicates a user handle.
XUserFindControllerForUserWithUiAsync Shows a dialog that will prompt the user to turn on and identify which controller they want to use.
XUserFindControllerForUserWithUiResult Retrieves the application local device ID (APP_LOCAL_DEVICE_ID) that a user has chosen to use.
XUserFindForDevice Retrieves the user ID for a specific device ID.
XUserFindUserById Retrieves the XBox User ID (XUID) for a local user.
XUserFindUserByLocalId Retrieves a handle to the user for a specific local user ID.
XUserGetAgeGroup Returns the age group of a user.
XUserGetDefaultAudioEndpointUtf16 Retrieves the default audio endpoint for a specific user.
XUserGetGamerPictureAsync Asynchronously retrieves the gamer picture for a specific user.
XUserGetGamerPictureResult Retrieves the result of a call to XUserGetGamerPictureAsync.
XUserGetGamerPictureResultSize Returns the buffer size that XUserGetGamerPictureResult requires to retrieve the gamer picture that ]XUserGetGamerPictureAsync](functions/xusergetgamerpictureasync.md) returns.
XUserGetGamertag Retrieves the gamertag for a specific user.
XUserGetId Gets the user ID for a specific user.
XUserGetIsGuest Returns a boolean indicating if a user is a guest.
XUserGetLocalId Retrieves a unique game session id for a user.
XUserGetMaxUsers Retrieves the maximum number of users that a game session allows on the current platform.
XUserGetMsaTokenSilentlyAsync Asynchronously retrieves the users MSA token.
XUserGetMsaTokenSilentlyResult Gets the result of a call to XUserGetMsaTokenSilentlyAsync.
XUserGetMsaTokenSilentlyResultSize Gets the buffer size for holding the results of a call to XUserGetMsaTokenSilentlyAsync.
XUserGetSignOutDeferral Retrieves a handle to the sign out deferral.
XUserGetState Retrieves the state of a user.
XUserGetTokenAndSignatureAsync Asynchronously retrieves xtokens and signatures for web requests.
XUserGetTokenAndSignatureResult Gets the result of a call to XUserGetTokenAndSignatureAsync.
XUserGetTokenAndSignatureResultSize Gets the buffer size for holding the results of a call to XUserGetTokenAndSignatureAsync.
XUserGetTokenAndSignatureUtf16Async Asynchronously retrieves Unicode xtokens and signatures for web requests.
XUserGetTokenAndSignatureUtf16Result Gets the result of a call to XUserGetTokenAndSignatureUtf16Async.
XUserGetTokenAndSignatureUtf16ResultSize Gets the buffer size for holding the results of a call to XUserGetTokenAndSignatureUtf16Async.
XUserIsStoreUser Checks if the XUser MSA is the same as the MSA signed into the Microsoft Store.
XUserRegisterForChangeEvent Registers a callback for a user change event.
XUserRegisterForDefaultAudioEndpointUtf16Changed Registers a callback that the application defines and invokes when the default audio endpoint changes.
XUserRegisterForDeviceAssociationChanged Registers a callback for user device association change events.
XUserResolveIssueWithUiAsync Displays a system User Interface for solving token issues with a non-unicode URL.
XUserResolveIssueWithUiResult Retrieves the result of a call to XUserResolveIssueWithUiAsync.
XUserResolveIssueWithUiUtf16Async Displays a system User Interface for solving token issues with a specific unicode URL.
XUserResolveIssueWithUiUtf16Result Retrieves the result of a call to XUserResolveIssueWithUiUtf16Async.
XUserResolvePrivilegeWithUiAsync Displays a resolution user interface for required user privileges.
XUserResolvePrivilegeWithUiResult Retrieves the result of a call to XUserResolvePrivilegeWithUiAsync.
XUserUnregisterForChangeEvent Unregisters a previously registered user change callback.
XUserUnregisterForDefaultAudioEndpointUtf16Changed Unregisters a previously-registered default audio endpoint change callback.
XUserUnregisterForDeviceAssociationChanged Unregisters a previously registered user device association change callback.

Structures

Structure Description
APP_LOCAL_DEVICE_ID Specifies the root ID of a local input device.
XUserDeviceAssociationChange Specifies the old and new device associations when a device association changes.
XUserGetTokenAndSignatureData Specifies the xtokens and signatures that we retrieve for web requests.
XUserGetTokenAndSignatureHttpHeader Specifies the HTTP header for a web request.
XUserGetTokenAndSignatureUtf16Data Contains Unicode xtokens and signatures for web requests.
XUserGetTokenAndSignatureUtf16HttpHeader Contains a Unicode HTTP header for a web request.
XUserLocalId Specifies a game session ID for a user.

Enumerations

Enumeration Description
XUserAddOptions Specifies the options for adding a user.
XUserAgeGroup Specifies the age group of a user.
XUserChangeEvent Specifies the type of user change event.
XUserDefaultAudioEndpointKind Specifies whether the user's default audio endpoint renders or captures audio.
XUserGamerPictureSize Specifies the size of the gamer picture in pixels.
XUserGamertagComponent Specifies the type (or component) of gamertag to fetch.
XUserGetMsaTokenSilentlyOptions Options for XUserGetMsaTokenSilentlyOptions.
XUserGetTokenAndSignatureOptions Options for GetUserTokenAndSignatureAsync.
XUserPrivilege Specifies the privileges of a user.
XUserPrivilegeDenyReason Specifies the reason a user could not obtain a privilege.
XUserPrivilegeOptions Specifies the user privilege options.
XUserState Specifies the current state of the user.

See also

System API reference