This function is part of the Leaderboards Interface.
Remarks
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
| Parameter Type And Name | Usage Information |
|---|---|
| EOS_HLeaderboards Handle | |
| const EOS_Leaderboards_CopyLeaderboardDefinitionByLeaderboardIdOptions* Options | Structure containing the leaderboard ID being accessed. |
| EOS_Leaderboards_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. Once you are finished with the data, you must release it by making the appropriate call into the EOS SDK.