XblMultiplayerManagerLobbySessionCorrelationId

Article
06/22/2023

Retrieves the correlation handle for the lobby session.

Syntax

HRESULT XblMultiplayerManagerLobbySessionCorrelationId(  
         XblGuid* correlationId  
)

Parameters

correlationId _Out_
Type: XblGuid*

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

Return value

Type: HRESULT

HRESULT return code for this API operation.

Remarks

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

Requirements

Header: multiplayer_manager_c.h

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

Share via