XblMultiplayerManagerGameSessionSetSynchronizedProperties

使用 XblMultiplayerSessionWriteMode::SynchronizedUpdate 设置游戏会话的自定义属性值。

语法

HRESULT XblMultiplayerManagerGameSessionSetSynchronizedProperties(  
         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 字符串)。 可以随时更改自定义属性。 如果自定义属性在设备之间共享,或者可以由多个设备同时更新,请使用此函数以确保原子性并解决设备之间的任何冲突,同时更改这些自定义属性的值。 如果未跨设备共享自定义属性,请改用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