Skip to main content
Version: v4 (Stable)

SetAlarmMessage

SetAlarmMessage(AlarmId AS String/Integer, Message AS String[, State AS Integer]) As Integer

Defines in <Message> the long message associated with the alarm tag defined by the <AlarmId> identifier. <AlarmId> can be the numeric object Id of the tag or its alphanumeric identifier depending on the type of the parameter (Integer or String).

The optional parameter <State> indicates the state to be configured: 0 for alarm (default), 1 for acknowledgment, 2 for reset.

Returns 0 if no error, 6 for an invalid alarm ID.