Inactivate - method of the PmAlarmItem object
Description:
Alarm item inactivation.
Syntax:
Empty Inactivate([Date tTimeOff])
Parameters:
| tTimeOff | [optional] (Date) Alarm inactivation time.
If not set, then the computer current time is used. |
|---|
Note:
Calling the
Inactivate method over the
inactive alarm has no effect. An
active alarm is deactivated. The behavior of the alarm during the inactivation is specified in the "
Inactivate type" configurator.
If the alarm is deactivated without parameters, then the simplier way can be used by writing the value
false into the
Active property.
The method is
synchronous, it means that it is processed immediately by the alarm subsystem. Nevertheless writing the history to disk is
asynchronous, it means that this method passes the request for writing to the history to the alarm subsystem, it is placed into the queue of requests and it is processed later by the alarm subsystem.
Example:
JavaScriptVBScriptSelect and copy to clipboard
var oAlItem = pMe.Pm("/Alarm").Item("Temperature");
oAlItem.Inactivate();
Dim oAlItem
Set oAlItem = pMe.Pm("/Alarm").Item("Temperature")
oAlItem.Inactivate