次の方法で共有

XGameUiShowPlayerPickerAsync

  • [アーティクル]

選択 UI を表示します。この UI では、ゲームをプレイしている人が、提示されたユーザーのリストからプレイヤーを選択できます。

構文

HRESULT XGameUiShowPlayerPickerAsync(  
         XAsyncBlock* async,  
         XUserHandle requestingUser,  
         const char* promptText,  
         uint32_t selectFromPlayersCount,  
         const uint64_t* selectFromPlayers,  
         uint32_t preSelectedPlayersCount,  
         const uint64_t* preSelectedPlayers,  
         uint32_t minSelectionCount,  
         uint32_t maxSelectionCount  
)

パラメーター

async _In_
型: XAsyncBlock*

XAsyncRun に渡された XAsyncBlock へのポインター。

requestingUser _In_
型: XUserHandle

プレイヤー選択 UI を要求しているユーザーに対するハンドル。

promptText _In_z_
型: char*

プロンプトの表示テキスト。

selectFromPlayersCount _In_
型: uint32_t

呼び出し元が選択できるプレイヤーの数。

selectFromPlayers _In_reads_(selectFromPlayersCount)
型: uint64_t*

呼び出し元が選択できるプレイヤー ID のリストへのポインター。

preSelectedPlayersCount _In_
型: uint32_t

UI が表示されるときにあらかじめ選択されているプレイヤーの数。

preSelectedPlayers _In_reads_opt_(preSelectedPlayersCount)
型: uint64_t*

UI が表示されるときにあらかじめ選択されているプレイヤー ID のリストへのポインター。

minSelectionCount _In_
型: uint32_t

呼び出し元が選択する必要のある最小人数。

maxSelectionCount _In_
型: uint32_t

呼び出し元が選択できる最大人数。

戻り値

型: HRESULT

非同期呼び出しの HRESULT の成功またはエラー コードです。

結果を取得するには、AsyncBlock コールバック内で、または AsyncBlock 完了後に、XGameUiShowPlayerPickerResultCount と XGameUiShowPlayerPickerResult を呼び出します。

解説

プレイヤー ID は、Xbox ユーザー ID (XUID) の uint64_t 値でなければなりません。

UI を呼び出すと、ゲームが制限モードに入ります。 制限モードでは、呼び出された UI のバックグラウンドにある間、タイトルが受け取るシステム リソースが少なくなります。 タイトルの制限モードや他の操作モードの詳細については、「Xbox ゲーム ライフ サイクル (NDA トピック)」をお読みください。

要件

ヘッダー: XGameUI.h

ライブラリ: xgameruntime.lib

サポートされているプラットフォーム: Windows、Xbox One ファミリー本体、Xbox Series 本体

関連項目

XGameUI
XGameUiShowPlayerPickerResult
XGameUiShowPlayerPickerResultCount
Xbox ゲーム ライフ サイクル (NDA トピック)