PFLobbyGetConnectionString

Gets the default connection string associated with the lobby.

Syntax

HRESULT PFLobbyGetConnectionString(  
    PFLobbyHandle lobby,  
    const char** connectionString  
)  

Parameters

lobby   PFLobbyHandle

The handle of the lobby.

connectionString   char**
library-allocated output

The output connection string.

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 will return an error until PFMultiplayerStartProcessingLobbyStateChanges() provides a successful PFLobbyCreateAndJoinLobbyCompletedStateChange.

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

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

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

Requirements

Header: PFLobby.h

See also

PFLobby members