EOS_UserInfo_CopyExternalUserInfoByAccountType

EOS API reference page for EOS_UserInfo_CopyExternalUserInfoByAccountType

Choose your implementation method:

C

C#

This function is part of the [UserInfo Interface](Interfaces/UserInfo).

Remarks

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

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

EOS_UserInfo_CopyExternalUserInfoByAccountType

Parameter Type And Name

Usage Information

EOS_HUserInfo Handle

const EOS_UserInfo_CopyExternalUserInfoByAccountTypeOptions* Options

Structure containing the account type 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

This function is part of the [UserInfo Interface](Interfaces/UserInfo).

Remarks

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

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

UserInfo.UserInfoInterface.CopyExternalUserInfoByAccountType

Parameter Type And Name

Usage Information

CopyExternalUserInfoByAccountTypeOptions options

Structure containing the account type being accessed

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. 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