FireSync API
 All Classes Files Functions Variables Typedefs Friends Macros Modules Pages
kStatus kHealthProbe_SetBaseline ( kHealthProbe  probe,
k64s  baseline 
)

Sets the baseline value.

Health probes can be configured with a baseline amount such that the Value accessor will return the sum of the amounts specified with SetBaseline and SetValue. E.g., the sequence SetBaseline(5), SetValue(10) produces a reported Value of 15.

The purpose of the baseline feature is to enable health indicator clients to specify the current value in relation to a reference (baseline) value. This approach is most commonly used with persistent counters.

Refer to the kHealthProbe class summary for more information.

Parameters
probeProbe object.
baselineBaseline value.
Returns
Operation status.