Cicode Programming Reference > Cicode Function Categories > Alarm Functions Introduction > AlarmComment

AlarmComment

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

Comments can only be added to alarm summary (Alarm Type 10) alarms.

Syntax

AlarmComment(sComment)

sComment:

The comment to add to the alarm summary entry. Comments have a maximum of 128 characters.

Return Value

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

Related Functions

AlarmDsp

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

Alarm Functions