Shelve​.Priority() method

The Shelve.Priority() method shelves all active alarms within a specified alarm priority range that belong to the same specified provider and alarm group.

Syntax

AlarmClient.Shelve.Priority("ProviderName","GroupName",
FromPriority,ToPriority,Duration=Duration;Reason="Reason");

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

Starting point of the alarm priority range (1-999). The FromPriority value must be less than the ToPriority value.

ToPriority

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

Duration

Length of time in hours that selected alarms are shelved. Duration can be specified as an integer or a floating point number greater than 0.

Example:

Duration=0.5

Reason

Explanation up to 200 characters for shelving alarms by priority range that are shown in the Alarm Control.

An explanation can be delimited by double or single quotation marks. Quotation marks and back slashes (\) can appear within the text of an explanation. If an explanation is delimited by double quotation marks, a single quotation mark is simply a character in the string. If an explanation is delimited by single quotation marks, a double quotation mark is simply a character in the string.

Example

AlarmClient1.Shelve.Priority("\Galaxy","Area_001",100,600, Duration=0.1;Reason=" + """" + "Shelved"+ """" + ";");

Remarks

For more information about setting an alarm priority range, see Set priority ranges for alarm records.