EOS_Leaderboards_CopyLeaderboardUserScoreByIndex

EOS API reference page for EOS_Leaderboards_CopyLeaderboardUserScoreByIndex

1 min to read

This function is part of the Leaderboards Interface.

Remarks

Fetches leaderboard user score from a given index.

Return Value

  • EOS_Success if the leaderboard scores are available and passed out in OutLeaderboardUserScore

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

  • EOS_NotFound if the leaderboard user scores are not found

See Also

EOS_Leaderboards_LeaderboardUserScore_Release

Parameters

EOS_Leaderboards_CopyLeaderboardUserScoreByIndex

Parameter Type And NameUsage Information
EOS_HLeaderboards Handle
const EOS_Leaderboards_CopyLeaderboardUserScoreByIndexOptions* OptionsStructure containing the index being accessed.
EOS_Leaderboards_LeaderboardUserScore** OutLeaderboardUserScoreThe leaderboard user score for the given index, if it exists and is valid, use EOS_Leaderboards_LeaderboardUserScore_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.