Promotic
WikipediaLinkedInYoutubeTwitterFacebook

Item - method of the PmaEventGroup object

Description:
Access to one event item (to the object of the PmEventItem type).
Syntax:
Object Item(String sId, [Date tTimeOn])
Parameters:
sId(String) The unique text identifier of the event item. See the "Identifier" configurator.
tTimeOn[optional] (Date) Creation time of the event item.

If not set (or the value 0 is set), then the event item is returned without checking the creation time.

If specified, then the creation time of the event item must correspond to the set value.

If the event item that corresponds to the specified text identifier and to the specified creating time doesn't exist, then the error value (null for JavaScript or Nothing pro VBScript) is returned.

The tTimeOn parameter is useful first of all in two following cases:

1. If several instances of the event item with the same identifier exist (cased by states of the event items inactive unacknowledged (blue)), then it enables to return one concrete instance of the event item (even other than the last). If the tTimeOn parameter is omitted, then the last, the latest old, event item is returned.
2. If the operation is performed over the event item and a delay between the beginning of the operation and its termination can arise (the confirmation window for the action or the operation transferred between two computers), then it is advisable to specify by the tTimeOn parameter that the operation has to be performed over the concrete instance of the event item in the time. If the instance of the event item doesn't exist in the moment when the operation starts to be performed, then the operation is cancelled (e.g. an attempt to acknowledge the same event item from two computers at the same time), otherwise the operation would have been performed over the newer (other than original) instance of the event item.
Return values:
Returns object of the PmEventItem type. In case of an error, it returns the value null for JavaScript or Nothing pro VBScript (probably the event item with the Id or the creation time doesn't exist). Nothing value can be tested by VBScript Is operator.
See also:
- PmEventItem.Id (property)
Example:
JavaScriptVBScriptSelect and copy to clipboard

var oEv = pMe.Pm("/Event");
var oItem = oEv.Item("event0", 0);
PROMOTIC 9.0.13 SCADA system documentation - MICROSYS, spol. s r.o.

Send page remarkContact responsible person
© MICROSYS, spol. s r. o.Tavičská 845/21 703 00 Ostrava-Vítkovice