XUser
XUser API のリファレンス情報です。関数
| 関数 | 説明 |
|---|---|
| XUserAddAsync | ゲーム セッションにユーザーを非同期で追加します。 |
| XUserAddByIdWithUiAsync | ゲーム招待から取得した XUID を基に、ユーザーを非同期でゲーム セッションに追加します。この関数は、ゲーム招待への応答としてのみ使用する必要があります。 |
| XUserAddByIdWithUiResult | XUserAddByIdWithUiAsync が作成するユーザーのハンドルを取得します。この関数は、ゲーム招待への応答としてのみ使用する必要があります。 |
| XUserAddResult | XUserAddAsync が作成するユーザーのハンドルを取得します。 |
| XUserChangeEventCallback | アプリケーションがユーザー変更イベント用に定義するコールバックです。 |
| XUserCheckPrivilege | ユーザーが特定の特権を持っているかどうかを判定します。 |
| XUserCloseHandle | 特定のユーザー ハンドルを閉じます。 |
| XUserCloseSignOutDeferralHandle | 特定のユーザーのサインアウト遅延ハンドルを閉じます。 |
| XUserCompare | 2 つのユーザー ハンドルが等しいかどうかを比較します。 |
| XUserDefaultAudioEndpointUtf16ChangedCallback | アプリケーションが定義し、ユーザーの既定のオーディオ エンドポイントが変更されたときに呼び出されるコールバックです。 |
| XUserDeviceAssociationChangedCallback | ユーザーとデバイスの関連付けが変更されたときに呼び出されるコールバックです。 |
| XUserDuplicateHandle | ユーザー ハンドルを複製します。 |
| XUserFindControllerForUserWithUiAsync | ユーザーに、使用するコントローラーの電源を入れて識別するよう促すダイアログを表示します。 |
| XUserFindControllerForUserWithUiResult | ユーザーが使用することを選んだアプリケーション ローカル デバイス ID (APP_LOCAL_DEVICE_ID) を取得します。 |
| XUserFindForDevice | 特定のデバイス ID に対応するユーザー ID を取得します。 |
| XUserFindUserById | ローカル ユーザーの XBOX ユーザー ID (XUID) を取得します。 |
| XUserFindUserByLocalId | 特定のローカル ユーザー ID に対応するユーザーのハンドルを取得します。 |
| XUserGetAgeGroup | ユーザーの年齢グループを返します。 |
| XUserGetDefaultAudioEndpointUtf16 | 特定のユーザーの既定のオーディオ エンドポイントを取得します。 |
| XUserGetGamerPictureAsync | 特定のユーザーのゲーマー アイコンを非同期に取得します。 |
| XUserGetGamerPictureResult | XUserGetGamerPictureAsync の呼び出し結果を取得します。 |
| XUserGetGamerPictureResultSize | XUserGetGamerPictureResult が、]XUserGetGamerPictureAsync](/ja-jp/reference/system/xuser/functions/xusergetgamerpictureasync) が返すゲーマー アイコンを取得するために必要とするバッファー サイズを返します。 |
| XUserGetGamertag | 特定のユーザーのゲーマータグを取得します。 |
| XUserGetId | 特定のユーザーのユーザー ID を取得します。 |
| XUserGetIsGuest | ユーザーがゲストかどうかを示すブール値を返します。 |
| XUserGetLocalId | ユーザーの一意なゲーム セッション ID を取得します。 |
| XUserGetMaxUsers | 現在のプラットフォームでゲーム セッションに許可されるユーザーの最大数を取得します。 |
| XUserGetMsaTokenSilentlyAsync | この関数は現在非推奨です。 |
| XUserGetMsaTokenSilentlyResult | この関数は現在非推奨です。 |
| XUserGetMsaTokenSilentlyResultSize | この関数は現在非推奨です。 |
| XUserGetSignOutDeferral | サインアウト遅延のハンドルを取得します。 |
| XUserGetState | ユーザーの状態を取得します。 |
| XUserGetTokenAndSignatureAsync | Web リクエスト用の xtoken と署名を非同期で取得します。 |
| XUserGetTokenAndSignatureResult | XUserGetTokenAndSignatureAsync の呼び出し結果を取得します。 |
| XUserGetTokenAndSignatureResultSize | XUserGetTokenAndSignatureAsync の呼び出し結果を保持するために必要なバッファー サイズを取得します。 |
| XUserGetTokenAndSignatureUtf16Async | Web リクエスト用の Unicode xtoken と署名を非同期で取得します。 |
| XUserGetTokenAndSignatureUtf16Result | XUserGetTokenAndSignatureUtf16Async の呼び出し結果を取得します。 |
| XUserGetTokenAndSignatureUtf16ResultSize | XUserGetTokenAndSignatureUtf16Async の呼び出し結果を保持するために必要なバッファー サイズを取得します。 |
| XUserIsStoreUser | XUser の MSA が Microsoft Store にサインインしている MSA と同じかどうかを確認します。 |
| XUserRegisterForChangeEvent | ユーザー変更イベント用のコールバックを登録します。 |
| XUserRegisterForDefaultAudioEndpointUtf16Changed | アプリケーションが定義し、既定のオーディオ エンドポイントが変更されたときに呼び出されるコールバックを登録します。 |
| XUserRegisterForDeviceAssociationChanged | ユーザーとデバイスの関連付け変更イベント用のコールバックを登録します。 |
| XUserResolveIssueWithUiAsync | 非 Unicode URL を使用してトークンの問題を解決するためのシステム ユーザー インターフェイスを表示します。 |
| XUserResolveIssueWithUiResult | XUserResolveIssueWithUiAsync の呼び出し結果を取得します。 |
| XUserResolveIssueWithUiUtf16Async | 特定の Unicode URL を使用してトークンの問題を解決するためのシステム ユーザー インターフェイスを表示します。 |
| XUserResolveIssueWithUiUtf16Result | XUserResolveIssueWithUiUtf16Async の呼び出し結果を取得します。 |
| XUserResolvePrivilegeWithUiAsync | 必要なユーザー特権を解決するためのユーザー インターフェイスを表示します。 |
| XUserResolvePrivilegeWithUiResult | XUserResolvePrivilegeWithUiAsync の呼び出し結果を取得します。 |
| XUserUnregisterForChangeEvent | 以前に登録したユーザー変更コールバックの登録を解除します。 |
| XUserUnregisterForDefaultAudioEndpointUtf16Changed | 以前に登録した既定のオーディオ エンドポイント変更コールバックの登録を解除します。 |
| XUserUnregisterForDeviceAssociationChanged | 以前に登録したユーザーとデバイスの関連付け変更コールバックの登録を解除します。 |
| xUserPlatformRemoteConnectSetEventHandlers | リモート接続イベント ハンドラーを設定します。 |
| XUserPlatformRemoteConnectCancelPrompt | リモート接続プロンプトがユーザーによって閉じられたことを XUser に通知します。 |
| XUserPlatformRemoteConnectShowPromptEventHandler | リモート接続認証用のプロンプト表示イベント ハンドラーです。 |
| XUserPlatformRemoteConnectClosePromptEventHandler | リモート認証用のプロンプトを閉じるイベント ハンドラーです。 |
| XUserPlatformSpopPromptEventHandler | SPOP 操作用のプロンプト表示イベント ハンドラーです。 |
| XUserPlatformSpopPromptSetEventHandlers | SPOP プロンプト イベント ハンドラーを設定します。 |
| XUserPlatformSpopPromptClearEventHandler | XUser の SPOP プロンプト イベント ハンドラーをクリアします。 |
| XUserPlatformSpopPromptComplete | ユーザーが SPOP プロンプトの操作を終えたことを XUser に通知します。 |
構造体
| 構造体 | 説明 |
|---|---|
| APP_LOCAL_DEVICE_ID | ローカル入力デバイスのルート ID を指定します。 |
| XUserDeviceAssociationChange | デバイスとの関連付けが変更されたときの、以前および新しいデバイス関連付けを指定します。 |
| XUserGetTokenAndSignatureData | Web リクエスト用に取得する xtoken と署名を指定します。 |
| XUserGetTokenAndSignatureHttpHeader | Web リクエスト用の HTTP ヘッダーを指定します。 |
| XUserGetTokenAndSignatureUtf16Data | Web リクエスト用の Unicode xtoken と署名を格納します。 |
| XUserGetTokenAndSignatureUtf16HttpHeader | Web リクエスト用の Unicode HTTP ヘッダーを格納します。 |
| XUserLocalId | ユーザーのゲーム セッション ID を指定します。 |
| XUserPlatformRemoteConnectEventHandlers | リモート接続イベント ハンドラーをカプセル化します。 |
列挙型
| 列挙型 | 説明 |
|---|---|
| XUserAddOptions | ユーザーを追加するためのオプションを指定します。 |
| XUserAgeGroup | ユーザーの年齢グループを指定します。 |
| XUserChangeEvent | ユーザー変更イベントの種類を指定します。 |
| XUserDefaultAudioEndpointKind | ユーザーの既定のオーディオ エンドポイントがオーディオをレンダリングするかキャプチャするかを指定します。 |
| XUserGamerPictureSize | ゲーマー アイコンのサイズをピクセル単位で指定します。 |
| XUserGamertagComponent | 取得するゲーマータグの種類 (コンポーネント) を指定します。 |
| XUserGetMsaTokenSilentlyOptions | XUserGetMsaTokenSilentlyOptions のオプションです。 |
| XUserGetTokenAndSignatureOptions | GetUserTokenAndSignatureAsync のオプションです。 |
| XUserPrivilege | ユーザーの特権を指定します。 |
| XUserPrivilegeDenyReason | ユーザーが特権を取得できなかった理由を指定します。 |
| XUserPrivilegeOptions | ユーザー特権のオプションを指定します。 |
| XUserState | ユーザーの現在の状態を指定します。 |
| XUserPlatformOperationResult | クライアント操作の結果を定義する列挙型です。 |
| XUserPlatformSpopOperationResult | クライアント操作の結果を定義する列挙型です。 |
概念ドキュメント
- 非同期プログラミングの設計目標と改善点
- WinHTTP の概要
- Web リクエスト (目次)
- タイム センシティブなスレッド
- Using C# wrappers for GDK APIs in your Unity project
関連項目
System API リファレンスエラー コード
XUser API から返される可能性のあるエラー コードは以下のとおりです。完全な一覧については、「エラー コード」をご覧ください。| コード | 値 | 説明 |
|---|---|---|
| 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 が、ゲームに関連付けられているものと一致しません。 |