EOS API reference page for EOS_Auth_LinkAccount

This function is part of the Auth Interface.


Link external account by continuing previous login attempt with a continuance token. On Desktop and Mobile platforms, the user will be presented the Epic Account Portal to resolve their identity. On Console, the user will login to their Epic Account using an external device, e.g. a mobile device or a desktop PC, by browsing to the presented authentication URL and entering the device code presented by the game on the console. On success, the user will be logged in at the completion of this action. This will commit this external account to the Epic Account and cannot be undone in the SDK.


Parameter Type And Name

Usage Information

EOS_HAuth Handle

const EOS_Auth_LinkAccountOptions* Options

structure containing the account credentials to use during the link account operation

void* ClientData

arbitrary data that is passed back to you in the CompletionDelegate

const EOS_Auth_OnLinkAccountCallback CompletionDelegate

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

Callback Remarks

Function prototype definition for callbacks passed to EOS_Auth_LinkAccount

Callback Parameters

Parameter Type And Name

Usage Information

const EOS_Auth_LinkAccountCallbackInfo* Data

A EOS_Auth_LinkAccountCallbackInfo containing the output information and result

Related API Members