EOS API reference page for EOS_Lobby_UpdateLobby


This function is part of the Lobby Interface.


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



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

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


Parameter Type And NameUsage Information
const EOS_Lobby_UpdateLobbyCallbackInfo* DataA EOS_Lobby_UpdateLobby CallbackInfo containing the output information and result