EOS_Auth_Logout

EOS API reference page for EOS_Auth_Logout

Choose your implementation method:

C

C#

This function is part of the Auth Interface.

Remarks

Signs the player out of the online service.

Parameters

EOS_Auth_Logout

Parameter Type And Name

Usage Information

EOS_HAuth Handle

const EOS_Auth_LogoutOptions* Options

structure containing information about which account to log out.

void* ClientData

arbitrary data that is passed back to you in the CompletionDelegate

const EOS_Auth_OnLogoutCallback CompletionDelegate

a callback that is fired when the logout 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_Auth_OnLogoutCallback to report the results of its operation.

Callback Remarks

Function prototype definition for callbacks passed to EOS_Auth_Logout

Callback Parameters

EOS_Auth_OnLogoutCallback

Parameter Type And Name

Usage Information

const EOS_Auth_LogoutCallbackInfo* Data

A EOS_Auth_LogoutCallbackInfo containing the output information and result

Related API Members

This function is part of the Auth Interface.

Remarks

Signs the player out of the online service.

Parameters

Auth.AuthInterface.Logout

Parameter Type And Name

Usage Information

LogoutOptions options

structure containing information about which account to log out.

object clientData

arbitrary data that is passed back to you in the CompletionDelegate

OnLogoutCallback completionDelegate

a callback that is fired when the logout 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 Auth.OnLogoutCallback to report the results of its operation.

Callback Remarks

Function prototype definition for callbacks passed to {AuthInterface.Logout}

Callback Parameters

Auth.OnLogoutCallback

Parameter Type And Name

Usage Information

LogoutCallbackInfo data

A EOS_Auth_LogoutCallbackInfo containing the output information and result

Related API Members

Tags