Edit

Share via

PFLobbyLeave

  • Article

Request one or all local users to leave the lobby.

Syntax

HRESULT PFLobbyLeave(  
    PFLobbyHandle lobby,  
    const PFEntityKey* localUser,  
    void* asyncContext  
)

Parameters

lobby   PFLobbyHandle

The handle of the lobby.

localUser   PFEntityKey*
optional

An optional value to indicate if a specific local user should leave the lobby. If this value is nullptr, all local users will leave 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.

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 method queues an asynchronous operation to remove one or all local users from the lobby. On completion, a PFLobbyLeaveLobbyCompletedStateChange will be provided indicating that the operation has completed.

This method does not guarantee the leave will succeed. The operation may fail due to networking or service errors. If the leave attempt fails but is retriable, the library will continue to retry the leave operation. Otherwise, the local client will disconnect the requested local members from the lobby, but leave them as members. They will remain as disconnected members until they rejoin.

This method cannot be called by a game_server entity.

Requirements

Header: PFLobby.h

See also

PFLobby members