PFMultiplayerJoinArrangedLobby
Joins a lobby using an arrangement string provided by another service, such as matchmaking. If no one has joined the lobby yet, the lobby is initialized using the configuration parameters.
Syntax
HRESULT PFMultiplayerJoinArrangedLobby(
PFMultiplayerHandle handle,
const PFEntityKey* newMember,
const char* arrangementString,
const PFLobbyArrangedJoinConfiguration* configuration,
void* asyncContext,
PFLobbyHandle* lobby
)
Parameters
handle PFMultiplayerHandle
The handle of the PFMultiplayer API instance.
newMember PFEntityKey*
The local PlayFab entity joining the lobby.
arrangementString char*
is null-terminated
The arrangement string used by the entity to join the lobby.
configuration PFLobbyArrangedJoinConfiguration*
The initial configuration data used to initialize the lobby, if no one has joined the lobby yet.
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 PFLobbyJoinArrangedLobbyCompletedStateChange with the PFLobbyJoinArrangedLobbyCompletedStateChange::result field set to S_OK. Upon a failed completion, the title will be provided a PFLobbyJoinArrangedLobbyCompletedStateChange with the PFLobbyJoinArrangedLobbyCompletedStateChange::result field set to a failure.
When using matchmaking through this library, the PFMatchmakingMatchDetails::lobbyArrangementString can be used with this method to join a lobby with all of the users that have been matched together.
Requirements
Header: PFLobby.h