XblMultiplayerManagerLobbySessionSetLocalMemberProperties

ローカル メンバー向けのカスタム プロパティを、指定した JSON 文字列に設定します。

構文

HRESULT XblMultiplayerManagerLobbySessionSetLocalMemberProperties(  
         XblUserHandle user,  
         const char* name,  
         const char* valueJson,  
         void* context  
)  

パラメーター

user _In_
型: XblUserHandle

プロパティを設定するユーザー。

name _In_z_
型: char*

設定するプロパティの名前。

valueJson _In_z_
型: char*

省略可能。 プロパティに割り当てる JSON 値。

context _In_opt_
型: void*

省略可能。 開始呼び出しに XblMultiplayerEvent を関連付けるためのアプリケーション定義データ。

戻り値

型: HRESULT

この API 操作の HRESULT 結果コード。

解説

この関数は、ロビー セッションでローカル メンバーのカスタム プロパティの JSON 文字列として表される値を設定します。 カスタム プロパティはいつでも変更できます。 XblMultiplayerManagerDoWork が呼び出されると、変更がバッチ処理されてサービスに書き込まれます。
この関数の結果は、イベントの種類が XblMultiplayerEventType::LocalMemberPropertyWriteCompleted に設定されたマルチプレイヤー イベントとして配信されます。 XblMultiplayerManagerDoWork を呼び出して、マルチプレイヤー イベントを取得できます。

要件

ヘッダー: multiplayer_manager_c.h

図書館: Microsoft.Xbox.Services.14x.GDK.C.lib

関連項目

multiplayer_manager_c
XblMultiplayerManagerGameSessionSetSynchronizedHost
XblMultiplayerEvent