XblMultiplayerEventArgsMember

Article
06/22/2023

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

Syntax

HRESULT XblMultiplayerEventArgsMember(  
         XblMultiplayerEventArgsHandle argsHandle,  
         XblMultiplayerManagerMember* member  
)

Parameters

argsHandle _In_
Type: XblMultiplayerEventArgsHandle

The event arguments handle for the multiplayer event.

member _Out_
Type: XblMultiplayerManagerMember*

The applicable member, depending on the multiplayer event:
XblMultiplayerEventType::HostChanged - The new host member. If an existing host leaves, there is no new host member to return in this parameter. In this case, this function returns HRESULT_FROM_WIN32(ERROR_RESOURCE_DATA_NOT_FOUND).
XblMultiplayerEventType::MemberPropertyChanged - The member whose property changed.

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::HostChanged or XblMultiplayerEventType::MemberPropertyChanged.
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.14x.GDK.C.lib

Share via