Unshelve​.Priority() method

The Unshelve.Priority() method unshelves currently shelved alarms within a specified alarm priority range that belong to the same specified provider and alarm group.

Syntax

AlarmClient.Unshelve.Priority("ProviderName","GroupName",FromPriority,ToPriority,"Duration=<Duration>;Reason="+"<Reason>"+"UnShelved"+"<Description>"+";");

Parameters

ProviderName

Node and provider name combination that specifies the origin of alarm monitoring.

GroupName

Alarm group or area name whose alarms are monitored by the Alarm Control.

FromPriority

Three-digit starting point of the alarm priority range. The FromPriority value must be less than the ToPriority value.

ToPriority

Three-digit end point of the alarm priority range. The ToPriority value must be greater than the FromPriority value.

Duration

Duration must be set to 0 to unshelve alarms.

Reason

Explanation up to 200 characters for unshelving all alarms belonging to a specified alarm priority range.

An explanation is optional to unshelve alarms and the Reason parameter can be specified as Reason="" to indicate a null explanation.

Example

AlarmClient1.Unshelve.Priority("\Galaxy","Area_001",100,600,"Duration=0;Reason="+""""+"UnShelved"+""""+";");

Remarks

For more information about unshelving alarms, see Unshelve Alarms.