Shelve​.Visible() method

The Shelve.Visible() method shelves only those alarms that are currently visible from the Alarm Control.

Syntax

AlarmClient.Shelve.Visible("Duration=<Duration Hrs>;Reason="+"<Reason>"+"Shelved"+"<Description>"+";");

Parameters

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 all alarms that are visible from 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.

Examples

AlarmClient1.Shelve.Visible("Duration=1.0;

Reason="+""""+"Shelved"+""""+";");

Remarks

For more information about selecting alarms to shelve, see Shelve alarms.