EOS_Sessions_DestroySession

EOS API reference page for EOS_Sessions_DestroySession

This function is part of the Sessions Interface.

Remarks

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

Parameters

Parameter Type And Name

Usage Information

EOS_HSessions Handle

const EOS_Sessions_DestroySessionOptions* Options

Structure containing information about the session to be destroyed

void* ClientData

Arbitrary data that is passed back to you in the CompletionDelegate

const EOS_Sessions_OnDestroySessionCallback CompletionDelegate

A callback that is fired when the destroy 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_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 Name

Usage Information

const EOS_Sessions_DestroySessionCallbackInfo* Data

A EOS_Sessions_DestroySessionCallbackInfo containing the output information and result

Related API Members