Edit

PFMatchmakingTicketGetCustomContext

  • Article

Retrieves the app's private, custom pointer-sized context value previously associated with this ticket object.

Syntax

HRESULT PFMatchmakingTicketGetCustomContext(  
    PFMatchmakingTicketHandle ticket,  
    void** customContext  
)

Parameters

ticket   PFMatchmakingTicketHandle

The handle of the matchmaking ticket.

customContext   void**
output, may return nullptr

The output custom context.

Return value

Type: HRESULT

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

Remarks

If no custom context has been set yet, the value pointed to by customContext is set to nullptr.

Requirements

Header: PFMatchmaking.h

See also

PFMatchmaking members
PFMatchmakingTicketSetCustomContext