PFMatchmakingTicketGetMatch

Provides the match, if one has been found.

Syntax

HRESULT PFMatchmakingTicketGetMatch(  
    PFMatchmakingTicketHandle ticket,  
    const PFMatchmakingMatchDetails** match  
)  

Parameters

ticket   PFMatchmakingTicketHandle

The handle of the matchmaking ticket.

match   PFMatchmakingMatchDetails**
library-allocated output

The match that was found.

Return value

Type: HRESULT

S_OK if the call succeeded or an error code otherwise. The human-readable form of the error code can be retrieved via PFMultiplayerGetErrorMessage().

Remarks

This method will fail if the ticket isn't in the PFMatchmakingTicketStatus::Matched state. The ticket state can be retrieved via PFMatchmakingTicketGetStatus.

Requirements

Header: PFMatchmaking.h

See also

PFMatchmaking members