> ## Documentation Index > Fetch the complete documentation index at: https://devdocs.xbox.com/llms.txt > Use this file to discover all available pages before exploring further. # XUser > XUser # XUser XUser API 的参考资料。 ## 函数 | 函数 | 描述 | | ------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [XUserAddAsync](/reference/system/xuser/functions/xuseraddasync) | 异步地将用户添加到游戏会话。 | | [XUserAddByIdWithUiAsync](/reference/system/xuser/functions/xuseraddbyidwithuiasync) | 根据来自游戏邀请的 XUID 将用户异步添加到游戏会话。此函数仅应用于响应游戏邀请。 | | [XUserAddByIdWithUiResult](/reference/system/xuser/functions/xuseraddbyidwithuiresult) | 检索 XUserAddByIdWithUiAsync 创建的用户句柄。此函数仅应用于响应游戏邀请。 | | [XUserAddResult](/reference/system/xuser/functions/xuseraddresult) | 检索 XUserAddAsync 创建的用户句柄。 | | [XUserChangeEventCallback](/reference/system/xuser/functions/xuserchangeeventcallback) | 应用程序为用户更改事件定义的回调。 | | [XUserCheckPrivilege](/reference/system/xuser/functions/xusercheckprivilege) | 确定用户是否具有特定特权。 | | [XUserCloseHandle](/reference/system/xuser/functions/xuserclosehandle) | 关闭特定用户句柄。 | | [XUserCloseSignOutDeferralHandle](/reference/system/xuser/functions/xuserclosesignoutdeferralhandle) | 关闭特定用户注销延迟句柄。 | | [XUserCompare](/reference/system/xuser/functions/xusercompare) | 比较两个用户句柄是否相等。 | | [XUserDefaultAudioEndpointUtf16ChangedCallback](/reference/system/xuser/functions/xuserdefaultaudioendpointutf16changedcallback) | 应用程序定义并在用户的默认音频终结点更改时调用的回调。 | | [XUserDeviceAssociationChangedCallback](/reference/system/xuser/functions/xuserdeviceassociationchangedcallback) | 当用户-设备关联更改时调用的回调。 | | [XUserDuplicateHandle](/reference/system/xuser/functions/xuserduplicatehandle) | 复制用户句柄。 | | [XUserFindControllerForUserWithUiAsync](/reference/system/xuser/functions/xuserfindcontrollerforuserwithuiasync) | 显示一个对话框，提示用户开启并识别他们想要使用的控制器。 | | [XUserFindControllerForUserWithUiResult](/reference/system/xuser/functions/xuserfindcontrollerforuserwithuiresult) | 检索用户选择使用的应用程序本地设备 ID (APP\_LOCAL\_DEVICE\_ID)。 | | [XUserFindForDevice](/reference/system/xuser/functions/xuserfindfordevice) | 检索特定设备 ID 对应的用户 ID。 | | [XUserFindUserById](/reference/system/xuser/functions/xuserfinduserbyid) | 检索本地用户的 XBOX 用户 ID (XUID)。 | | [XUserFindUserByLocalId](/reference/system/xuser/functions/xuserfinduserbylocalid) | 检索特定本地用户 ID 的用户句柄。 | | [XUserGetAgeGroup](/reference/system/xuser/functions/xusergetagegroup) | 返回用户的年龄组。 | | [XUserGetDefaultAudioEndpointUtf16](/reference/system/xuser/functions/xusergetdefaultaudioendpointutf16) | 检索特定用户的默认音频终结点。 | | [XUserGetGamerPictureAsync](/reference/system/xuser/functions/xusergetgamerpictureasync) | 异步检索特定用户的玩家图片。 | | [XUserGetGamerPictureResult](/reference/system/xuser/functions/xusergetgamerpictureresult) | 检索对 XUserGetGamerPictureAsync 的调用结果。 | | [XUserGetGamerPictureResultSize](/reference/system/xuser/functions/xusergetgamerpictureresultsize) | 返回 [XUserGetGamerPictureResult](/reference/system/xuser/functions/xusergetgamerpictureresult) 检索 ]XUserGetGamerPictureAsync]\(/reference/system/xuser/functions/xusergetgamerpictureasync) 返回的玩家图片所需的缓冲区大小。 | | [XUserGetGamertag](/reference/system/xuser/functions/xusergetgamertag) | 检索特定用户的玩家代号。 | | [XUserGetId](/reference/system/xuser/functions/xusergetid) | 获取特定用户的用户 ID。 | | [XUserGetIsGuest](/reference/system/xuser/functions/xusergetisguest) | 返回一个布尔值，指示用户是否为访客。 | | [XUserGetLocalId](/reference/system/xuser/functions/xusergetlocalid) | 检索用户的唯一游戏会话 ID。 | | [XUserGetMaxUsers](/reference/system/xuser/functions/xusergetmaxusers) | 检索当前平台上游戏会话允许的最大用户数。 | | [XUserGetMsaTokenSilentlyAsync](/reference/system/xuser/functions/xusergetmsatokensilentlyasync) | 此函数现已弃用。 | | [XUserGetMsaTokenSilentlyResult](/reference/system/xuser/functions/xusergetmsatokensilentlyresult) | 此函数现已弃用。 | | [XUserGetMsaTokenSilentlyResultSize](/reference/system/xuser/functions/xusergetmsatokensilentlyresultsize) | 此函数现已弃用。 | | [XUserGetSignOutDeferral](/reference/system/xuser/functions/xusergetsignoutdeferral) | 检索注销延迟的句柄。 | | [XUserGetState](/reference/system/xuser/functions/xusergetstate) | 检索用户的状态。 | | [XUserGetTokenAndSignatureAsync](/reference/system/xuser/functions/xusergettokenandsignatureasync) | 异步检索 Web 请求的 xtoken 和签名。 | | [XUserGetTokenAndSignatureResult](/reference/system/xuser/functions/xusergettokenandsignatureresult) | 获取对 XUserGetTokenAndSignatureAsync 的调用结果。 | | [XUserGetTokenAndSignatureResultSize](/reference/system/xuser/functions/xusergettokenandsignatureresultsize) | 获取保存 XUserGetTokenAndSignatureAsync 调用结果所需的缓冲区大小。 | | [XUserGetTokenAndSignatureUtf16Async](/reference/system/xuser/functions/xusergettokenandsignatureutf16async) | 异步检索 Web 请求的 Unicode xtoken 和签名。 | | [XUserGetTokenAndSignatureUtf16Result](/reference/system/xuser/functions/xusergettokenandsignatureutf16result) | 获取对 XUserGetTokenAndSignatureUtf16Async 的调用结果。 | | [XUserGetTokenAndSignatureUtf16ResultSize](/reference/system/xuser/functions/xusergettokenandsignatureutf16resultsize) | 获取保存 XUserGetTokenAndSignatureUtf16Async 调用结果所需的缓冲区大小。 | | [XUserIsStoreUser](/reference/system/xuser/functions/xuserisstoreuser) | 检查 XUser MSA 是否与登录到 Microsoft Store 的 MSA 相同。 | | [XUserRegisterForChangeEvent](/reference/system/xuser/functions/xuserregisterforchangeevent) | 注册用户更改事件的回调。 | | [XUserRegisterForDefaultAudioEndpointUtf16Changed](/reference/system/xuser/functions/xuserregisterfordefaultaudioendpointutf16changed) | 注册应用程序定义并在默认音频终结点更改时调用的回调。 | | [XUserRegisterForDeviceAssociationChanged](/reference/system/xuser/functions/xuserregisterfordeviceassociationchanged) | 为用户设备关联更改事件注册回调。 | | [XUserResolveIssueWithUiAsync](/reference/system/xuser/functions/xuserresolveissuewithuiasync) | 显示用于解决非 Unicode URL 令牌问题的系统用户界面。 | | [XUserResolveIssueWithUiResult](/reference/system/xuser/functions/xuserresolveissuewithuiresult) | 检索对 XUserResolveIssueWithUiAsync 的调用结果。 | | [XUserResolveIssueWithUiUtf16Async](/reference/system/xuser/functions/xuserresolveissuewithuiutf16async) | 显示用于解决特定 Unicode URL 令牌问题的系统用户界面。 | | [XUserResolveIssueWithUiUtf16Result](/reference/system/xuser/functions/xuserresolveissuewithuiutf16result) | 检索对 XUserResolveIssueWithUiUtf16Async 的调用结果。 | | [XUserResolvePrivilegeWithUiAsync](/reference/system/xuser/functions/xuserresolveprivilegewithuiasync) | 显示所需用户特权的解决方案用户界面。 | | [XUserResolvePrivilegeWithUiResult](/reference/system/xuser/functions/xuserresolveprivilegewithuiresult) | 检索对 XUserResolvePrivilegeWithUiAsync 的调用结果。 | | [XUserUnregisterForChangeEvent](/reference/system/xuser/functions/xuserunregisterforchangeevent) | 注销之前注册的用户更改回调。 | | [XUserUnregisterForDefaultAudioEndpointUtf16Changed](/reference/system/xuser/functions/xuserunregisterfordefaultaudioendpointutf16changed) | 注销之前注册的默认音频终结点更改回调。 | | [XUserUnregisterForDeviceAssociationChanged](/reference/system/xuser/functions/xuserunregisterfordeviceassociationchanged) | 注销之前注册的用户设备关联更改回调。 | | [xUserPlatformRemoteConnectSetEventHandlers](/reference/system/xuser/functions/xuserplatformremoteconnectseteventhandlers) | 设置远程连接事件处理程序 | | [XUserPlatformRemoteConnectCancelPrompt](/reference/system/xuser/functions/xuserplatformremoteconnectcancelprompt) | 向 XUser 发出信号，表明用户已关闭远程连接提示。 | | [XUserPlatformRemoteConnectShowPromptEventHandler](/reference/system/xuser/functions/xuserplatformremoteconnectshowprompteventhandler) | 用于远程连接身份验证的显示提示事件处理程序。 | | [XUserPlatformRemoteConnectClosePromptEventHandler](/reference/system/xuser/functions/xuserplatformremoteconnectcloseprompteventhandler) | 用于远程身份验证的关闭提示事件处理程序。 | | [XUserPlatformSpopPromptEventHandler](/reference/system/xuser/functions/xuserplatformspopprompteventhandler) | SPOP 操作事件处理程序的显示提示 | | [XUserPlatformSpopPromptSetEventHandlers](/reference/system/xuser/functions/xuserplatformspoppromptseteventhandlers) | 设置 SPOP 提示事件处理程序。 | | [XUserPlatformSpopPromptClearEventHandler](/reference/system/xuser/functions/xuserplatformspoppromptcleareventhandler) | 清除 XUser 中的 SPOP 提示事件处理程序。 | | [XUserPlatformSpopPromptComplete](/reference/system/xuser/functions/xuserplatformspoppromptcomplete) | 向 XUser 发出信号，表明用户已完成与 SPOP 提示的交互。 | ## 结构 | 结构 | 描述 | | -------------------------------------------------------------------------------------------------------------------- | ------------------------------ | | [APP\_LOCAL\_DEVICE\_ID](/reference/system/xuser/structs/app_local_device_id) | 指定本地输入设备的根 ID。 | | [XUserDeviceAssociationChange](/reference/system/xuser/structs/xuserdeviceassociationchange) | 指定当设备关联发生更改时旧的和新的设备关联。 | | [XUserGetTokenAndSignatureData](/reference/system/xuser/structs/xusergettokenandsignaturedata) | 指定为 Web 请求所检索的 xtoken 和签名。 | | [XUserGetTokenAndSignatureHttpHeader](/reference/system/xuser/structs/xusergettokenandsignaturehttpheader) | 指定 Web 请求的 HTTP 标头。 | | [XUserGetTokenAndSignatureUtf16Data](/reference/system/xuser/structs/xusergettokenandsignatureutf16data) | 包含 Web 请求的 Unicode xtoken 和签名。 | | [XUserGetTokenAndSignatureUtf16HttpHeader](/reference/system/xuser/structs/xusergettokenandsignatureutf16httpheader) | 包含 Web 请求的 Unicode HTTP 标头。 | | [XUserLocalId](/reference/system/xuser/structs/xuserlocalid) | 指定用户的游戏会话 ID。 | | [XUserPlatformRemoteConnectEventHandlers](/reference/system/xuser/structs/xuserplatformremoteconnecteventhandlers) | 封装远程连接事件处理程序 | ## 枚举 | 枚举 | 描述 | | -------------------------------------------------------------------------------------------------- | ------------------------------------ | | [XUserAddOptions](/reference/system/xuser/enums/xuseraddoptions) | 指定用于添加用户的选项。 | | [XUserAgeGroup](/reference/system/xuser/enums/xuseragegroup) | 指定用户的年龄组。 | | [XUserChangeEvent](/reference/system/xuser/enums/xuserchangeevent) | 指定用户更改事件的类型。 | | [XUserDefaultAudioEndpointKind](/reference/system/xuser/enums/xuserdefaultaudioendpointkind) | 指定用户的默认音频终结点用于呈现还是捕获音频。 | | [XUserGamerPictureSize](/reference/system/xuser/enums/xusergamerpicturesize) | 指定玩家图片的大小（以像素为单位）。 | | [XUserGamertagComponent](/reference/system/xuser/enums/xusergamertagcomponent) | 指定要获取的玩家代号的类型（或组件）。 | | [XUserGetMsaTokenSilentlyOptions](/reference/system/xuser/enums/xusergetmsatokensilentlyoptions) | XUserGetMsaTokenSilentlyOptions 的选项。 | | [XUserGetTokenAndSignatureOptions](/reference/system/xuser/enums/xusergettokenandsignatureoptions) | GetUserTokenAndSignatureAsync 的选项。 | | [XUserPrivilege](/reference/system/xuser/enums/xuserprivilege) | 指定用户的特权。 | | [XUserPrivilegeDenyReason](/reference/system/xuser/enums/xuserprivilegedenyreason) | 指定用户无法获得特权的原因。 | | [XUserPrivilegeOptions](/reference/system/xuser/enums/xuserprivilegeoptions) | 指定用户特权选项。 | | [XUserState](/reference/system/xuser/enums/xuserstate) | 指定用户的当前状态。 | | [XUserPlatformOperationResult](/reference/system/xuser/enums/XUserPlatformOperationResult) | 定义客户端操作结果的枚举 | | [XUserPlatformSpopOperationResult](/reference/system/xuser/enums/xuserplatformspopoperationresult) | 定义客户端操作结果的枚举。 | ## 概念文档 * [异步编程设计目标和改进](/build/core-features/common/async/async-whitepaper) * [WinHTTP 概览](/build/console-features/networking/web-requests/intro-winhttp) * [Web 请求（内容）](/build/console-features/networking/web-requests/web-requests-toc) * [时间敏感线程](https://learn.microsoft.com/gaming/gdk/docs/gdk-dev/console-dev/overviews/threads/time-sensitive-threads) * [在 Unity 项目中使用 GDK API 的 C# 包装器](https://learn.microsoft.com/gaming/gdk/docs/gdk-dev/pc-dev/tutorials/get-started-with-unity-pc/features/gdk-unity-api-wrappers) ## 另请参阅 [系统 API 参考](/reference/system/gc-reference-system-toc) ## 错误代码 XUser API 可能返回以下错误代码。有关完整列表，请参阅[错误代码](/reference/errorcodes)。 | 代码 | 值 | 描述 | | ------------------------------------------------- | ---------- | -------------------------------------------------------------------- | | E\_GAMEUSER\_MAX\_USERS\_ADDED | 0x89245100 | 无法添加此用户，因为已达到最大用户数量。 | | E\_GAMEUSER\_SIGNED\_OUT | 0x89245101 | 由于用户已注销，无法执行该操作。 | | E\_GAMEUSER\_RESOLVE\_USER\_ISSUE\_REQUIRED | 0x89245102 | 需要 UI 来解决此用户的问题。 | | E\_GAMEUSER\_DEFERRAL\_NOT\_AVAILABLE | 0x89245103 | 现在请求延迟不合适。 | | E\_GAMEUSER\_USER\_NOT\_FOUND | 0x89245104 | 未找到与该 ID 匹配的用户。 | | E\_GAMEUSER\_NO\_TOKEN\_REQUIRED | 0x89245105 | 此调用不需要令牌。 | | E\_GAMEUSER\_NO\_DEFAULT\_USER | 0x89245106 | 没有当前默认用户。如果收到此错误，请在不带 AddDefaultUserSilently 的情况下再次调用 XUserAddAsync。 | | E\_GAMEUSER\_FAILED\_TO\_RESOLVE | 0x89245107 | 未能解决给定的特权。 | | E\_GAMEUSER\_NO\_TITLE\_ID | 0x89245108 | 必须配置 XBOX Live TitleId。 | | E\_GAMEUSER\_UNKNOWN\_GAME\_IDENTITY | 0x89245109 | 无法识别游戏身份。MSAAppId 和 TitleId 与与该游戏关联的不匹配。 | | E\_GAMEUSER\_NO\_PACKAGE\_IDENTITY | 0x89245110 | 必须配置程序包身份。 | | E\_GAMEUSER\_FAILED\_TO\_GET\_TOKEN | 0x89245111 | 令牌请求失败。 | | E\_GAMEUSER\_INVALID\_APP\_CONFIGURATION | 0x89245112 | 游戏配置中的 MSAAppId 无效或未针对身份验证堆栈进行配置。 | | E\_GAMEUSER\_MALFORMED\_MSAAPPID | 0x89245113 | 游戏配置中的 MSAAppId 与预期格式不匹配（16 字符字符串或 GUID）。 | | E\_GAMEUSER\_INCONSISTENT\_MSAAPPID\_AND\_TITLEID | 0x89245114 | 游戏配置中的 MSAAppId 和 TitleId 与与该游戏关联的不匹配。 | ## Related topics - [XUserIsStoreUser](/zh-CN/reference/system/xuser/functions/xuserisstoreuser.md) - [用户身份与 XUser](/zh-CN/build/core-features/common/user/player-identity-xuser.md) - [XUserFindUserById](/zh-CN/reference/system/xuser/functions/xuserfinduserbyid.md) - [XUserGetMaxUsers](/zh-CN/reference/system/xuser/functions/xusergetmaxusers.md) - [XUser 的无头自动化](/zh-CN/build/core-features/common/user/users-headless-automation.md)