EOS API reference page for EOS_Stats_QueryStats

3 mins to read

This function is part of the Stats Interface.


Query for a list of stats for a specific player.

Return Value

  • EOS_Success if the operation completes successfully

  • EOS_InvalidParameters if any of the options are incorrect

  • EOS_InvalidUser if target user ID is missing or incorrect



Parameter Type And NameUsage Information
EOS_HStats Handle
const EOS_Stats_QueryStatsOptions* OptionsStructure containing information about the player whose stats we're retrieving.
void* ClientDataArbitrary data that is passed back to you in the CompletionDelegate
const EOS_Stats_OnQueryStatsCompleteCallback CompletionDelegateThis function is called when the query player stats operation completes.

Callback Function Information

Because this function is asynchronous, it employs a callback of type EOS_Stats_OnQueryStatsCompleteCallback to report the results of its operation. See the EOS_Stats_OnQueryStatsCompleteCallbackInfo page for more details, or check the [Callback Data] section below.

Callback Remarks

Function prototype definition for callbacks passed to EOS_Stats_QueryStats

Callback Parameters


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

Callback Data

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


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_Stats_QueryStats
EOS_ProductUserId LocalUserIdThe Product User ID of the user who initiated this request
EOS_ProductUserId TargetUserIdThe Product User ID whose stats which were retrieved

For more information, see the EOS_Stats_OnQueryStatsCompleteCallbackInfo page.