This function is part of the [Lobby Interface](Interfaces/Lobby).
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
Parameters
EOS_Lobby_LeaveLobby
|
Parameter Type And Name
|
Usage Information
|
|
EOS_HLobby Handle
|
|
|
const EOS_Lobby_LeaveLobbyOptions* Options
|
Structure containing information about the lobby to be left
|
|
void* ClientData
|
Arbitrary data that is passed back to you in the CompletionDelegate
|
|
const EOS_Lobby_OnLeaveLobbyCallback CompletionDelegate
|
A callback that is fired when the leave operation completes, either successfully or in error
|
This function is asynchronous; the EOS SDK guarantees that your callback (the CompletionDelegate parameter) will run when the operation completes, regardless of whether it succeeds or fails. Use the void* parameter to pass any contextual information the callback may need in order to react properly. Relevant information can be copied from the EOS SDK's cache while the callback function is running. You do not need to remove the callback function.
Because this function is asynchronous, it employs a callback of type EOS_Lobby_OnLeaveLobbyCallback to report the results of its operation.
Function prototype definition for callbacks passed to EOS_Lobby_LeaveLobby
Callback Parameters
EOS_Lobby_OnLeaveLobbyCallback
|
Parameter Type And Name
|
Usage Information
|
|
const EOS_Lobby_LeaveLobbyCallbackInfo* Data
|
A EOS_Lobby_LeaveLobby CallbackInfo containing the output information and result
|
This function is part of the [Lobby Interface](Interfaces/Lobby).
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
Parameters
Lobby.LobbyInterface.LeaveLobby
|
Parameter Type And Name
|
Usage Information
|
|
LeaveLobbyOptions options
|
Structure containing information about the lobby to be left
|
|
object clientData
|
Arbitrary data that is passed back to you in the CompletionDelegate
|
|
OnLeaveLobbyCallback completionDelegate
|
A callback that is fired when the leave operation completes, either successfully or in error
|
This function is asynchronous; the EOS SDK guarantees that your callback (the CompletionDelegate parameter) will run when the operation completes, regardless of whether it succeeds or fails. Use the void* parameter to pass any contextual information the callback may need in order to react properly. Relevant information can be copied from the EOS SDK's cache while the callback function is running. You do not need to remove the callback function.
Because this function is asynchronous, it employs a callback of type EOS_Lobby_OnLeaveLobbyCallback to report the results of its operation.
Function prototype definition for callbacks passed to EOS_Lobby_LeaveLobby
Callback Parameters
Lobby.OnLeaveLobbyCallback
|
Parameter Type And Name
|
Usage Information
|
|
LeaveLobbyCallbackInfo data
|
A EOS_Lobby_LeaveLobby CallbackInfo containing the output information and result
|
Was this document useful?
Thank you for the response!
You’ve marked this document as useful:
yes
You’ve marked this document as not useful:
no