Skip to main content
Version: v4 (Stable)

MaskAlarm

MaskAlarm(AlarmId AS String/Integer, bMask As Boolean[, UserId AS String/Integer]) As Integer

Masks or unmasks the alarm identified by <AlarmId> according to the value of <bMask> parameter (FALSE=unmask, TRUE=mask).

The parameter <AlarmId> can be the numeric or alphanumeric identifier of the alarm tag according to the parameter type (Integer or String).

The optional parameter <UserId> contains the numeric or alphanumeric identifier of the user who is masking the alarm. Note: if the <UserId> parameter is not defined or null, the unmasking command will only be taken into account if the alarm has been anonymously masked.

Returns an error code (0 if no error, 6 if <AlarmId> not defined, 8 if the designated operator is unknown in Alert, 24 if the designated operator is not authorized to mask/unmask alarms).