EOS API reference page for EOS_Sessions_StartSession

3 分で読めます

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

Return Value

  • EOS_Success if the start completes successfully

  • EOS_InvalidParameters if any of the options are incorrect

  • EOS_Sessions_OutOfSync if the session is out of sync and will be updated on the next connection with the backend

  • EOS_NotFound if a session to be started does not exist



Parameter Type And NameUsage Information
EOS_HSessions Handle
const EOS_Sessions_StartSessionOptions* OptionsStructure containing information about the session to be started
void* ClientDataArbitrary data that is passed back to you in the CompletionDelegate
const EOS_Sessions_OnStartSessionCallback CompletionDelegateA callback that is fired when the start operation completes, either successfully or in error

Callback Function Information

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

Callback Remarks

Function prototype definition for callbacks passed to EOS_Sessions_StartSession

Callback Parameters


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