pflobbygetlobbyid.md

author	title	description	ms.author	ms.topic	ms.service	ms.date
ScottMunroMS	PFLobbyGetLobbyId	Gets the ID of the Lobby.	scmunro	reference	playfab	02/14/2024

PFLobbyGetLobbyId

Gets the ID of the Lobby.

Syntax

HRESULT PFLobbyGetLobbyId(  
    PFLobbyHandle lobby,  
    const char** id  
)  

Parameters

lobby   PFLobbyHandle

The handle of the lobby.

id   char**
library-allocated output

The output lobby 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

If this lobby object was created by calling PFMultiplayerCreateAndJoinLobby(), this method returns an error until PFMultiplayerStartProcessingLobbyStateChanges() provides a successful PFLobbyCreateAndJoinLobbyCompletedStateChange.

If this lobby object was created by calling PFMultiplayerJoinLobby(), this method returns an error until PFMultiplayerStartProcessingLobbyStateChanges() provides a successful PFLobbyJoinLobbyCompletedStateChange.

If this lobby object was created by calling PFMultiplayerCreateAndClaimServerLobby(), this method returns an error until PFMultiplayerStartProcessingLobbyStateChanges() provides a successful PFLobbyCreateAndClaimServerLobbyCompletedStateChange.

If this lobby object was created by calling PFMultiplayerClaimServerLobby(), this method returns an error until PFMultiplayerStartProcessingLobbyStateChanges() provides a successful PFLobbyClaimServerLobbyCompletedStateChange.

If this lobby object was created by calling PFMultiplayerJoinLobbyAsServer(), this method returns an error until PFMultiplayerStartProcessingLobbyStateChanges() provides a successful PFLobbyJoinLobbyAsServerCompletedStateChange.

Requirements

Header: PFLobby.h

See also

PFLobby members