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 the
    Acknowledge Alarm with Comment
    dialog 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 the
    Comment
    parameter value.
  • FALSE.
    If ShowDialog = FALSE, then the
    Acknowledge Alarm with Comment
    dialog box is NOT displayed before the selected alarm is acknowledged, using the value of the
    Comment
    parameter.
    Comment
    optional parameter that controls the comment string associated with the alarm acknowledgment.
Possible errors
  • ftasErrorServerConnectionLost
  • ftasErrorInsufficientRights
  • ftasErrorGeneralFailure
  • ftasErrorUnknownAlarm
  • ftasErrorOperationIgnored
Provide Feedback
Have questions or feedback about this documentation? Please submit your feedback here.
Normal