AckSelectedWithComment method

Acknowledges the selected alarm. Optionally, a dialog box is displayed. Operators can use the
Acknowledge Alarm with Comment
 dialog box to enter a comment, or a comment can be entered programmatically.
Syntax
object
.
AckSelectedWithComment
([
ShowDialog
 as
Boolean
], [
Comment
 as
String
])
where
object
—the name of an AlarmEventBanner object.
ShowDialog
—optional parameter that controls whether a dialog box is displayed at runtime, allowing the operator to enter a comment before acknowledging the alarm.
  • TRUE
    . The default value is TRUE. If ShowDialog = TRUE, then an
    Acknowledge Alarm with Comment
     dialog box opens and offers users the possibility of entering a comment before the alarm is acknowledged.
  • FALSE
    . If ShowDialog = FALSE, then a dialog box is NOT displayed before the alarm is acknowledged. The alarm is acknowledged using the value of the
    Comment
     parameter.
    Comment
    —
    optional parameter that specifies a comment string associated with acknowledging the selected alarm.
Possible errors
  • ftasErrorServerConnectionLost
  • ftasErrorInsufficientRights
  • ftasErrorGeneralFailure
  • ftasErrorUnknownAlarm
  • ftasErrorOperationIgnored
To use buttons on a FactoryTalk View graphic display that call this method, the Alarm and Event Banner must be configured to 'Maintain selection when focus lost’ for the method to function. If the 'Maintain selection when focus lost’ is not selected then the selected row is lost when the button is clicked.
Provide Feedback
Have questions or feedback about this documentation? Please submit your feedback here.
Normal