Promotic
WikipediaLinkedInYoutubeTwitterFacebook

Activate - method of object PmAlarmEventItem

Description:
Alarm/event item activation.
Syntax:
Activate([sComment As String], [tTimeOn As Date])
Calling:
oAlEvItem.Activate sComment, tTimeOn
Parameters:
sComment[optional] (String) The text note that is stored into the data together with the activated alarm/event item (it is enabled on the Storage page).
tTimeOn[optional] (Date) The activation time of the alarm. If not used, the activation time equals to the time of calling this method.
Note:
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 by the Inactivate type configurator. If the alarm is activated without parameters, the simplier way can be used by writing the valuetrue to the Active property.

The method is synchronous, i.e. it is processed immediately by the alarm subsystem. Nevertheless writing the history to disk is asynchronous, which 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:
oAlEv.Item("Temperature").Activate "max"
© MICROSYS, spol. s r. o.Tavičská 845/21 703 00 Ostrava-Vítkovice