almSuppressTag() Function

Suppresses the showing of current and future occurrences of any alarm that belongs to the specified tagname having the same provider name, group name, and priority range.

Category

Alarms

Syntax

[Result=]almSuppressTag(ObjectName, ApplicationName, GroupName, TagName, FromPri, ToPri, AlarmClass, AlarmType);

Arguments

ObjectName

The name of the alarm object. For example, AlmObj_1.

ApplicationName

The name of the application. For example, \\node1\InTouch

GroupName

The name of the Group. For example, $System

TagName

The name of the alarm tag.

FromPri

Starting priority of alarms. For example, 100 or Integer tag.

ToPri

Ending priority of alarms. For example, 900 or Integer tag.

AlarmClass

The class of the alarm. For example, "Value."

AlarmType

The alarm type of the alarm. For example, "HiHi."

Example

almSuppressTag("AlmObj_1","\\node1\Intouch", "Turbines","Valve1",10,100,"Value","LoLo");

See Also

almSuppressAll(), almSuppressGroup(), almSuppressDisplay(), almSuppressPriority(), almSuppressRetain(), almSuppressSelected(), almSuppressSelectedGroup(), almSuppressSelectedPriority(), almSuppressSelectedTag(), almUnSuppressAll()