This function is part of the Lobby Interface.
Remarks
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
Parameters
EOS_Lobby_JoinLobbyById
Parameter Type And Name | Usage Information |
---|---|
EOS_HLobby Handle | |
const EOS_Lobby_JoinLobbyByIdOptions* Options | Structure containing information about the lobby to be joined |
void* ClientData | Arbitrary data that is passed back to you in the CompletionDelegate |
const EOS_Lobby_OnJoinLobbyByIdCallback CompletionDelegate | A 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
EOS_Lobby_OnJoinLobbyByIdCallback
Parameter Type And Name | Usage Information |
---|---|
const EOS_Lobby_JoinLobbyByIdCallbackInfo* Data | A EOS_Lobby_JoinLobbyById CallbackInfo containing the output information and result |