XblMultiplayerManagerLobbySessionSetLocalMemberProperties

Article
06/22/2023

Set a custom property for a local member to the specified JSON string.

Syntax

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

Parameters

user _In_
Type: XblUserHandle

The user you want to set the property for.

name _In_z_
Type: char*

The name of the property to set.

valueJson _In_z_
Type: char*

Optional. The JSON value to assign to the property.

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 a local member in the lobby session. Custom properties can be changed at any time. Changes are batched and written to the service when XblMultiplayerManagerDoWork is called.
The result of this function is delivered as a multiplayer event with an event type set to XblMultiplayerEventType::LocalMemberPropertyWriteCompleted. You can call XblMultiplayerManagerDoWork to retrieve multiplayer events.

Requirements

Header: multiplayer_manager_c.h

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

Share via