EOS API reference page for EOS_Sessions_DestroySession

2 분 소요

This function is part of the Sessions Interface.


Destroy a session given a session name

Return Value

  • EOS_Success if the destroy completes successfully

  • EOS_InvalidParameters if any of the options are incorrect

  • EOS_AlreadyPending if the session is already marked for destroy

  • EOS_NotFound if a session to be destroyed does not exist



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

Callback Function Information

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

Callback Remarks

Function prototype definition for callbacks passed to EOS_Sessions_DestroySession

Callback Parameters


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