XblMultiplayerEventArgsFindMatchCompleted

Article
06/22/2023

Retrieves additional information for XblMultiplayerEventType.FindMatchCompleted multiplayer events.

Syntax

HRESULT XblMultiplayerEventArgsFindMatchCompleted(  
         XblMultiplayerEventArgsHandle argsHandle,  
         XblMultiplayerMatchStatus* matchStatus,  
         XblMultiplayerMeasurementFailure* initializationFailureCause  
)

Parameters

argsHandle _In_
Type: XblMultiplayerEventArgsHandle

The event arguments handle for the multiplayer event.

matchStatus _Out_opt_
Type: XblMultiplayerMatchStatus*

A caller-allocated structure that describes the current matchmaking status.

initializationFailureCause _Out_opt_
Type: XblMultiplayerMeasurementFailure*

A caller-allocated structure that passes back the cause of why the initialization failed, or XblMultiplayerMeasurementFailure::None if there was no failure. This value is set when transitioning out of the XblMultiplayerMatchStatus::Joining or XblMultiplayerMatchStatus::Measuring initialization stages, if this member doesn't pass the initializaton stage.

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 XblMultiplayerEventType.FindMatchCompleted.
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