EOS API reference page for EOS_Lobby_LeaveLobby

3 mins to read

This function is part of the Lobby Interface.


Leave a lobby given a lobby ID If the lobby you are leaving had an RTC Room enabled, leaving the lobby will also automatically leave the RTC room.

Return Value

  • EOS_Success if the leave completes successfully

  • EOS_InvalidParameters if any of the options are incorrect

  • EOS_AlreadyPending if the lobby is already marked for leave

  • EOS_NotFound if a lobby to be left does not exist



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

Callback Function Information

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

Callback Remarks

Function prototype definition for callbacks passed to EOS_Lobby_LeaveLobby

Callback Parameters


Parameter Type And NameUsage Information
const EOS_Lobby_LeaveLobbyCallbackInfo* DataA EOS_Lobby_LeaveLobby CallbackInfo containing the output information and result