ShelveSelected method (AlarmEventSummary object)

Shelves the selected alarm with the specified duration.
Syntax
object
.
ShelveSelected
 ([
ShowDialog
as
Boolean
], [
Comment
 as
String
], [
IShelveDuration
 as
Long
])
where
object
—
the name of an AlarmEventSummary object.
ShowDialog
—
optional parameter that controls whether the
Shelve Alarm
 dialog box is displayed before the selected alarm is shelved.
  • TRUE
    . The default value is TRUE. If ShowDialog = TRUE, then the
    Shelve Alarm
     dialog box opens and offers users the possibility of entering a comment and duration before the alarm is shelved.
  • FALSE
    . If ShowDialog = FALSE, then the
    Shelve Alarm
     dialog box is NOT displayed before the alarm is shelved. The selected alarm is shelved using the value of the
    Comment
     and
    IShelveDuration
     parameters.
    Comment
    —
    optional parameter that controls the comment string associated with the alarm shelving.
    IShelveDuration
    —optional parameter that controls the duration associated with the alarm shelving. The default value is 1. The value must be from 1 through 2147483647.
Provide Feedback
Have questions or feedback about this documentation? Please submit your feedback here.
Normal