EOS_Lobby_DestroyLobby

EOS API reference page for EOS_Lobby_DestroyLobby

Choose your implementation method:

C

C#

This function is part of the Lobby Interface.

Remarks

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

Parameters

EOS_Lobby_DestroyLobby

Parameter Type And Name

Usage Information

EOS_HLobby Handle

const EOS_Lobby_DestroyLobbyOptions* Options

Structure containing information about the lobby to be destroyed

void* ClientData

Arbitrary data that is passed back to you in the CompletionDelegate

const EOS_Lobby_OnDestroyLobbyCallback CompletionDelegate

A callback that is fired when the destroy 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.

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

EOS_Lobby_OnDestroyLobbyCallback

Parameter Type And Name

Usage Information

const EOS_Lobby_DestroyLobbyCallbackInfo* Data

A EOS_Lobby_DestroyLobby CallbackInfo containing the output information and result

Related API Members

This function is part of the Lobby Interface.

Remarks

Destroy a lobby given a lobby ID {Result.InvalidParameters} if any of the options are incorrect {Result.AlreadyPending} if the lobby is already marked for destroy {Result.NotFound} if the lobby to be destroyed does not exist

Return Value

{Result.Success} if the destroy completes successfully

Parameters

Lobby.LobbyInterface.DestroyLobby

Parameter Type And Name

Usage Information

DestroyLobbyOptions options

Structure containing information about the lobby to be destroyed

object clientData

Arbitrary data that is passed back to you in the CompletionDelegate

OnDestroyLobbyCallback completionDelegate

A callback that is fired when the destroy 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 object 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.

Callback Function Information

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

Callback Remarks

Function prototype definition for callbacks passed to {LobbyInterface.DestroyLobby}

Callback Parameters

Lobby.OnDestroyLobbyCallback

Parameter Type And Name

Usage Information

DestroyLobbyCallbackInfo data

A EOS_Lobby_DestroyLobby CallbackInfo containing the output information and result

Related API Members

Tags