AlarmComment

Allows an operator to add a comment to a selected alarm summary or SOE entry during runtime. You would normally call this function from a keyboard command.

This function is a blocking function. It blocks the calling Cicode task until the operation is complete.

Syntax

INT AlarmComment(STRING Comment[,INT AN])

Comment:

The comment to add to the alarm summary entry or SOE entry. Currently for the Alarm summary page the maximum length of a comment is 128 characters. The maximum length for a comment on the SOE page is 244 characters. If you exceed the maximum length it will be truncated and an ellipsis appended.

AN:

An animation identifier. Enter the value of the AN where the alarm is displayed. If AN is not specified, the default value will be 0, which means the current cursor position will be used.

Return Value

0 (zero) if successful, otherwise an error code is returned.

Related Functions

AlarmDsp

Example

Note: If you have installed Plant SCADA on an English operating system and want to add comments 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 runtime comments will be recorded using the specified language characters.

See Also

Alarm Functions