> ## Documentation Index > Fetch the complete documentation index at: https://docs.xbox.com/llms.txt > Use this file to discover all available pages before exploring further. # XUser (API 內容) > XUser # XUser XUser API 的參考資料。 ## 函式 | 函式 | 描述 | | - | - | | [XUserAddAsync](https://docs.xbox.com/zh-TW/reference/system/xuser/functions/xuseraddasync.md) | 以非同步方式將使用者新增至遊戲工作階段。 | | [XUserAddByIdWithUiAsync](https://docs.xbox.com/zh-TW/reference/system/xuser/functions/xuseraddbyidwithuiasync.md) | 根據來自遊戲邀請的 XUID，以非同步方式將使用者新增至遊戲工作階段。此函式只應在回應遊戲邀請時使用。 | | [XUserAddByIdWithUiResult](https://docs.xbox.com/zh-TW/reference/system/xuser/functions/xuseraddbyidwithuiresult.md) | 擷取 XUserAddByIdWithUiAsync 所建立之使用者的控制代碼。此函式只應在回應遊戲邀請時使用。 | | [XUserAddResult](https://docs.xbox.com/zh-TW/reference/system/xuser/functions/xuseraddresult.md) | 擷取 XUserAddAsync 所建立之使用者的控制代碼。 | | [XUserChangeEventCallback](https://docs.xbox.com/zh-TW/reference/system/xuser/functions/xuserchangeeventcallback.md) | 應用程式為使用者變更事件定義的回呼。 | | [XUserCheckPrivilege](https://docs.xbox.com/zh-TW/reference/system/xuser/functions/xusercheckprivilege.md) | 判斷使用者是否具有特定權限。 | | [XUserCloseHandle](https://docs.xbox.com/zh-TW/reference/system/xuser/functions/xuserclosehandle.md) | 關閉特定的使用者控制代碼。 | | [XUserCloseSignOutDeferralHandle](https://docs.xbox.com/zh-TW/reference/system/xuser/functions/xuserclosesignoutdeferralhandle.md) | 關閉特定的使用者登出延遲控制代碼。 | | [XUserCompare](https://docs.xbox.com/zh-TW/reference/system/xuser/functions/xusercompare.md) | 比較兩個使用者控制代碼是否相等。 | | [XUserDefaultAudioEndpointUtf16ChangedCallback](https://docs.xbox.com/zh-TW/reference/system/xuser/functions/xuserdefaultaudioendpointutf16changedcallback.md) | 應用程式定義並在使用者的預設音訊端點變更時叫用的回呼。 | | [XUserDeviceAssociationChangedCallback](https://docs.xbox.com/zh-TW/reference/system/xuser/functions/xuserdeviceassociationchangedcallback.md) | 在使用者與裝置的關聯變更時叫用的回呼。 | | [XUserDuplicateHandle](https://docs.xbox.com/zh-TW/reference/system/xuser/functions/xuserduplicatehandle.md) | 複製使用者控制代碼。 | | [XUserFindControllerForUserWithUiAsync](https://docs.xbox.com/zh-TW/reference/system/xuser/functions/xuserfindcontrollerforuserwithuiasync.md) | 顯示對話方塊，提示使用者開啟並識別想要使用的控制器。 | | [XUserFindControllerForUserWithUiResult](https://docs.xbox.com/zh-TW/reference/system/xuser/functions/xuserfindcontrollerforuserwithuiresult.md) | 擷取使用者選擇使用的應用程式本機裝置 ID (APP\_LOCAL\_DEVICE\_ID)。 | | [XUserFindForDevice](https://docs.xbox.com/zh-TW/reference/system/xuser/functions/xuserfindfordevice.md) | 擷取特定裝置 ID 的使用者 ID。 | | [XUserFindUserById](https://docs.xbox.com/zh-TW/reference/system/xuser/functions/xuserfinduserbyid.md) | 擷取本機使用者的 XBox 使用者 ID (XUID)。 | | [XUserFindUserByLocalId](https://docs.xbox.com/zh-TW/reference/system/xuser/functions/xuserfinduserbylocalid.md) | 擷取特定本機使用者 ID 之使用者的控制代碼。 | | [XUserGetAgeGroup](https://docs.xbox.com/zh-TW/reference/system/xuser/functions/xusergetagegroup.md) | 傳回使用者的年齡層。 | | [XUserGetDefaultAudioEndpointUtf16](https://docs.xbox.com/zh-TW/reference/system/xuser/functions/xusergetdefaultaudioendpointutf16.md) | 擷取特定使用者的預設音訊端點。 | | [XUserGetGamerPictureAsync](https://docs.xbox.com/zh-TW/reference/system/xuser/functions/xusergetgamerpictureasync.md) | 以非同步方式擷取特定使用者的玩家圖片。 | | [XUserGetGamerPictureResult](https://docs.xbox.com/zh-TW/reference/system/xuser/functions/xusergetgamerpictureresult.md) | 擷取 XUserGetGamerPictureAsync 呼叫的結果。 | | [XUserGetGamerPictureResultSize](https://docs.xbox.com/zh-TW/reference/system/xuser/functions/xusergetgamerpictureresultsize.md) | 傳回 [XUserGetGamerPictureResult](https://docs.xbox.com/zh-TW/reference/system/xuser/functions/xusergetgamerpictureresult.md) 擷取 [XUserGetGamerPictureAsync](https://docs.xbox.com/zh-TW/reference/system/xuser/functions/xusergetgamerpictureasync.md) 所傳回之玩家圖片時所需的緩衝區大小。 | | [XUserGetGamertag](https://docs.xbox.com/zh-TW/reference/system/xuser/functions/xusergetgamertag.md) | 擷取特定使用者的玩家代號。 | | [XUserGetId](https://docs.xbox.com/zh-TW/reference/system/xuser/functions/xusergetid.md) | 取得特定使用者的使用者 ID。 | | [XUserGetIsGuest](https://docs.xbox.com/zh-TW/reference/system/xuser/functions/xusergetisguest.md) | 傳回布林值，指出使用者是否為來賓。 | | [XUserGetLocalId](https://docs.xbox.com/zh-TW/reference/system/xuser/functions/xusergetlocalid.md) | 擷取使用者的唯一遊戲工作階段 ID。 | | [XUserGetMaxUsers](https://docs.xbox.com/zh-TW/reference/system/xuser/functions/xusergetmaxusers.md) | 擷取遊戲工作階段在目前平台上允許的最大使用者數目。 | | [XUserGetMsaTokenSilentlyAsync](https://docs.xbox.com/zh-TW/reference/system/xuser/functions/xusergetmsatokensilentlyasync.md) | 此函式現已淘汰。 | | [XUserGetMsaTokenSilentlyResult](https://docs.xbox.com/zh-TW/reference/system/xuser/functions/xusergetmsatokensilentlyresult.md) | 此函式現已淘汰。 | | [XUserGetMsaTokenSilentlyResultSize](https://docs.xbox.com/zh-TW/reference/system/xuser/functions/xusergetmsatokensilentlyresultsize.md) | 此函式現已淘汰。 | | [XUserGetSignOutDeferral](https://docs.xbox.com/zh-TW/reference/system/xuser/functions/xusergetsignoutdeferral.md) | 擷取登出延遲的控制代碼。 | | [XUserGetState](https://docs.xbox.com/zh-TW/reference/system/xuser/functions/xusergetstate.md) | 擷取使用者的狀態。 | | [XUserGetTokenAndSignatureAsync](https://docs.xbox.com/zh-TW/reference/system/xuser/functions/xusergettokenandsignatureasync.md) | 以非同步方式擷取 Web 要求的 xtoken 和簽章。 | | [XUserGetTokenAndSignatureResult](https://docs.xbox.com/zh-TW/reference/system/xuser/functions/xusergettokenandsignatureresult.md) | 取得 XUserGetTokenAndSignatureAsync 呼叫的結果。 | | [XUserGetTokenAndSignatureResultSize](https://docs.xbox.com/zh-TW/reference/system/xuser/functions/xusergettokenandsignatureresultsize.md) | 取得用於保存 XUserGetTokenAndSignatureAsync 呼叫結果的緩衝區大小。 | | [XUserGetTokenAndSignatureUtf16Async](https://docs.xbox.com/zh-TW/reference/system/xuser/functions/xusergettokenandsignatureutf16async.md) | 以非同步方式擷取 Web 要求的 Unicode xtoken 和簽章。 | | [XUserGetTokenAndSignatureUtf16Result](https://docs.xbox.com/zh-TW/reference/system/xuser/functions/xusergettokenandsignatureutf16result.md) | 取得 XUserGetTokenAndSignatureUtf16Async 呼叫的結果。 | | [XUserGetTokenAndSignatureUtf16ResultSize](https://docs.xbox.com/zh-TW/reference/system/xuser/functions/xusergettokenandsignatureutf16resultsize.md) | 取得用於保存 XUserGetTokenAndSignatureUtf16Async 呼叫結果的緩衝區大小。 | | [XUserIsStoreUser](https://docs.xbox.com/zh-TW/reference/system/xuser/functions/xuserisstoreuser.md) | 檢查 XUser MSA 是否與登入 Microsoft Store 的 MSA 相同。 | | [XUserRegisterForChangeEvent](https://docs.xbox.com/zh-TW/reference/system/xuser/functions/xuserregisterforchangeevent.md) | 註冊使用者變更事件的回呼。 | | [XUserRegisterForDefaultAudioEndpointUtf16Changed](https://docs.xbox.com/zh-TW/reference/system/xuser/functions/xuserregisterfordefaultaudioendpointutf16changed.md) | 註冊由應用程式定義、並在預設音訊端點變更時叫用的回呼。 | | [XUserRegisterForDeviceAssociationChanged](https://docs.xbox.com/zh-TW/reference/system/xuser/functions/xuserregisterfordeviceassociationchanged.md) | 註冊使用者裝置關聯變更事件的回呼。 | | [XUserResolveIssueWithUiAsync](https://docs.xbox.com/zh-TW/reference/system/xuser/functions/xuserresolveissuewithuiasync.md) | 顯示系統使用者介面，以使用非 Unicode URL 解決權杖問題。 | | [XUserResolveIssueWithUiResult](https://docs.xbox.com/zh-TW/reference/system/xuser/functions/xuserresolveissuewithuiresult.md) | 擷取 XUserResolveIssueWithUiAsync 呼叫的結果。 | | [XUserResolveIssueWithUiUtf16Async](https://docs.xbox.com/zh-TW/reference/system/xuser/functions/xuserresolveissuewithuiutf16async.md) | 顯示系統使用者介面，以使用特定 Unicode URL 解決權杖問題。 | | [XUserResolveIssueWithUiUtf16Result](https://docs.xbox.com/zh-TW/reference/system/xuser/functions/xuserresolveissuewithuiutf16result.md) | 擷取 XUserResolveIssueWithUiUtf16Async 呼叫的結果。 | | [XUserResolvePrivilegeWithUiAsync](https://docs.xbox.com/zh-TW/reference/system/xuser/functions/xuserresolveprivilegewithuiasync.md) | 顯示必要使用者權限的解決使用者介面。 | | [XUserResolvePrivilegeWithUiResult](https://docs.xbox.com/zh-TW/reference/system/xuser/functions/xuserresolveprivilegewithuiresult.md) | 擷取 XUserResolvePrivilegeWithUiAsync 呼叫的結果。 | | [XUserUnregisterForChangeEvent](https://docs.xbox.com/zh-TW/reference/system/xuser/functions/xuserunregisterforchangeevent.md) | 取消註冊先前已註冊的使用者變更回呼。 | | [XUserUnregisterForDefaultAudioEndpointUtf16Changed](https://docs.xbox.com/zh-TW/reference/system/xuser/functions/xuserunregisterfordefaultaudioendpointutf16changed.md) | 取消註冊先前已註冊的預設音訊端點變更回呼。 | | [XUserUnregisterForDeviceAssociationChanged](https://docs.xbox.com/zh-TW/reference/system/xuser/functions/xuserunregisterfordeviceassociationchanged.md) | 取消註冊先前已註冊的使用者裝置關聯變更回呼。 | | [xUserPlatformRemoteConnectSetEventHandlers](https://docs.xbox.com/zh-TW/reference/system/xuser/functions/xuserplatformremoteconnectseteventhandlers.md) | 設定遠端連線事件處理常式 | | [XUserPlatformRemoteConnectCancelPrompt](https://docs.xbox.com/zh-TW/reference/system/xuser/functions/xuserplatformremoteconnectcancelprompt.md) | 向 XUser 發出訊號，表示使用者已關閉遠端連線提示。 | | [XUserPlatformRemoteConnectShowPromptEventHandler](https://docs.xbox.com/zh-TW/reference/system/xuser/functions/xuserplatformremoteconnectshowprompteventhandler.md) | 顯示遠端連線驗證提示的事件處理常式。 | | [XUserPlatformRemoteConnectClosePromptEventHandler](https://docs.xbox.com/zh-TW/reference/system/xuser/functions/xuserplatformremoteconnectcloseprompteventhandler.md) | 關閉遠端驗證提示的事件處理常式。 | | [XUserPlatformSpopPromptEventHandler](https://docs.xbox.com/zh-TW/reference/system/xuser/functions/xuserplatformspopprompteventhandler.md) | 顯示 SPOP 作業提示的事件處理常式 | | [XUserPlatformSpopPromptSetEventHandlers](https://docs.xbox.com/zh-TW/reference/system/xuser/functions/xuserplatformspoppromptseteventhandlers.md) | 設定 SPOP 提示事件處理常式。 | | [XUserPlatformSpopPromptClearEventHandler](https://docs.xbox.com/zh-TW/reference/system/xuser/functions/xuserplatformspoppromptcleareventhandler.md) | 清除 XUser 中的 SPOP 提示事件處理常式。 | | [XUserPlatformSpopPromptComplete](https://docs.xbox.com/zh-TW/reference/system/xuser/functions/xuserplatformspoppromptcomplete.md) | 向 XUser 發出訊號，表示使用者已完成與 SPOP 提示的互動。 | ## 結構 | 結構 | 描述 | | - | - | | [APP\_LOCAL\_DEVICE\_ID](https://docs.xbox.com/zh-TW/reference/system/xuser/structs/app_local_device_id.md) | 指定本機輸入裝置的根 ID。 | | [XUserDeviceAssociationChange](https://docs.xbox.com/zh-TW/reference/system/xuser/structs/xuserdeviceassociationchange.md) | 指定裝置關聯變更時的舊裝置關聯和新裝置關聯。 | | [XUserGetTokenAndSignatureData](https://docs.xbox.com/zh-TW/reference/system/xuser/structs/xusergettokenandsignaturedata.md) | 指定為 Web 要求擷取的 xtoken 和簽章。 | | [XUserGetTokenAndSignatureHttpHeader](https://docs.xbox.com/zh-TW/reference/system/xuser/structs/xusergettokenandsignaturehttpheader.md) | 指定 Web 要求的 HTTP 標頭。 | | [XUserGetTokenAndSignatureUtf16Data](https://docs.xbox.com/zh-TW/reference/system/xuser/structs/xusergettokenandsignatureutf16data.md) | 包含 Web 要求的 Unicode xtoken 和簽章。 | | [XUserGetTokenAndSignatureUtf16HttpHeader](https://docs.xbox.com/zh-TW/reference/system/xuser/structs/xusergettokenandsignatureutf16httpheader.md) | 包含 Web 要求的 Unicode HTTP 標頭。 | | [XUserLocalId](https://docs.xbox.com/zh-TW/reference/system/xuser/structs/xuserlocalid.md) | 指定使用者的遊戲工作階段 ID。 | | [XUserPlatformRemoteConnectEventHandlers](https://docs.xbox.com/zh-TW/reference/system/xuser/structs/xuserplatformremoteconnecteventhandlers.md) | 封裝遠端連線事件處理常式 | ## 列舉 | 列舉 | 描述 | | - | - | | [XUserAddOptions](https://docs.xbox.com/zh-TW/reference/system/xuser/enums/xuseraddoptions.md) | 指定新增使用者的選項。 | | [XUserAgeGroup](https://docs.xbox.com/zh-TW/reference/system/xuser/enums/xuseragegroup.md) | 指定使用者的年齡層。 | | [XUserChangeEvent](https://docs.xbox.com/zh-TW/reference/system/xuser/enums/xuserchangeevent.md) | 指定使用者變更事件的類型。 | | [XUserDefaultAudioEndpointKind](https://docs.xbox.com/zh-TW/reference/system/xuser/enums/xuserdefaultaudioendpointkind.md) | 指定使用者的預設音訊端點是轉譯還是擷取音訊。 | | [XUserGamerPictureSize](https://docs.xbox.com/zh-TW/reference/system/xuser/enums/xusergamerpicturesize.md) | 指定玩家圖片的大小 (以像素為單位)。 | | [XUserGamertagComponent](https://docs.xbox.com/zh-TW/reference/system/xuser/enums/xusergamertagcomponent.md) | 指定要擷取的玩家代號類型 (或元件)。 | | [XUserGetMsaTokenSilentlyOptions](https://docs.xbox.com/zh-TW/reference/system/xuser/enums/xusergetmsatokensilentlyoptions.md) | XUserGetMsaTokenSilentlyOptions 的選項。 | | [XUserGetTokenAndSignatureOptions](https://docs.xbox.com/zh-TW/reference/system/xuser/enums/xusergettokenandsignatureoptions.md) | GetUserTokenAndSignatureAsync 的選項。 | | [XUserPrivilege](https://docs.xbox.com/zh-TW/reference/system/xuser/enums/xuserprivilege.md) | 指定使用者的權限。 | | [XUserPrivilegeDenyReason](https://docs.xbox.com/zh-TW/reference/system/xuser/enums/xuserprivilegedenyreason.md) | 指定使用者無法取得權限的原因。 | | [XUserPrivilegeOptions](https://docs.xbox.com/zh-TW/reference/system/xuser/enums/xuserprivilegeoptions.md) | 指定使用者權限選項。 | | [XUserState](https://docs.xbox.com/zh-TW/reference/system/xuser/enums/xuserstate.md) | 指定使用者目前的狀態。 | | [XUserPlatformOperationResult](https://docs.xbox.com/zh-TW/reference/system/xuser/enums/XUserPlatformOperationResult.md) | 定義用戶端作業結果的列舉 | | [XUserPlatformSpopOperationResult](https://docs.xbox.com/zh-TW/reference/system/xuser/enums/xuserplatformspopoperationresult.md) | 定義用戶端作業結果的列舉。 | ## 概念文件 * [非同步程式設計的設計目標與改進](https://docs.xbox.com/zh-TW/build/core-features/common/async/async-whitepaper.md) * [WinHTTP 概觀](https://docs.xbox.com/zh-TW/build/console-features/networking/web-requests/intro-winhttp.md) * [Web 要求 (內容)](https://docs.xbox.com/zh-TW/build/console-features/networking/web-requests/web-requests-toc.md) * [時間敏感的執行緒](https://learn.microsoft.com/gaming/gdk/docs/gdk-dev/console-dev/overviews/threads/time-sensitive-threads) * [在 Unity 專案中使用 GDK API 的 C# 包裝函式](https://docs.xbox.com/zh-TW/build/gdk-and-engines/unity/unity-api-wrappers.md)  ## 另請參閱 [系統 API 參考](https://docs.xbox.com/zh-TW/reference/system/gc-reference-system-toc.md) ## 錯誤碼 XUser API 可能會傳回下列錯誤碼。如需完整清單，請參閱[錯誤碼](https://docs.xbox.com/zh-TW/reference/errorcodes.md)。 | 代碼 | 值 | 描述 | | - | - | - | | 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 - [使用者登入](https://docs.xbox.com/zh-TW/services/xbox-services/fundamentals/identity/auth/live-authentication-nav.md) - [驗證](https://docs.xbox.com/zh-TW/services/xbox-services/fundamentals/identity/auth/index.md) - [帳戶驗證和存取概觀](https://docs.xbox.com/zh-TW/services/xbox-services/fundamentals/identity/auth/live-authentication-overview.md) - [XtfUser (API 內容)](https://docs.xbox.com/zh-TW/reference/tools/xtf/xtfuser/xtfuser-xbox-windows-n.md) - [XUserDeviceAssociationChangedCallback](https://docs.xbox.com/zh-TW/reference/system/xuser/functions/xuserdeviceassociationchangedcallback.md)