SOEEventAdd

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.

Note: If you have installed Plant SCADA on an English operating system and want to add events messages at runtime using a Unicode language (such as Korean, Russian or Chinese), you will need to change the Windows™ Region setting for the runtime computer. To do this, go to Control Panel and open the Region dialog box. On the Administrative tab, use the Change system locale button to select the required system locale. Be aware that you will have to restart your computer. When you launch runtime, select the matching Language on the login form. Your event messages will be recorded using the specified language characters.

See Also

Sequence of Events (SOE) Functions