Dismiss.Tag() method
- Last UpdatedJul 19, 2024
- 1 minute read
The Dismiss.Tag method dismisses all latched alarms for a given alarm source, group, tag name, and priority range.
The alarm source, group names, and tag names are case-insensitive.
Syntax
AlarmClient1.Dismiss.Tag(ProviderName,GroupName,TagName,FromPriority,ToPriority,Comments);
Parameters
ProviderName
The name of the provider and optionally node providing alarms including backslash. For example: \\node1\galaxy
GroupName
The name of the alarm group. For example, $system.
TagName
The name of the alarm tag. For example, ValveTag1.
FromPriority
Starting priority of alarms. For example, 100
ToPriority
End priority of alarms. For example, 900.
Comments
A string indicating the alarm dismiss comment.
Example:
ProviderName = \\machine25\galaxy
GroupName = Vessel_25B
TagName = Valve17
FromPriority = 1
ToPriority = 99
Comments = All alarm client records of the attribute Valve17 in the group (area) Vessel_25B of the galaxy on machine25 with priorities from 1 to 99 are now acknowledged.
AlarmClient1.Dismiss.Tag("\\machine25\galaxy", "Vessel_25B", "Valve17", 1, 99, “All alarm client records of the attribute Valve17 in the group (area) Vessel_25B of the galaxy on machine25 with priorities from 1 to 99 are now acknowledged");