Promotic

Item - metoda objektu PmaAlarmGroup

Popis:
Přístup k jedné alarm položce (k objektu typu PmAlarmItem).
Syntaxe:
Object Item(String sId, [Date tTimeOn])
Parametry:
sId(String) Jednoznačný textový identifikátor alarm položky. Viz konfigurátor "Identifikátor".
tTimeOn[nepovinné] (Date) Čas vzniku alarm položky.
Pokud není nastaveno (nebo je zadána Hodnota 0), pak se vrací alarm položka bez kontroly na čas vzniku.
Pokud je čas uveden, pak musí čas vzniku alarm položky odpovídat zadané hodnotě.
Pokud neexistuje alarm položka odpovídající zadanému textovému identifikátoru a zadané hodnotě času vzniku, pak se vrací hodnota null pro JavaScript nebo Nothing pro VBScript.
Parametr tTimeOn je užitečný zejména ve dvou následujících případech:
1. Pokud existuje několik instancí alarm položky se stejným identifikátorem (způsobeno stavy alarm položek neaktivní nekvitovaný (modrý)), pak umožňuje vrátit jednu konkrétní instanci alarm položky (i jinou, než poslední). Pokud se neuvede parametr tTimeOn, pak se vrací poslední nejméně stará alarm položka.
2. Pokud se provádí operace nad alarm položkou a může nastat zpoždění mezi počátkem dané operace a jejím dokončením (potvrzovací okno pro akci nebo operace přenášená mezi dvěma počítači), pak je vhodné použitím parametru tTimeOn určit, že operace se má provést nad konkrétní instancí alarm položky v čase. Pokud ve chvíli, kdy se operace začne provádět už daná instance alarm položky neexistuje, pak se operace zruší (např. pokus o kvitaci téže alarm položky ze dvou počítačů současně), v jiném případě by se operace provedla nad novější (jinou než původní) instancí alarm položky.
Vrácená hodnota:
Vrací objekt typu PmAlarmItem. V případě chyby vrací hodnotu null pro JavaScript nebo Nothing pro VBScript (pravděpodobně neexistuje alarm položka se zadaným Id nebo se zadaným časem vzniku). Hodnotu Nothing lze testovat VBScript operátorem Is.
Viz také:
- PmAlarmItem.Id (vlastnost)
Příklad:
JavaScriptVBScriptVyber a zkopíruj do schránky

var oAl = pMe.Pm("/Alarm");
var oItem = oAl.Item("alarm0", 0);
© MICROSYS, spol. s r.o.