XblMultiplayerManagerLobbySessionSetProperties

Article
11/05/2024

Sets the value of a custom property for the lobby session.

Syntax

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

Parameters

name _In_z_
Type: char*

The name of the custom property to set.

valueJson _In_z_
Type: char*

The value to assign to the property, as a JSON string.

context _In_opt_
Type: void*

Optional. The application-defined data to correlate the XblMultiplayerEvent to the initiating call.

Return value

Type: HRESULT

HRESULT return code for this API operation.

Remarks

This function sets the value, represented as a JSON string, of a custom property for the lobby session. Custom properties can be changed at any time. Changes are batched and written to the service when XblMultiplayerManagerDoWork is called. If custom properties are shared between devices, or may be updated by several devices at the same time, use the XblMultiplayerManagerLobbySessionSetSynchronizedProperties function to change custom properties. Otherwise, you can use this function to change custom properties.
The result of this function is delivered as a multiplayer event with an event type set to XblMultiplayerEventType::SessionPropertyWriteCompleted. You can call XblMultiplayerManagerDoWork to retrieve multiplayer events.

Requirements

Header: multiplayer_manager_c.h

Library: Microsoft.Xbox.Services.14x.GDK.C.lib

Share via