Activate - method of the PmAlarmItem object
Alarm item activation.
Empty Activate([String sComment], [Date tTimeOn])
|sComment||[optional] (String) The text comment that is stored into the data together with the activated alarm item (it is enabled on the "Storage" tab).|
|tTimeOn||[optional] (Date) The activation time of the alarm.
If not set, then the computer current time is used.
Calling the Activate
method over the active
alarm has no effect. An inactive
alarm is activated. The behaviour of the alarm during the activation is specified in the "Inactivate type
" configurator. If the alarm is activated without parameters, then the simplier way can be used by writing the value true
into the Active
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.
var oAl = pMe.Pm("/Alarm");
var oAlItem = oAl.Item("Temperature");