This function is part of the Stats Interface.
Remarks
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
Parameters
EOS_Stats_QueryStats
| Parameter Type And Name | Usage Information |
|---|---|
| EOS_HStats Handle | |
| const EOS_Stats_QueryStatsOptions* Options | Structure containing information about the player whose stats we're retrieving. |
| void* ClientData | Arbitrary data that is passed back to you in the CompletionDelegate |
| const EOS_Stats_OnQueryStatsCompleteCallback CompletionDelegate | This 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
EOS_Stats_OnQueryStatsCompleteCallback
| Parameter Type And Name | Usage Information |
|---|---|
| const EOS_Stats_OnQueryStatsCompleteCallbackInfo* Data | A EOS_Stats_OnQueryStatsCompleteCallbackInfo containing the output information and result |
Callback Data
The EOS SDK passes the following data structure to the callback function:
EOS_Stats_OnQueryStatsCompleteCallbackInfo
| 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_Stats_QueryStats |
| EOS_ProductUserId LocalUserId | The Product User ID of the user who initiated this request |
| EOS_ProductUserId TargetUserId | The Product User ID whose stats which were retrieved |
For more information, see the EOS_Stats_OnQueryStatsCompleteCallbackInfo page.