Promotic
WikipediaLinkedInYoutubeTwitterFacebook

Add - metoda objektu PmSequencer

Popis:
Zařazení nové položky do fronty
Syntaxe:
Add(Timeout As Variant, Val1 As Variant, [Val2 As Variant], [Val3 As Variant], [Params As String]) As Boolean
Volání:
Do objektu přidáme položku, která se uvolní za 10 sekund:
oSequencer.Add 10, "ID1", 1
Parametry:
Timeout(Variant) Určuje kdy se položka uvolní a tedy kdy se vyvolá událost onStep (pokud k tomu nedojde dřív metodou Release).
Když je to číselná hodnota (typu Integer, Long, Single, atd.), pak je to počet sekund, za jak dlouho uvolnit položku (0=nečeká se, -1=čeká se nekonečně dlouho). Smysl této hodnoty závisí na nastavení Typ spouštění položek v záložce Sequencer:
Pokud je nastaveno "0 = položky se spouští nezávisle, každá podle svého timeoutu", pak je to čas od volání metody Add.
Pokud je nastaveno "1 = položky se spouští postupně, timeout je prodleva mezi nimi", pak je to čas od uvolnění poslední položky. V tomto případě musí být zde zadaný timeout menší nebo rovno 21 dnů (tzn. 1814400 sekund).

Případná změna času počítače nemá vliv na timeout položek, tzn. počet sekund do spuštění bude dodržen.

Když je to hodnota typu Date, pak je to datum a čas, kdy uvolnit položku. Nelze zadávat typ Date pokud je nastaveno "1 = položky se spouští postupně, timeout je prodleva mezi nimi". Případná změna času počítače nemá vliv na absolutní čas spuštění položek, položky budou spuštěny v zadaném absolutním čase (už podle nového času). Například položka, která měla být spuštěna ve 14:00:00, bude spuštěna ve 14:00:00 nového času.
Val1(Variant) 1.hodnota položky. Tuto hodnotu lze nastavit pro další využití v události onStep.
Val2[nepovinné] (Variant) 2.hodnota položky. Využití viz Val1
Val3[nepovinné] (Variant) 3.hodnota položky. Využití viz Val1
Params[nepovinné] (String) Dodatečné parametry vytvářené položky. Údaje s přiřazenou hodnotou jsou zde odděleny středníkem, například thread:main;.
"thread:xxx;" - Určení vlákna (thread), ve kterém bude vyvolána událost onStep pro tuto položku. Volba má ale smysl pouze pokud objekt PmSequencer používá pracovní vlákno (viz konfigurátor "Použité vlákno (thread)"), jinak je ignorována. Využití této volby viz PmSequencer a Jak spouštět vybrané skripty v jiném vlákně (threadu).
"thread:work;" (přednastaveno) - událost se spustí v pracovním vlákně
"thread:main;" - událost se spustí v hlavním vlákně
Vrácená hodnota:
true - Položka se zařadila
false - Položka se nezařadila. Důvod: když překročen maximální počet položek (viz MaxSize) nebo špatně nastaven parametr Timeout. Toto se zapíše do globálních chyb INFO systému.
Viz také:
© MICROSYS, spol. s r. o.Tavičská 845/21 703 00 Ostrava-Vítkovice