XblMultiplayerManagerLobbySessionSetProperties

  • [アーティクル]

ロビー セッションのカスタム プロパティの値を設定してください。

構文

HRESULT XblMultiplayerManagerLobbySessionSetProperties(  
         const char* name,  
         const char* valueJson,  
         void* context  
)

パラメーター

name _In_z_
型: char*

設定するカスタム プロパティの名前。

valueJson _In_z_
型: char*

JSON 文字列としてプロパティに割り当てる値。

context _In_opt_
型: void*

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

戻り値

型: HRESULT

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

解説

この関数は、ロビー セッションのカスタム プロパティの JSON 文字列として表される値を設定します。 カスタム プロパティはいつでも変更できます。 XblMultiplayerManagerDoWork が呼び出されると、変更が一括処理されサービスに書き込まれます。 カスタム プロパティがデバイス間で共有されている場合、または複数のデバイスで同時に更新される場合は、XblMultiplayerManagerLobbySessionSetSynchronizedProperties 関数を使用してカスタム プロパティを変更します。 それ以外の場合は、この関数を使用してカスタム プロパティを変更できます。
この関数の結果は、イベントの種類が XblMultiplayerEventType::SessionPropertyWriteCompleted に設定されたマルチプレイヤー イベントとして配信されます。 XblMultiplayerManagerDoWork を呼び出して、マルチプレイヤー イベントを取得できます。

要件

ヘッダー: multiplayer_manager_c.h

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

関連項目

multiplayer_manager_c
XblMultiplayerManagerLobbySessionSetSynchronizedHost
XblMultiplayerEvent