Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
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