EOS_Achievements_CopyPlayerAchievementByIndex

EOS API reference page for EOS_Achievements_CopyPlayerAchievementByIndex

2 mins to read

This function is part of the Achievements Interface.

Remarks

Fetches a player 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 player achievement is not found

  • EOS_Invalid_ProductUserID if you pass an invalid user ID

See Also

EOS_Achievements_PlayerAchievement_Release

Parameters

EOS_Achievements_CopyPlayerAchievementByIndex

Parameter Type And NameUsage Information
EOS_HAchievements Handle
const EOS_Achievements_CopyPlayerAchievementByIndexOptions* OptionsStructure containing the Product User ID and index being accessed
EOS_Achievements_PlayerAchievement** OutAchievementThe player achievement data for the given index, if it exists and is valid, use EOS_Achievements_PlayerAchievement_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.