EOS_Auth_CopyUserAuthToken

EOS API reference page for EOS_Auth_CopyUserAuthToken

This function is part of the Auth Interface.

Remarks

Fetches a user auth token for an Epic Online Services Account ID.

Return Value

  • EOS_Success if the information is available and passed out in OutUserAuthToken

  • EOS_InvalidParameters if you pass a null pointer for the out parameter

  • EOS_NotFound if the auth token is not found or expired.

See Also

EOS_Auth_Token_Release

Parameters

Parameter Type And Name

Usage Information

EOS_HAuth Handle

const EOS_Auth_CopyUserAuthTokenOptions* Options

Structure containing the api version of CopyUserAuthToken to use

EOS_EpicAccountId LocalUserId

The Epic Online Services Account ID of the user being queried

EOS_Auth_Token** OutUserAuthToken

The auth token for the given user, if it exists and is valid; use EOS_Auth_Token_Release when finished

If successful, this function provides data to the caller through an output parameter. Once you are finished with the data, you must release it by making the appropriate call into the EOS SDK.

Related API Members