EOS_Achievements_CopyAchievementDefinitionByAchievementId

EOS API reference page for EOS_Achievements_CopyAchievementDefinitionByAchievementId

Choose your implementation method:

C

C#

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 Name

Usage Information

EOS_HAchievements Handle

const EOS_Achievements_CopyAchievementDefinitionByAchievementIdOptions* Options

Structure containing the achievement ID being accessed

EOS_Achievements_Definition** OutDefinition

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

This function is part of the Achievements Interface.

Remarks

DEPRECATED! Use {CopyAchievementDefinitionV2ByAchievementId} instead. Fetches an achievement definition from a given achievement ID. {Result.InvalidParameters} if you pass a null pointer for the out parameter {Result.NotFound} if the achievement definition is not found

Return Value

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

See Also

{Release}, {CopyAchievementDefinitionV2ByAchievementId}

Parameters

Achievements.AchievementsInterface.CopyAchievementDefinitionByAchievementId

Parameter Type And Name

Usage Information

CopyAchievementDefinitionByAchievementIdOptions options

Structure containing the achievement ID being accessed

Definition outDefinition

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