EOS API reference page for EOS_Leaderboards_CopyLeaderboardRecordByIndex


This function is part of the Leaderboards Interface.


Fetches a leaderboard record from a given index.

Return Value

  • EOS_Success if the leaderboard record is available and passed out in OutLeaderboardRecord

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

  • EOS_NotFound if the leaderboard is not found

See Also




Parameter Type And NameUsage Information
EOS_HLeaderboards Handle
const EOS_Leaderboards_CopyLeaderboardRecordByIndexOptions* OptionsStructure containing the index being accessed.
EOS_Leaderboards_LeaderboardRecord** OutLeaderboardRecordThe leaderboard record for the given index, if it exists and is valid, use EOS_Leaderboards_LeaderboardRecord_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.