Use this function to insert an event into the Event Journal.
This function is a blocking function. It blocks the calling Cicode task until the operation is complete.
Syntax
INT SOEEventAdd(TIMESTAMP TimeStamp, STRING Message[,STRING Tag, STRING Cluster])
TimeStamp:
The time of the inserted event.
Message:
The message for the event.
Tag:
Alarm tag associated with the event. This can be Cluster.Tag or Tag if running on a single cluster system. If not specified the event is classed as a ‘User’ event.
Cluster:
Specify if running on a multi-cluster system and Tag has been specified. If Tag has not been specified and the Cluster is blank, the User event will be broadcast to all of the clusters to which the client is currently connected.
Return Value
0 (zero) if successful, otherwise an error code is returned.
See Also
Published June 2018