EOS_Achievements_CopyUnlockedAchievementByIndex

EOS API reference page for EOS_Achievements_CopyUnlockedAchievementByIndex

Choose your implementation method:

C

C#

This function is part of the Achievements Interface.

Remarks

DEPRECATED! Use EOS_Achievements_CopyPlayerAchievementByAchievementId instead. Fetches an unlocked achievement from a given index.

Return Value

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

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

  • EOS_NotFound if the unlocked achievement is not found

See Also

EOS_Achievements_UnlockedAchievement_Release

Parameters

EOS_Achievements_CopyUnlockedAchievementByIndex

Parameter Type And Name

Usage Information

EOS_HAchievements Handle

const EOS_Achievements_CopyUnlockedAchievementByIndexOptions* Options

Structure containing the Product User ID and index being accessed

EOS_Achievements_UnlockedAchievement** OutAchievement

The unlocked achievement data for the given index, if it exists and is valid, use EOS_Achievements_UnlockedAchievement_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 {CopyPlayerAchievementByAchievementId} instead. Fetches an unlocked achievement from a given index. {Result.InvalidParameters} if you pass a null pointer for the out parameter {Result.NotFound} if the unlocked achievement is not found

Return Value

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

See Also

{Release}

Parameters

Achievements.AchievementsInterface.CopyUnlockedAchievementByIndex

Parameter Type And Name

Usage Information

CopyUnlockedAchievementByIndexOptions options

Structure containing the Product User ID and index being accessed

UnlockedAchievement outAchievement

The unlocked achievement data for the given index, if it exists and is valid, use EOS_Achievements_UnlockedAchievement_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.