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
Example
|
System Keyboard |
|
|
Key Sequence |
Com ################## Enter |
|
Command |
AlarmComment(Arg1) |
|
Comment |
Add an alarm comment to the alarm where the cursor is positioned |
See Also
Published June 2018