EOS_Leaderboards_QueryLeaderboardUserScores

EOS API reference page for EOS_Leaderboards_QueryLeaderboardUserScores

3 分で読める

This function is part of the Leaderboards Interface.

Remarks

Query for a list of scores for a given list of users.

Return Value

  • EOS_Success if the operation completes successfully

  • EOS_InvalidParameters if any of the options are incorrect

Parameters

EOS_Leaderboards_QueryLeaderboardUserScores

Parameter Type And NameUsage Information
EOS_HLeaderboards Handle
const EOS_Leaderboards_QueryLeaderboardUserScoresOptions* OptionsStructure containing information about the users whose scores we're retrieving.
void* ClientDataArbitrary data that is passed back to you in the CompletionDelegate.
const EOS_Leaderboards_OnQueryLeaderboardUserScoresCompleteCallback CompletionDelegateThis function is called when the query operation completes.

Callback Function Information

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.

Callback Remarks

Function prototype definition for callbacks passed to EOS_Leaderboards_QueryLeaderboardUserScores

Callback Parameters

EOS_Leaderboards_OnQueryLeaderboardUserScoresCompleteCallback

Parameter Type And NameUsage Information
const EOS_Leaderboards_OnQueryLeaderboardUserScoresCompleteCallbackInfo* DataA EOS_Leaderboards_OnQueryLeaderboardUserScoresCompleteCallbackInfo containing the output information and result

Callback Data

The EOS SDK passes the following data structure to the callback function:

EOS_Leaderboards_OnQueryLeaderboardUserScoresCompleteCallbackInfo

PropertyValue
EOS_EResult ResultCodeThe EOS_EResult code for the operation. EOS_Success indicates that the operation succeeded; other codes indicate errors.
void* ClientDataContext that was passed into EOS_Leaderboards_QueryLeaderboardUserScores.

For more information, see the EOS_Leaderboards_OnQueryLeaderboardUserScoresCompleteCallbackInfo page.