Promotic
WikipediaLinkedInYoutubeTwitterFacebook

ActivateNew - metoda objektu PmAlarmEvent

Popis:
Dynamické vytvoření nové alarm/event položky (objektu PmAlarmEventItem) v aktivním a nekvitovaném stavu (červená) nebo aktivace již existující položky. Metoda vrací referenci na příslušnou alarm/event položku. Tuto referenci lze získat i voláním metody Item.
Syntaxe:
ActivateNew(sId As String, sIdCopy As String, [sSource As String], [sDesc As String], [sComment As String], [sTimeOn As Date], [nAttr As Long]) As Object
Volání:
oAlEv.ActivateNew sId, sIdCopy, sSource, sDesc, sComment, tTimeOn, nAttr
Parametry:
sId(String) Jednoznačný textový identifikátor nové alarm/event položky. Tento identifikátor se pak využívá při volání metod například: Activate, Inactivate, Acknowledge, Item, atd.

V případě event položky může být identifikátor prázdný, vzniklá položka ihned zanikne, v historii se nicméně záznam objeví (jako při volbě Smazat neaktivní kvitované (zelené) (platí pouze pro dynamicky vytvořené položky)).

sIdCopy(String) Jednoznačný textový identifikátor alarm/event položky typu vzor (viz konfigurátor "Vzor pro dynamicky vytvářené položky"), jejíž konfigurace se použije.
sSource[nepovinné] (String) Označení zdroje alarm/event položky. Umožňuje uživateli třídit a filtrovat položky v prohlížeči v běžící aplikaci podle zadaného zdroje. Není-li uveden, použije se hodnota se vzoru.
sDesc[nepovinné] (String) Vlastní popis alarm/event položky. Základní text položky, který je zobrazen v prohlížeči v běžící aplikaci. Není-li uveden, použije se hodnota se vzoru.
sComment[nepovinné] (String) Textový komentář, který se uloží do dat společně s aktivovanou alarm/event položkou (povoluje se v záložce Uložení).
sTimeOn[nepovinné] (Date) Čas aktivace alarm/event položky. Není-li zadán, použije se aktuální čas počítače.
nAttr[nepovinné] (Long) Atributy, které upřesňují chování příkazu při existenci/neexistenci alarm/event položky.
0 (přednastaveno) - Při existenci alarm/event položky se zadaným identifikátorem, příkaz provede aktivaci nad existující alarm/event položkou. Při neexistenci alarm/event položky se zadaným idenitifikátorem, příkaz vytváří novou alarm/event položku s následnou aktivací.
1 - Při existenci alarm/event položky se zadaným idenitifikátorem, příkaz selže. Při neexistenci alarm/event položky se zadaným idenitifikátorem, příkaz vytváří novou alarm/event položku s následnou aktivací.
Vrácená hodnota:
Vrací referenci na nově vytvořenou (nebo existující) a aktivovanou alarm/event položku typu PmAlarmEventItem. V případě chyby vrací hodnotu Nothing (pravděpodobně již existuje položka se zadaným Id). Hodnotu Nothing lze testovat VBScript operátorem Is.
Viz také:
Příklad:
oAlEv.ActivateNew "T1_HI", "HI", "Kotel", "T1 over high limit", "Teplota"
© MICROSYS, spol. s r. o.Tavičská 845/21 703 00 Ostrava-Vítkovice