This function is part of the Leaderboards Interface.
Remarks
Query for a list of existing leaderboards definitions including their attributes.
Return Value
EOS_Success if the operation completes successfully
EOS_InvalidParameters if any of the options are incorrect
Parameters
|
Parameter Type And Name |
Usage Information |
|---|---|
|
EOS_HLeaderboards Handle |
|
|
const EOS_Leaderboards_QueryLeaderboardDefinitionsOptions* Options |
Structure containing information about the application whose leaderboard definitions we're retrieving. |
|
void* ClientData |
Arbitrary data that is passed back to you in the CompletionDelegate. |
|
const EOS_Leaderboards_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 void* 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.
Callback Function Information
Because this function is asynchronous, it employs a callback of type EOS_Leaderboards_OnQueryLeaderboardDefinitionsCompleteCallback to report the results of its operation. See the EOS_Leaderboards_OnQueryLeaderboardDefinitionsCompleteCallbackInfo page for more details, or check the Callback Data section below.
Callback Remarks
Function prototype definition for callbacks passed to EOS_Leaderboards_QueryLeaderboardDefinitions
Callback Parameters
|
Parameter Type And Name |
Usage Information |
|---|---|
|
const EOS_Leaderboards_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:
EOS_Leaderboards_OnQueryLeaderboardDefinitionsCompleteCallbackInfo
|
Property |
Value |
|---|---|
|
EOS_EResult ResultCode |
The EOS_EResult code for the operation. EOS_Success indicates that the operation succeeded; other codes indicate errors. |
|
void* ClientData |
Context that was passed into EOS_Leaderboards_QueryLeaderboardDefinitions. |
For more information, see the EOS_Leaderboards_OnQueryLeaderboardDefinitionsCompleteCallbackInfo page.