|
FireSync API
|
| kStatus kHealthSummary_AddStat | ( | kHealthSummary | summary, |
| const kChar * | name, | ||
| kHealthId | id, | ||
| k32u | instance, | ||
| kHealthSummaryStat * | stat | ||
| ) |
Adds a stat to the log.
This method is used in the implementation of health services to compose a health summary object from log data. BeginCompose must be called prior to calling AddStat and EndCompose must be called when all stats have been written.
The stat reference returned by this method can be used to access the entry data associated with the stat. The entry array-lists will be initialized with the correct data type and capacity, but will be empty. It is the caller's responsibility to populate the arrays with data before calling kHealthSummary_EndCompose.
| summary | Health summary. |
| name | Stat name. |
| id | Stat id. |
| instance | Stat instance. |
| stat | Optionally receives reference to new stat. |