This function is part of the Leaderboards Interface.
Fetches a leaderboard definition from the cache using a leaderboard ID.
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 data is not found
See Also
EOS_Leaderboards_Definition_Release
Parameters
EOS_Leaderboards_CopyLeaderboardDefinitionByLeaderboardId
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.
This function is part of the Leaderboards Interface.
Fetches a leaderboard definition from the cache using a leaderboard ID.
{Result.InvalidParameters} if you pass a null pointer for the out parameter
{Result.NotFound} if the leaderboard data is not found
Return Value
{Result.Success} if the information is available and passed out in OutLeaderboardDefinition
See Also
{Release}
Parameters
Leaderboards.LeaderboardsInterface.CopyLeaderboardDefinitionByLeaderboardId
|
Parameter Type And Name
|
Usage Information
|
|
CopyLeaderboardDefinitionByLeaderboardIdOptions options
|
Structure containing the leaderboard ID being accessed.
|
|
Definition outLeaderboardDefinition
|
The leaderboard definition for the given leaderboard ID, 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.
Was this document useful?
Thank you for the response!
You’ve marked this document as useful:
yes
You’ve marked this document as not useful:
no