XblMultiplayerEventArgsPropertiesJson

Article
06/22/2023

Retrieves additional information for XblMultiplayerEventType::MemberPropertyChanged and XblMultiplayerEventType::SessionPropertyChanged events.

Syntax

HRESULT XblMultiplayerEventArgsPropertiesJson(  
         XblMultiplayerEventArgsHandle argsHandle,  
         const char** properties  
)

Parameters

argsHandle _In_
Type: XblMultiplayerEventArgsHandle

The event arguments handle for the multiplayer event.

properties _Out_
Type: char**

A pointer to a JSON string, depending on the multiplayer event:
XblMultiplayerEventType::MemberPropertyChanged - The JSON string of the member property that changed.
XblMultiplayerEventType::SessionPropertyChanged - The JSON string of the session property that changed.
The memory for the pointer remains valid for the life of the XblMultiplayerEventArgsHandle object, until the handle is closed.

Return value

Type: HRESULT

HRESULT return code for this API operation.

Remarks

Call this function to get more information about multiplayer events returned by xblMultiplayerManagerDoWork for which the EventType member of the XblMultiplayerEvent for a multiplayer event is set to either XblMultiplayerEventType::MemberPropertyChanged or XblMultiplayerEventType::SessionPropertyChanged.
The event arguments handle for a multiplayer event can be retrieved from the EventArgsHandle member of the XblMultiplayerEvent structure for that multiplayer event.
For more information about multiplayer events, see Multiplayer Manager API overview.

Requirements

Header: multiplayer_manager_c.h

Library: Microsoft.Xbox.Services.141.GSDK.C.lib

Share via