Skip to main content

XblMultiplayerManagerGameSessionSetSynchronizedProperties

XblMultiplayerSessionWriteMode::SynchronizedUpdate を使用して、ゲーム セッションのカスタム プロパティの値を設定します。

構文

パラメーター

name   _In_z_
型: char*
設定するカスタム プロパティの名前。 valueJson   _In_z_
型: char*
プロパティに割り当てる値 (JSON 文字列)。 context   _In_opt_
型: void*
省略可能。XblMultiplayerEvent を発生元の呼び出しに関連付けるためのアプリケーション定義のデータ。

戻り値

型: HRESULT この API 操作の HRESULT 戻り値コード。

解説

この関数は、ゲーム セッションのカスタム プロパティの値を JSON 文字列として設定します。カスタム プロパティはいつでも変更できます。カスタム プロパティが複数のデバイス間で共有されている場合、または複数のデバイスによって同時に更新される可能性がある場合は、この関数を使用することで、それらのカスタム プロパティの値を変更する際の原子性を保証し、デバイス間の競合を解決できます。カスタム プロパティが複数のデバイス間で共有されていない場合は、代わりに XblMultiplayerManagerGameSessionSetProperties 関数を使用して、そのカスタム プロパティの値を変更してください。
競合が原因でレース条件が発生した場合、サービスはカスタム プロパティの変更リクエストを拒否することがあります。リクエストが拒否された場合、サービスは HTTP_E_STATUS_PRECOND_FAILED を返します。競合が発生した場合、カスタム プロパティを変更する必要性を再評価し、必要に応じてこの関数を再度呼び出してリクエストを再送信します。
この関数の結果は、イベント タイプが XblMultiplayerEventType::SessionSynchronizedPropertyWriteCompleted に設定されたマルチプレイヤー イベントとして配信されます。XblMultiplayerManagerDoWork を呼び出してマルチプレイヤー イベントを取得できます。

要件

ヘッダー: multiplayer_manager_c.h ライブラリ: Microsoft.Xbox.Services.14x.GDK.C.lib

関連項目

multiplayer_manager_c
XblMultiplayerManagerGameSessionSetSynchronizedHost
XblMultiplayerEvent
最終更新日 2026年8月13日