EOS_Lobby_UpdateLobby

EOS API reference page for EOS_Lobby_UpdateLobby

Choose your implementation method:

C

C#

This function is part of the Lobby Interface.

Remarks

Update a lobby given a lobby modification handle created by EOS_Lobby_UpdateLobbyModification

Return Value

  • EOS_Success if the update completes successfully

  • EOS_InvalidParameters if any of the options are incorrect

  • EOS_Lobby_NotOwner if the lobby modification contains modifications that are only allowed by the owner

  • EOS_NotFound if the lobby to update does not exist

Parameters

EOS_Lobby_UpdateLobby

Parameter Type And Name

Usage Information

EOS_HLobby Handle

const EOS_Lobby_UpdateLobbyOptions* Options

Structure containing information about the lobby to be updated

void* ClientData

Arbitrary data that is passed back to you in the CompletionDelegate

const EOS_Lobby_OnUpdateLobbyCallback CompletionDelegate

A callback that is fired when the update 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_OnUpdateLobbyCallback to report the results of its operation.

Callback Remarks

Function prototype definition for callbacks passed to EOS_Lobby_UpdateLobby

Callback Parameters

EOS_Lobby_OnUpdateLobbyCallback

Parameter Type And Name

Usage Information

const EOS_Lobby_UpdateLobbyCallbackInfo* Data

A EOS_Lobby_UpdateLobby CallbackInfo containing the output information and result

Related API Members

This function is part of the Lobby Interface.

Remarks

Update a lobby given a lobby modification handle created by {UpdateLobbyModification} {Result.InvalidParameters} if any of the options are incorrect {Result.LobbyNotOwner} if the lobby modification contains modifications that are only allowed by the owner {Result.NotFound} if the lobby to update does not exist

Return Value

{Result.Success} if the update completes successfully

Parameters

Lobby.LobbyInterface.UpdateLobby

Parameter Type And Name

Usage Information

UpdateLobbyOptions options

Structure containing information about the lobby to be updated

object clientData

Arbitrary data that is passed back to you in the CompletionDelegate

OnUpdateLobbyCallback completionDelegate

A callback that is fired when the update 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.OnUpdateLobbyCallback to report the results of its operation.

Callback Remarks

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

Callback Parameters

Lobby.OnUpdateLobbyCallback

Parameter Type And Name

Usage Information

UpdateLobbyCallbackInfo data

A EOS_Lobby_UpdateLobby CallbackInfo containing the output information and result

Related API Members