Skip to main content
Version: v4 (Stable)

AckAlarm

AckAlarm(AlarmId AS String/Integer [, UserName AS String [, AlarmTime AS Time]]) As Integer

Acknowledges the alarm identified by <AlarmId>. The identifier can be the reference (String) or the Oid (Integer).

The optional parameter <UserName> contains the name of the user who acknowledged the alarm. If this parameter is omitted or if the string is empty, the user is not defined.

The optional parameter <AlarmTime> allows the originated alarm time to be ack (local time).

The function returns:

  • 0: if no error
  • 6: if the alarm is unknown
  • other: if the alarm has already been acknowledged