EOS_Leaderboards_CopyLeaderboardDefinitionByIndex

EOS API reference page for EOS_Leaderboards_CopyLeaderboardDefinitionByIndex

Choose your implementation method:

C

C#

This function is part of the [Leaderboards Interface](Interfaces/Leaderboards).

Remarks

Fetches a leaderboard definition from the cache using an index.

Return Value

  • EOS_Success if the information is available and passed out in OutLeaderboardDefinition

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

  • EOS_NotFound if the leaderboard is not found

See Also

EOS_Leaderboards_Definition_Release

Parameters

EOS_Leaderboards_CopyLeaderboardDefinitionByIndex

Parameter Type And Name

Usage Information

EOS_HLeaderboards Handle

const EOS_Leaderboards_CopyLeaderboardDefinitionByIndexOptions* Options

Structure containing the index being accessed.

EOS_Leaderboards_Definition** OutLeaderboardDefinition

The leaderboard data for the given index, if it exists and is valid, use EOS_Leaderboards_Definition_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](Interfaces/Leaderboards).

Remarks

Fetches a leaderboard definition from the cache using an index.

Return Value

  • EOS_Success if the information is available and passed out in OutLeaderboardDefinition

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

  • EOS_NotFound if the leaderboard is not found

See Also

EOS_Leaderboards_Definition_Release

Parameters

Leaderboards.LeaderboardsInterface.CopyLeaderboardDefinitionByIndex

Parameter Type And Name

Usage Information

CopyLeaderboardDefinitionByIndexOptions options

Structure containing the index being accessed.

Definition outLeaderboardDefinition

The leaderboard data for the given index, if it exists and is valid, use EOS_Leaderboards_Definition_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