Skip to main content
Version: v4 (Stable)

GetAlarmMessage

GetAlarmMessage(AlarmId AS Integer/String, Message AS String[, LangId As Integer[, NoAlarm As Boolean]]) AS Integer

Gets in <Message> the formatted alarm message of the alarm tag identified by <AlarmId>.

The message is returned in the language defined by the optional parameter <LangId> (ISO language code, 1033 for US English, 1036 for French; see Language coding table). The default value 0 means the current language selected in Alert.

The optional parameter <NoAlarm> with the value TRUE returns the formatted alarm message for all tags whether or not they are in the alarm state (FALSE by default).

Returns an error code (0 if no error, 6 if <AlarmId> is not defined or if the <NoAlarm> parameter is FALSE and the tag is not in alarm state).