EOS_Sessions_EndSession

EOS API reference page for EOS_Sessions_EndSession

Choose your implementation method:

C

C#

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 Name

Usage Information

EOS_HSessions Handle

const EOS_Sessions_EndSessionOptions* Options

Structure containing information about the session to be ended

void* ClientData

Arbitrary data that is passed back to you in the CompletionDelegate

const EOS_Sessions_OnEndSessionCallback CompletionDelegate

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

Usage Information

const EOS_Sessions_EndSessionCallbackInfo* Data

A EOS_Sessions_EndSessionCallbackInfo containing the output information and result

Related API Members

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 {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 ended does not exist

Return Value

{Result.Success} if the end completes successfully

Parameters

Sessions.SessionsInterface.EndSession

Parameter Type And Name

Usage Information

EndSessionOptions options

Structure containing information about the session to be ended

object clientData

Arbitrary data that is passed back to you in the CompletionDelegate

OnEndSessionCallback completionDelegate

A callback that is fired when the end 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.

Callback Function Information

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

Callback Remarks

Function prototype definition for callbacks passed to {SessionsInterface.EndSession}

Callback Parameters

Sessions.OnEndSessionCallback

Parameter Type And Name

Usage Information

EndSessionCallbackInfo data

A EOS_Sessions_EndSessionCallbackInfo containing the output information and result

Related API Members