FireSync API
 All Classes Files Functions Variables Typedefs Friends Macros Modules Pages
kStatus kSystem_ReceiveHealth ( kSystem  system,
kHealthMsg info,
k64u  timeout 
)

Waits until at least one health message has been received and then returns the message.

This function can be used as an alternative to registering a health callback.

Messages receieved via this method should be disposed (kObject_Dispose) when no longer needed.

This method is thread-safe.

Parameters
systemSystem object.
infoThe health message object that was received.
timeoutTimeout duration, in microseconds.
Returns
Operation status.