Edit

Share via

PFMatchmakingTicketGetTicketId

  • Article

Provides the ticket ID.

Syntax

HRESULT PFMatchmakingTicketGetTicketId(  
    PFMatchmakingTicketHandle ticket,  
    const char** id  
)

Parameters

ticket   PFMatchmakingTicketHandle

The handle of the matchmaking ticket.

id   char**
library-allocated output

The ticket ID.

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

The ticket ID will be an empty string if it has not yet been set. This can occur under one of the following conditions:

  • The ticket is in the PFMatchmakingTicketStatus::Creating state
  • The ticket is in the PFMatchmakingTicketStatus::Failed state due to failure to submit a ticket to the matchmaking service
  • The ticket was canceled before it could be submitted to the matchmaking service

Requirements

Header: PFMatchmaking.h

See also

PFMatchmaking members