EOS_UserInfo_CopyExternalUserInfoByAccountId

EOS API reference page for EOS_UserInfo_CopyExternalUserInfoByAccountId

This function is part of the UserInfo Interface.

Remarks

Fetches an external user info for a given external account ID.

Return Value

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

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

  • EOS_NotFound if the external user info is not found

See Also

EOS_UserInfo_ExternalUserInfo_Release

Parameters

Parameter Type And Name

Usage Information

EOS_HUserInfo Handle

const EOS_UserInfo_CopyExternalUserInfoByAccountIdOptions* Options

Structure containing the account ID being accessed

EOS_UserInfo_ExternalUserInfo** OutExternalUserInfo

The external user info. If it exists and is valid, use EOS_UserInfo_ExternalUserInfo_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