ihuWriteComment
Use the ihuWriteComment
function to write a single comment to a single data sample.
Prototype
ihuWriteComment {
in long serverhandle,
in MSO Char *Tagname,
in IHU_timestamp *time stamp,
in MSO Char *Comment,
in MSO Char *SuppliedUser,
in MSO Char *SuppliedPassword
};
Remarks
Comments can be written with any time stamp that is valid for a data write. See ihuWriteDatafunction for details on valid time stamps. If there is an existing raw sample for the specified tag and time stamp, the comment is attached with no loss of data values stored with that sample. Otherwise, a new raw sample with no value is created to hold the comment.
If a time stamp with 0 seconds is passed in, the current time is used.
Currently, comments written with the User API must be string text.
The SuppliedUser
and SuppliedPassword
parameters are optional and can be NULL
. If set, values must be a valid username and password with write permissions, or the comment write fails.
Returns
ihuSTATUS_OK
on success, error otherwise.