次の方法で共有

XGameUiShowSendGameInviteAsync

  • [アーティクル]

このメソッドは、ゲームへの招待を送信するために、選択したプレイヤーのフレンド リストと提案されたフレンド リストからのデータを含むピッカー UI を表示します。

構文

HRESULT XGameUiShowSendGameInviteAsync(  
         XAsyncBlock* async,  
         XUserHandle requestingUser,  
         const char* sessionConfigurationId,  
         const char* sessionTemplateName,  
         const char* sessionId,  
         const char* invitationText,  
         const char* customActivationContext  
)

パラメーター

async _In_
型: XAsyncBlock*

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

requestingUser _In_
型: XUserHandle

招待を送信しているユーザーに対するハンドル。

sessionConfigurationId _In_
型: char*

タイトルのサービス構成 ID を示す文字列を指定します。

sessionTemplateName _In_
型: char*

マルチプレイヤー セッション テンプレートの名前を示す文字列を指定します。

sessionId _In_
型: char*

ユーザーを招待するマルチプレイヤー セッションの ID を示す文字列を指定します。

invitationText _In_opt_
型: char*

招待のカスタム文字列の ID を示す文字列を指定します。
この文字列 ID は、標準の招待テキストに追加される招待テキストを識別するために、Xbox Live のサービス コンフィグで定義されます。 ID 文字列にはプレフィックスとして "///" を付ける必要があります。 カスタム文字列を招待に追加しない場合は、空の文字列を渡します。

customActivationContext _In_opt_
型: char*

招待用のアクティベーション URI で、招待されるユーザーが使用できるカスタム アクティベーション コンテキスト。 カスタム アクティベーション コンテキストの文字列は URL セーフである必要があり、バイナリ コンテンツは URL セーフの base64 エンコードでエンコードされる必要があります。 最大の長さは 160 文字です。

戻り値

型: HRESULT

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

解説

リストが表示された後、プレイヤーを選択することができます。 プレイヤーは、ピッカー UI で選択した個人に対して、指定したゲーム セッションでゲームをプレイしたり、パーティー チャットを行ったりするための招待を送信できます。

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

要件

ヘッダー: XGameUI.h

ライブラリ: xgameruntime.lib

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

関連項目

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