EOS_Achievements_CopyAchievementDefinitionByAchievementId

EOS API reference page for EOS_Achievements_CopyAchievementDefinitionByAchievementId

1 min to read

This function is part of the Achievements Interface.

Remarks

DEPRECATED! Use EOS_Achievements_CopyAchievementDefinitionV2ByAchievementId instead. Fetches an achievement definition from a given achievement ID.

Return Value

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

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

  • EOS_NotFound if the achievement definition is not found

See Also

EOS_Achievements_Definition_Release, EOS_Achievements_CopyAchievementDefinitionV2ByAchievementId

Parameters

EOS_Achievements_CopyAchievementDefinitionByAchievementId

Parameter Type And NameUsage Information
EOS_HAchievements Handle
const EOS_Achievements_CopyAchievementDefinitionByAchievementIdOptions* OptionsStructure containing the achievement ID being accessed
EOS_Achievements_Definition** OutDefinitionThe achievement definition for the given achievement ID, if it exists and is valid, use EOS_Achievements_Definition_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.

  • EOS_EResult