AckSelectedWithComment method (AlarmSummary object)
Acknowledges the selected alarm with a comment.
Syntax
object
.AckSelectedWithComment
([ShowDialog
as Boolean
], [Comment
as String
])where
object
—
the name of an AlarmEventSummary object.ShowDialog
—
optional parameter that controls whether a dialog box is displayed before the alarm is acknowledged.- TRUE.The default value is TRUE. If ShowDialog = TRUE, then theAcknowledge Alarm with Commentdialog box opens and offers users the possibility of entering a comment before the alarm is acknowledged and the comment edit box is set to match theCommentparameter value.
- FALSE.If ShowDialog = FALSE, then theAcknowledge Alarm with Commentdialog box is NOT displayed before the selected alarm is acknowledged, using the value of theCommentparameter.Comment—optional parameter that controls the comment string associated with the alarm acknowledgment.
Possible errors
- ftasErrorServerConnectionLost
- ftasErrorInsufficientRights
- ftasErrorGeneralFailure
- ftasErrorUnknownAlarm
- ftasErrorOperationIgnored
Provide Feedback