You are here: Core Reference > Coding > Scripting > Message

Message

The Alarm.SelectedAlarms and Alarm.Alarms properties both return an alarm collection and each alarm in the collection has a Message property. The Message property returns a string which contains the message for the alarm (the message provides information about the cause of the alarm). You can access the Message property in your Alarm Banner script.

Syntax

Message

Description

Returns a string containing the message for the alarm.

Arguments

None.

Returns

Message {String}. The alarm message is returned as a string.

Example:

In this example, Alarm.Message is used to return the alarm message string of the selected alarm. The string is displayed in a message box next to the text "Message", and the time of the alarm, the severity description, the alarm item’s full name, and the name of the logged on user are also shown.

Function ShowAlarmInfo( Alarm )

MsgBox "One Alarm Selected", "Severity" & Alarm.SeverityDesc & ", Time " & Alarm.Time & ", "Message" & Alarm.Message & ", logged on user name " & Alarm.Server.Username & ", Object name " & Alarm.Object.Fullname

End Function

Further Information

Alarm Banner: see Alarm Banner in the ClearSCADA Guide to Alarms.


ClearSCADA 2015 R2