This function is part of the Stats Interface.
Remarks
Ingest a stat by the amount specified in Options. When the operation is complete and the delegate is triggered the stat will be uploaded to the backend to be processed. The stat may not be updated immediately and an achievement using the stat may take a while to be unlocked once the stat has been uploaded.
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_IngestStat
Parameter Type And Name | Usage Information |
---|---|
EOS_HStats Handle | |
const EOS_Stats_IngestStatOptions* Options | Structure containing information about the stat we're ingesting. |
void* ClientData | Arbitrary data that is passed back to you in the CompletionDelegate. |
const EOS_Stats_OnIngestStatCompleteCallback CompletionDelegate | This function is called when the ingest stat operation completes. |
Callback Function Information
Because this function is asynchronous, it employs a callback of type EOS_Stats_OnIngestStatCompleteCallback to report the results of its operation.
Callback Remarks
Function prototype definition for callbacks passed to EOS_Stats_IngestStat
Callback Parameters
EOS_Stats_OnIngestStatCompleteCallback
Parameter Type And Name | Usage Information |
---|---|
const EOS_Stats_IngestStatCompleteCallbackInfo* Data | A EOS_Stats_IngestStatCompleteCallbackInfo containing the output information and result |