EOS_Sessions_EndSession

EOS API reference page for EOS_Sessions_EndSession

3 分で読めます

This function is part of the Sessions Interface.

Remarks

Mark a session as ended, making it available to find if "join in progress" was disabled. The session may be started again if desired

Return Value

  • EOS_Success if the end 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 ended does not exist

Parameters

EOS_Sessions_EndSession

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

Callback Function Information

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

Callback Remarks

Function prototype definition for callbacks passed to EOS_Sessions_EndSession

Callback Parameters

EOS_Sessions_OnEndSessionCallback

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