This function is part of the Leaderboards Interface.
Query for a list of scores for a given list of users.
Return Value
Parameters
Leaderboards.LeaderboardsInterface.QueryLeaderboardUserScores
Parameter Type And Name
|
Usage Information
|
QueryLeaderboardUserScoresOptions options
|
Structure containing information about the users whose scores we're retrieving.
|
object clientData
|
Arbitrary data that is passed back to you in the CompletionDelegate.
|
OnQueryLeaderboardUserScoresCompleteCallback 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.
Because this function is asynchronous, it employs a callback of type EOS_Leaderboards_OnQueryLeaderboardUserScoresCompleteCallback to report the results of its operation. See the EOS_Leaderboards_OnQueryLeaderboardUserScoresCompleteCallbackInfo page for more details, or check the Callback Data section below.
Function prototype definition for callbacks passed to EOS_Leaderboards_QueryLeaderboardUserScores
Callback Parameters
Leaderboards.OnQueryLeaderboardUserScoresCompleteCallback
Parameter Type And Name
|
Usage Information
|
OnQueryLeaderboardUserScoresCompleteCallbackInfo data
|
A EOS_Leaderboards_OnQueryLeaderboardUserScoresCompleteCallbackInfo containing the output information and result
|
Callback Data
The EOS SDK passes the following data structure to the callback function:
Leaderboards.OnQueryLeaderboardUserScoresCompleteCallbackInfo
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_QueryLeaderboardUserScores.
|
For more information, see the EOS_Leaderboards_OnQueryLeaderboardUserScoresCompleteCallbackInfo page.