Activate - method of the PmaEventGroup object
Description:
Activation of an existing event item (of the
PmEventItem object).
Syntax:
Empty Activate(String sId, [String sComment], [Date tTimeOn])
Parameters:
| sId | (String) The unigue text identifier of the event item. See the "Identifier" configurator. |
|---|
| sComment | [optional] (String) The text comment that is stored into the data together with the activated event item (it is enabled on the "Storage" tab). |
|---|
| tTimeOn | [optional] (Date) The activation time of the event.
If not set, then the computer current time is used. |
|---|
Note:
After the attempt to activate non-existing event item (wrong
sId parameter), an error occurs
in the INFO system only if in the corresponding
PmaEventGroup object there is no event item with the checked configurator "
Template for dynamically created items" (it means that all event items of the
PmaEventGroup object are statically configured).
The method is
synchronous, i.e. it is processed immediately by the event subsystem. Nevertheless writing the event history to disk is
asynchronous, it means that this method passes the request for writing into the history of the event subsystem, that is placed into the queue of requests and is processed later by the event subsystem.
Example:
JavaScriptVBScriptSelect and copy to clipboard
var oEv = pMe.Pm("/Event");
oEv.Activate("T1_HI");
Dim oEv
Set oEv = pMe.Pm("/Event")
oEv.Activate "T1_HI"