EOS API reference page for EOS_Lobby_DestroyLobby

2 분 소요

This function is part of the Lobby Interface.


Destroy a lobby given a lobby ID

Return Value

  • EOS_Success if the destroy completes successfully

  • EOS_InvalidParameters if any of the options are incorrect

  • EOS_AlreadyPending if the lobby is already marked for destroy

  • EOS_NotFound if the lobby to be destroyed does not exist



Parameter Type And NameUsage Information
EOS_HLobby Handle
const EOS_Lobby_DestroyLobbyOptions* OptionsStructure containing information about the lobby to be destroyed
void* ClientDataArbitrary data that is passed back to you in the CompletionDelegate
const EOS_Lobby_OnDestroyLobbyCallback CompletionDelegateA callback that is fired when the destroy operation completes, either successfully or in error

Callback Function Information

Because this function is asynchronous, it employs a callback of type EOS_Lobby_OnDestroyLobbyCallback to report the results of its operation.

Callback Remarks

Function prototype definition for callbacks passed to EOS_Lobby_DestroyLobby

Callback Parameters


Parameter Type And NameUsage Information
const EOS_Lobby_DestroyLobbyCallbackInfo* DataA EOS_Lobby_DestroyLobby CallbackInfo containing the output information and result