AlarmCommentRecID

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 AlarmCommentRecID(sComment, sRecID, nListType, sCluster)

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.

RecID:

Can be the value:

• from the SOE record’s "RECORDID" field. OR

• from the Summary record’s "SUMMARYID" field.

Note: The Summary Alarm List is not provided in the Situational Awareness Starter Project.

nListType:

Following are the nListType values for SOE or Alarm Summary lists.

10 - All summary alarms

15 - Sequence of events with configuration events filtered out

16 - Sequence of events with configuration events

sCluster:

Specifies the cluster context for the alarms displayed in the list.

Return Value

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

Related Functions

AlarmDsp

Example

See Also

Alarm Functions