AckArea

<< Click to Display Table of Contents >>

 

AckArea

AckArea(Area, [ActorID])

Performs an acknowledgment of Alarms on a certain Area. This method returns a Boolean indicating whether this operation was successful or not. The Area parameter specifies the name of the Area or Areas whose Alarms are acknowledged, by comparing the beginning of their names. For example, AckArea("ANA") acknowledges Alarms in Areas "ANALOG", "ANA.AREA2", etc. If this parameter is empty, this method behaves as AckAllAlarms. The ActorID parameter informs the name of the user responsible for acknowledging these Alarms. This is an optional parameter and, if omitted, assumes E3 Viewer's logged-on user, "Anonymous" if there is no user logged on, or "System" if this method's call started at the server. The next code contains an example of using this method.

Sub Button1_Click()
  'When clicking this Button, acknowledges Area1 Alarms
  Application.GetObject("AlarmServer1")._
    AckArea "Area1", Application.User
End Sub

Was this page useful?