XUserAddAsync
ゲーム セッションにユーザーを非同期に追加します。構文
パラメーター
options _In_Type: XUserAddOptions ゲーム セッションにユーザーを追加するためのオプションです。 async _Inout_
Type: XAsyncBlock* 呼び出しの状態のポーリングおよび呼び出し結果の取得に使用する XAsyncBlock。
戻り値
Type: HRESULT HRESULT の成功またはエラー コード。 エラー コードの一覧については、エラー コード を参照してください。解説
XUserAddAsync は、ユーザーをゲームに追加するための非同期操作を開始します。操作の結果を取得するには、XUserAddResult を使用します。 XUserAddAsync は、options パラメーターに XUserAddOptions::AddDefaultUserSilently または XUserAddOptions::AddDefaultUserAllowingUI のいずれかが渡されない限り、常にアカウント ピッカー UI を表示します。 XUserAddOptions::AddDefaultUserSilently を使用する場合、XUserAddAsync は UI を表示しません。 簡易ユーザー モデル (NDA トピック) を使用する際、この関数にはいくつかの考慮事項があります:- 簡易ユーザー モデルでは、開発者は options が XUserAddOptions::AddDefaultUserSilently に設定されるようにしてください:
- 本体では、簡易ユーザー モデルを使用してルーズにデプロイされたゲームは、既定のユーザーが既にサインインしていなければ起動できません。
- PC では、簡易ユーザー モデルを使用してルーズにデプロイされたゲームは、ユーザーなしで起動できます。ただし、ゲームが XUserAddAsync を呼び出したときに誰もサインインしていない場合、ゲームは終了され、PC ブートストラッパーが起動してユーザーのサインインを支援します。以降の起動は、ユーザーが XBOX Live に完全にサインインしている限り正常に動作します。
- ゲームを起動した既定のユーザーが判明している状態でこれを繰り返し呼び出すと、同じユーザーが返されます。
- 以前に判明していた既定のユーザーがサインアウトしており、デバイスに 1 人のユーザーだけがサインインしている場合、そのユーザーが新しい「既定」のユーザーとしてマークされ、そのユーザーが返されます。
- 以前に判明していた既定のユーザーがサインアウトしており、デバイスに複数のユーザーがサインインしている場合、E_GAMEUSER_NO_DEFAULT_USER が返されます。
- ゲームを起動した既定のユーザーが判明している状態でこれを繰り返し呼び出すと、同じユーザーが返されます。
- 以前に判明していた既定のユーザーがサインアウトしており、デバイスに 1 人のユーザーだけがサインインしている場合、そのユーザーが新しい「既定」のユーザーとしてマークされ、そのユーザーが返されます。
- 最初にゲームを起動したユーザーがサインアウトしており、ユーザー数が 0 人または 2 人以上の場合、システムはユーザーを取得するために UI を表示し、そのユーザーを既定として設定します。
要件
ヘッダー: XUser.h ライブラリ: xgameruntime.lib サポートされているプラットフォーム: Windows、Steam Deck、XBOX One 本体、XBOX Series 本体概念ドキュメント
- Microsoft Game Development Kit (GDK) API タスクを実行する
- 非同期プログラミングの設計目標と改善点
- Implement player sign-in in your game
- Game Chat 2 の概要
- Game Chat 2 C++ API の使用
- Implement player sign in
