This function is part of the Leaderboards Interface.
Query for a list of existing leaderboards definitions including their attributes.
{Result.InvalidParameters} if any of the options are incorrect
Return Value
{Result.Success} if the operation completes successfully
Parameters
Leaderboards.LeaderboardsInterface.QueryLeaderboardDefinitions
Parameter Type And Name
|
Usage Information
|
QueryLeaderboardDefinitionsOptions options
|
Structure containing information about the application whose leaderboard definitions we're retrieving.
|
object clientData
|
Arbitrary data that is passed back to you in the CompletionDelegate.
|
OnQueryLeaderboardDefinitionsCompleteCallback completionDelegate
|
This function is called when the query operation completes.
|
This function is asynchronous; the EOS SDK guarantees that your callback (the CompletionDelegate
parameter) will run when the operation completes, regardless of whether it succeeds or fails. Use the object
parameter to pass any contextual information the callback may need in order to react properly. Relevant information can be copied from the EOS SDK's cache while the callback function is running. You do not need to remove the callback function.
Because this function is asynchronous, it employs a callback of type Leaderboards.OnQueryLeaderboardDefinitionsCompleteCallback to report the results of its operation. See the Leaderboards.OnQueryLeaderboardDefinitionsCompleteCallbackInfo page for more details, or check the Callback Data section below.
Function prototype definition for callbacks passed to {LeaderboardsInterface.QueryLeaderboardDefinitions}
Callback Parameters
Leaderboards.OnQueryLeaderboardDefinitionsCompleteCallback
Parameter Type And Name
|
Usage Information
|
OnQueryLeaderboardDefinitionsCompleteCallbackInfo data
|
A EOS_Leaderboards_OnQueryLeaderboardDefinitionsCompleteCallbackInfo containing the output information and result
|
Callback Data
The EOS SDK passes the following data structure to the callback function:
Leaderboards.OnQueryLeaderboardDefinitionsCompleteCallbackInfo
Property
|
Value
|
Result ResultCode
|
The EOS_EResult code for the operation. EOS_Success indicates that the operation succeeded; other codes indicate errors.
|
object ClientData
|
Context that was passed into EOS_Leaderboards_QueryLeaderboardDefinitions.
|
For more information, see the Leaderboards.OnQueryLeaderboardDefinitionsCompleteCallbackInfo page.