MaskGroup

MaskGroup(TagGroupId AS String/Integer, bMask As Boolean[, UserId AS String/Integer[, bForce As Boolean]]) As Integer

Masks or unmasks the alarms of the tag group identified by <TagGroupId> according to the value of <bMask> parameter (FALSE=unmask, TRUE=mask).

The parameter <TagGroupId> can be the numeric or alphanumeric identifier of the tag group, 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 tag group. Note: if the <UserId> parameter is not defined or null, the unmasking command will only be taken into account for alarms that have been anonymously masked.

When <bMask> is FALSE, if the optional parameter <bForce> is defined as TRUE (FALSE by default) all alarms of the group will be unmasked, including those that had been masked individually.

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