Edit

Share via

PFLobbyServerDeleteLobby

  • Article

Delete a lobby on behalf of the game_server entity that owns the lobby.

Syntax

HRESULT PFLobbyServerDeleteLobby(  
    PFLobbyHandle lobby,  
    void* asyncContext  
)

Parameters

lobby   PFLobbyHandle

TBD

asyncContext   void*
optional

TBD

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

To use this feature, you must define PFMULTIPLAYER_INCLUDE_SERVER_APIS before including PFLobby.h.

This method queues an asynchronous operation to delete the lobby on behalf of the game_server entity. On completion, a PFLobbyServerDeleteLobbyCompletedStateChange will be provided indicating that the operation has completed.

This method does not guarantee the delete will succeed. The operation may fail due to networking or service errors. If the delete attempt fails but is retriable, the library will continue to retry the delete operation. Once the operation can no longer be retried, the operation will complete and a PFLobbyServerDeleteLobbyCompletedStateChange will be provided.

Requirements

Header: PFLobby.h

See also

PFLobby members