Promotic
WikipediaLinkedInYoutubeTwitterFacebook

Inactivate - method of object PmAlarmEventItem

Description:
Alarm/Event item inactivation
Syntax:
Inactivate([tTimeOff As Date])
Calling:
oAlEvItem.Inactivate tTimeOff
Parameters:
tTimeOff[optional] (Date) Inactivation time. If not used, the inactivation time equals to the time of calling this method.
Note:
Calling the Inactivate method over the inactive alarm has no effect. An active alarm is inactivated. The behaviour of the alarm during the inactivation is specified by the Inactivate type configurator.

If the alarm is inactivated without parameters, the simplier way can be used by writing the valuefalse to the Active property.

It is irrelevant for events (relevant only for alarms).

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").Inactivate
© MICROSYS, spol. s r. o.Tavičská 845/21 703 00 Ostrava-Vítkovice