Skip to main content

XUserAddResult

XUserAddAsync が作成したユーザーへのハンドルを取得します。

構文

パラメーター

async   _Inout_
Type: XAsyncBlock*
XUserAddAsync に渡された非同期ブロックです。 newUser   _Out_
Type: XUserHandle*
新しいユーザーへのハンドルを格納します。

戻り値

Type: HRESULT HRESULT の成功またはエラー コード。

解説

XUserAddAsync は、ユーザーをゲームに追加するための非同期操作を開始します。操作の結果を取得するには、XUserAddResult を使用します。 XUserAddAsync は、options パラメーターに XUserAddOptions::AddDefaultUserSilently を渡さない限り、常にアカウント ピッカー UI を表示します。 XUserAddOptions::AddDefaultUserSilently を使用する場合、XUserAddAsync は UI を表示しません。XUserAddOptions::AddDefaultUserSilently が返すユーザーは、そのユーザーがサインアウトするまで引き続き返されます。既定のユーザーが利用できない場合、XUserAddResultE_GAMEUSER_NO_DEFAULT_USER を返します。これは、ユーザーを選択するために XUserAddOptions::AddDefaultUserSilently を指定せずに XUserAddAsync を呼び出す必要があることを示します。 XBOX Live からユーザーが禁止 (BAN) されている場合、ゲームはそのユーザーの XUserHandle を取得できません。XUserAddOptions::AddDefaultUserSilently を使用し、ゲームが BAN されたユーザーによって起動された場合、XUserAddResult は E_GAMEUSER_NO_DEFAULT_USER を返します。それ以外の場合、UI が表示され、BAN されていないユーザーがサインインするか、ユーザーが UI をキャンセルする必要があり、XUserAddResult は E_ABORT を返します。 XUserAddOptions::AllowGuestsXUserAddOptions::AddDefaultUserSilently と一緒に使用することはできません。ゲストは既定のユーザーになれません。現在のプラットフォームがゲストをサポートしているかどうかに関係なく、XUserAddOptions::AllowGuests を安全に使用できます。 XUsers API から取得したそれぞれの XUserHandle ハンドルは、XUserCloseHandle を呼び出して 1 回だけ閉じる必要があります。 次の例では、ゲーム セッションにユーザーを非同期に追加する方法を示します。

要件

ヘッダー: XUser.h ライブラリ: xgameruntime.lib サポートされているプラットフォーム: Windows、Steam Deck、XBOX One 本体、XBOX Series 本体

概念ドキュメント

関連項目

XUser XUserAddAsync XUserAddOptions XUserCloseHandle
最終更新日 2026年8月24日