> ## 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)                                                                             | 2 つのユーザー ハンドルが等しいかどうかを比較します。                                                                                                                                                                                                    |
| [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)                                       | ユーザーが SPOP プロンプトの操作を終えたことを XUser に通知します。                                                                                                                                                                                        |

## 構造体

| 構造体                                                                                                                  | 説明                                          |
| -------------------------------------------------------------------------------------------------------------------- | ------------------------------------------- |
| [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)
* [Time-sensitive threads](https://learn.microsoft.com/gaming/gdk/docs/gdk-dev/console-dev/overviews/threads/time-sensitive-threads)
* [Using C# wrappers for GDK APIs in your Unity project](https://learn.microsoft.com/gaming/gdk/docs/gdk-dev/pc-dev/tutorials/get-started-with-unity-pc/features/gdk-unity-api-wrappers)

## 関連項目

[System 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 | ゲームの ID が認識されません。MSAAppId と TitleId が、ゲームに関連付けられているものと一致しません。                              |
| E\_GAMEUSER\_NO\_PACKAGE\_IDENTITY                | 0x89245110 | パッケージ ID を構成する必要があります。                                                                     |
| 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](/ja-jp/reference/system/xuser/functions/xuserisstoreuser.md)
- [XUserFindUserById](/ja-jp/reference/system/xuser/functions/xuserfinduserbyid.md)
- [XUserGetMaxUsers](/ja-jp/reference/system/xuser/functions/xusergetmaxusers.md)
- [ユーザー ID と XUser](/ja-jp/build/core-features/common/user/player-identity-xuser.md)
- [XUserState](/ja-jp/reference/system/xuser/enums/xuserstate.md)
