XblMultiplayerEventArgsMembers

Article
06/22/2023

Retrieves additional information for XblMultiplayerEventType::MemberJoined and XblMultiplayerEventType::MemberLeft events.

Syntax

HRESULT XblMultiplayerEventArgsMembers(  
         XblMultiplayerEventArgsHandle argsHandle,  
         size_t membersCount,  
         XblMultiplayerManagerMember* members  
)

Parameters

argsHandle _In_
Type: XblMultiplayerEventArgsHandle

The event arguments handle for the multiplayer event.

membersCount _In_
Type: size_t

The size of the members array.

members _Out_writes_(membersCount)
Type: XblMultiplayerManagerMember*

A caller-allocated array that passes back a list of members, depending on the multiplayer event:
XblMultiplayerEventType::MemberJoined - A list of members that joined the game.
XblMultiplayerEventType::MemberLeft - A list of members that left the game.

Return value

Type: HRESULT

HRESULT return code for this API operation.

Remarks

Call the XblMultiplayerEventArgsMembersCount function before you call this function, to return the size of the array you must allocate for the members parameter of this function.
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