EOS_Achievements_CopyPlayerAchievementByIndex

EOS API reference page for EOS_Achievements_CopyPlayerAchievementByIndex

Choose your implementation method:

C

C#

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 Name

Usage Information

EOS_HAchievements Handle

const EOS_Achievements_CopyPlayerAchievementByIndexOptions* Options

Structure containing the Product User ID and index being accessed

EOS_Achievements_PlayerAchievement** OutAchievement

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

Related API Members

This function is part of the Achievements Interface.

Remarks

Fetches a player achievement from a given index. {Result.InvalidParameters} if you pass a null pointer for the out parameter {Result.NotFound} if the player achievement is not found {Result.InvalidProductUserID} if you pass an invalid user ID

Return Value

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

See Also

{Release}

Parameters

Achievements.AchievementsInterface.CopyPlayerAchievementByIndex

Parameter Type And Name

Usage Information

CopyPlayerAchievementByIndexOptions options

Structure containing the Product User ID and index being accessed

PlayerAchievement outAchievement

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