XblMultiplayerManagerLobbySessionDeleteLocalMemberProperties

Article
06/22/2023

Deletes a custom property from a local member of the lobby session.

Syntax

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

Parameters

user _In_
Type: XblUserHandle

The user handle of the local member.

name _In_z_
Type: char*

The name of the custom property to delete.

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 deletes a custom property from a local member of 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