FireSync API
 All Classes Files Functions Variables Typedefs Friends Macros Modules Pages
kStatus kSystem_SetHostHealthProvider ( kSystem  system,
kHealth  provider,
k32u  id 
)

Installs a health provider that can be used to generate health statistics for the local host.

This method can be used to enable kSystem to report rudimentary health statistics for the local host computer. This method should not normally be used within a sensor.

If a host health provider has been set, then health messages will be generated when the host health channel is opened, using either kSystem_OpenHostHealth or kSystem_OpenHealth. The health provider should be registered prior to opening health connections and cannot be changed while health connections are open.

Parameters
systemSystem object.
providerHealth provider (or kNULL to unregister).
idNode identifier to use for host health messages (e.g., kHEALTH_MSG_SOURCE_HOST)
Returns
Operation status.