EOS_Connect_CopyIdToken

EOS API reference page for EOS_Connect_CopyIdToken

Choose your implementation method:

C

C#

This function is part of the Connect Interface.

Remarks

Fetches an ID token for a Product User ID.

Return Value

  • EOS_Success if the information is available and passed out in OutIdToken.

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

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

See Also

EOS_Connect_IdToken_Release

Parameters

EOS_Connect_CopyIdToken

Parameter Type And Name

Usage Information

EOS_HConnect Handle

const EOS_Connect_CopyIdTokenOptions* Options

Structure containing information about the ID token to copy.

EOS_Connect_IdToken** OutIdToken

The ID token for the given user, if it exists and is valid; use EOS_Connect_IdToken_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

This function is part of the Connect Interface.

Remarks

Fetches an ID token for a Product User ID. {Result.InvalidParameters} if you pass a null pointer for the out parameter. {Result.NotFound} if the ID token is not found or expired.

Return Value

{Result.Success} if the information is available and passed out in OutIdToken.

See Also

{Release}

Parameters

Connect.ConnectInterface.CopyIdToken

Parameter Type And Name

Usage Information

CopyIdTokenOptions options

Structure containing information about the ID token to copy.

IdToken outIdToken

The ID token for the given user, if it exists and is valid; use EOS_Connect_IdToken_Release when finished.

If successful, this function provides data to the caller through an output parameter. The EOS SDK will automatically handle releasing the data when your code no longer holds any reference to it; you do not need to call a "Release" function.

Related API Members

Tags