Share via

XblMultiplayerManagerGameSessionCorrelationId

  • Article

Retrieves the correlation handle for the game session.

Syntax

const char* XblMultiplayerManagerGameSessionCorrelationId(  
)

Parameters

Return value

Type: const char*

The correlation handle for the game session, or null if a game session doesn't exist. The memory for the returned pointer remains valid until the next call to XblMultiplayerManagerDoWork.

Remarks

This function retrieves the correlation handle for the game session. The correlation handle serves as an alias for the game session, allowing a game to refer to a game session by using only the correlation handle. The correlation handle can be used to query trace logs for entries that relate to the game session. For more information, see Multiplayer concepts overview.

Requirements

Header: multiplayer_manager_c.h

Library: Microsoft.Xbox.Services.141.GSDK.C.lib

See also

multiplayer_manager_c
XblMultiplayerManagerGameSessionSessionReference