EOS_Stats_CopyStatByName

EOS API reference page for EOS_Stats_CopyStatByName

Less than a minute

This function is part of the Stats Interface.

Remarks

Fetches a stat from cached stats by name. Use EOS_Stats_Stat_Release when finished with the data.

Return Value

  • EOS_Success if the information is available and passed out in OutStat

  • EOS_InvalidParameters if you pass a null pointer for the out parameter

  • EOS_NotFound if the stat is not found

See Also

EOS_Stats_Stat_Release

Parameters

EOS_Stats_CopyStatByName

Parameter Type And NameUsage Information
EOS_HStats Handle
const EOS_Stats_CopyStatByNameOptions* OptionsStructure containing the Product User ID and name being accessed
EOS_Stats_Stat** OutStatThe stat data for the given name, if it exists and is valid

If successful, this function provides data to the caller through an output parameter. Once you are finished with the data, you must release it by making the appropriate call into the EOS SDK.