EOS API reference page for EOS_Sessions_JoinSession

3 mins to read

This function is part of the Sessions Interface.


Join a session, creating a local session under a given session name. Backend will validate various conditions to make sure it is possible to join the session.

Return Value

  • EOS_Success if the join completes successfully

  • EOS_InvalidParameters if any of the options are incorrect

  • EOS_Sessions_SessionAlreadyExists if the session is already exists or is in the process of being joined

  • EOS_InvalidUser if the local user associated with the local session to be created does not exist or is not authenticated



Parameter Type And NameUsage Information
EOS_HSessions Handle
const EOS_Sessions_JoinSessionOptions* OptionsStructure containing information about the session to be joined
void* ClientDataArbitrary data that is passed back to you in the CompletionDelegate
const EOS_Sessions_OnJoinSessionCallback 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_Sessions_OnJoinSessionCallback to report the results of its operation.

Callback Remarks

Function prototype definition for callbacks passed to EOS_Sessions_JoinSession

Callback Parameters


Parameter Type And NameUsage Information
const EOS_Sessions_JoinSessionCallbackInfo* DataA EOS_Sessions_JoinSessionCallbackInfo containing the output information and result