EOS_Sessions_JoinSession

EOS API reference page for EOS_Sessions_JoinSession

Choose your implementation method:

C

C#

This function is part of the [Sessions Interface](Interfaces/Sessions).

Remarks

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

Parameters

EOS_Sessions_JoinSession

Parameter Type And Name

Usage Information

EOS_HSessions Handle

const EOS_Sessions_JoinSessionOptions* Options

Structure containing information about the session to be joined

void* ClientData

Arbitrary data that is passed back to you in the CompletionDelegate

const EOS_Sessions_OnJoinSessionCallback CompletionDelegate

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

Callback Remarks

Function prototype definition for callbacks passed to EOS_Sessions_JoinSession

Callback Parameters

EOS_Sessions_OnJoinSessionCallback

Parameter Type And Name

Usage Information

const EOS_Sessions_JoinSessionCallbackInfo* Data

A EOS_Sessions_JoinSessionCallbackInfo containing the output information and result

Related API Members

This function is part of the [Sessions Interface](Interfaces/Sessions).

Remarks

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

Parameters

Sessions.SessionsInterface.JoinSession

Parameter Type And Name

Usage Information

JoinSessionOptions options

Structure containing information about the session to be joined

object clientData

Arbitrary data that is passed back to you in the CompletionDelegate

OnJoinSessionCallback completionDelegate

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

Callback Remarks

Function prototype definition for callbacks passed to EOS_Sessions_JoinSession

Callback Parameters

Sessions.OnJoinSessionCallback

Parameter Type And Name

Usage Information

JoinSessionCallbackInfo data

A EOS_Sessions_JoinSessionCallbackInfo containing the output information and result

Related API Members