This function is part of the Sessions Interface.
Mark a session as started, making it unable to find if session properties indicate "join in progress" is not available
{Result.InvalidParameters} if any of the options are incorrect
{Result.SessionsOutOfSync} if the session is out of sync and will be updated on the next connection with the backend
{Result.NotFound} if a session to be started does not exist
Return Value
{Result.Success} if the start completes successfully
Parameters
Sessions.SessionsInterface.StartSession
Parameter Type And Name
|
Usage Information
|
StartSessionOptions options
|
Structure containing information about the session to be started
|
object clientData
|
Arbitrary data that is passed back to you in the CompletionDelegate
|
OnStartSessionCallback completionDelegate
|
A callback that is fired when the start 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 object
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.
Because this function is asynchronous, it employs a callback of type Sessions.OnStartSessionCallback to report the results of its operation.
Function prototype definition for callbacks passed to {SessionsInterface.StartSession}
Callback Parameters
Sessions.OnStartSessionCallback
Parameter Type And Name
|
Usage Information
|
StartSessionCallbackInfo data
|
A EOS_Sessions_StartSessionCallbackInfo containing the output information and result
|