EOS_Leaderboards_CopyLeaderboardUserScoreByIndex

EOS API reference page for EOS_Leaderboards_CopyLeaderboardUserScoreByIndex

Choose your implementation method:

C

C#

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 Name

Usage Information

EOS_HLeaderboards Handle

const EOS_Leaderboards_CopyLeaderboardUserScoreByIndexOptions* Options

Structure containing the index being accessed.

EOS_Leaderboards_LeaderboardUserScore** OutLeaderboardUserScore

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

Related API Members

This function is part of the Leaderboards Interface.

Remarks

Fetches leaderboard user score from a given index. {Result.InvalidParameters} if you pass a null pointer for the out parameter {Result.NotFound} if the leaderboard user scores are not found

Return Value

{Result.Success} if the leaderboard scores are available and passed out in OutLeaderboardUserScore

See Also

{Release}

Parameters

Leaderboards.LeaderboardsInterface.CopyLeaderboardUserScoreByIndex

Parameter Type And Name

Usage Information

CopyLeaderboardUserScoreByIndexOptions options

Structure containing the index being accessed.

LeaderboardUserScore outLeaderboardUserScore

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