PFMultiplayerCreateAndJoinLobby

Create a new lobby and add the creating PlayFab entity to it.

Syntax

HRESULT PFMultiplayerCreateAndJoinLobby(  
    PFMultiplayerHandle handle,  
    const PFEntityKey* creator,  
    const PFLobbyCreateConfiguration* createConfiguration,  
    const PFLobbyJoinConfiguration* joinConfiguration,  
    void* asyncContext,  
    PFLobbyHandle* lobby  
)  

Parameters

handle   PFMultiplayerHandle

The handle of the PFMultiplayer API instance.

creator   PFEntityKey*

The local PlayFab entity creating the lobby.

createConfiguration   PFLobbyCreateConfiguration*

The initial configuration data used when creating the lobby.

joinConfiguration   PFLobbyJoinConfiguration*

The initial configuration data for the member creating and joining the lobby.

asyncContext   void*
optional

An optional, app-defined, pointer-sized context value that can be used to associate the completion state change with this call.

lobby   PFLobbyHandle*
optional, library-allocated output

The optional, output lobby object which can be used to queue operations for immediate execution of this operation completes.

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

This is an asynchronous operation. Upon successful completion, the title will be provided a PFLobbyMemberAddedStateChange followed by a PFLobbyCreateAndJoinLobbyCompletedStateChange with the PFLobbyCreateAndJoinLobbyCompletedStateChange::result field set to S_OK. Upon a failed completion, the title will be provided a PFLobbyCreateAndJoinLobbyCompletedStateChange with the PFLobbyCreateAndJoinLobbyCompletedStateChange::result field set to a failure.

Requirements

Header: PFLobby.h

See also

PFLobby members