almSuppressRetain() Function

Suppresses all alarms raised by subsequent queries.

Category

Alarms

Syntax

[Result=]almSuppressRetain(ObjectName,SuppressionRetainFlag);

Arguments

ObjectName

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

SuppressionRetainFlag

Any discrete or analog tag, 0, or non-zero value. TRUE if suppression information is retained for following queries, FALSE otherwise.

Remarks

If the flag is 0 when the alarm query is changed, the suppression filters are removed.

Example

almSuppressRetain("AlmObj_1", 0);

See Also

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