EOS_Connect_CopyIdToken

EOS API reference page for EOS_Connect_CopyIdToken

1 min to read

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 NameUsage Information
EOS_HConnect Handle
const EOS_Connect_CopyIdTokenOptions* OptionsStructure containing information about the ID token to copy.
EOS_Connect_IdToken** OutIdTokenThe 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.