EOS API reference page for EOS_Lobby_JoinLobbyById

3 mins to read

This function is part of the Lobby Interface.


This is a special case of EOS_Lobby_JoinLobby. It should only be used if the lobby has had Join-by-ID enabled. Additionally, Join-by-ID should only be enabled to support native invites on an integrated platform.

Return Value

  • EOS_Success if the destroy completes successfully

  • EOS_InvalidParameters if any of the options are incorrect

See Also




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

Callback Function Information

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

Callback Remarks

Function prototype definition for callbacks passed to EOS_Lobby_JoinLobbyById

Callback Parameters


Parameter Type And NameUsage Information
const EOS_Lobby_JoinLobbyByIdCallbackInfo* DataA EOS_Lobby_JoinLobbyById CallbackInfo containing the output information and result