Remove - metoda objektu PmaSequencer

Popis:

Odstraní čekající položky.

Syntaxe:

Variant Remove(Long CheckType, [Variant CheckVal], [String Params])

Parametry:

CheckType	(Long) Určuje, které čekající položky se mají odstranit 0 - odstranit všechny položky (v tom případě parametr CheckVal nemá význam) 1 (2,3,4,5) - odstranit položky, které splňují: Val1 (2,3,4,5) = CheckVal 10 - odstranit jen první položku z fronty (v tom případě parametr CheckVal nemá význam) 11 (12,13,14,15) - odstranit jen první položku z fronty, která splňuje: Val1 (2,3,4,5) = CheckVal
CheckVal	[nepovinné] (Variant) porovnávaná hodnota, viz parametr CheckType
Params	[nepovinné] (String) Dodatečné parametry metody. Údaje jsou zde ve formátu KeyVal, například return:count;. "return:xxx;" - Určuje, co bude metodou vráceno. "return:count;" (přednastaveno) - Vrací počet odstraněných položek. "return:values;" - Vrací 2rozměrné pole PmArray s hodnotami Val1, Val2, Val3, Val4, Val5 pro každou položku. Pole bude ve formátu (Col,Row) - 2-rozměrné pole s významem pole řádků, kde Col jsou Val1, Val2, Val3, Val4, Val5 a Row jsou jednotlivé odstraněné položky. Pokud nedojde k odstranění žádné položky, pak metoda vrací: null pro JavaScript nebo Empty pro VBScript (lze testovat metodou Pm.IsValid).

Vrácená hodnota:

Vrací počet odstraněných položek nebo pole s hodnotami odstraněných položek

Poznámka:

Metoda odstraní vybrané položky z fronty čekajících položek. Odstranění znamená, že položka se vymaže bez vyvolání události onStep.

Viz také:

- PmaSequencer.Add (metoda)

- PmaSequencer.Release (metoda)

Příklad1:

Odstraní z fronty všechny položky

JavaScriptVBScriptVyber a zkopíruj do schránky



var oSequencer = pMe.Pm("/Sequencer");

oSequencer.Remove(0);

Příklad2:

Odstraní z fronty všechny položky, které mají hodnotu Val1 = "ID1"

JavaScriptVBScriptVyber a zkopíruj do schránky



var oSequencer = pMe.Pm("/Sequencer");

oSequencer.Remove(1, "ID1");

Příklad3:

Zjistí hodnoty Val1, Val2, Val3, Val4, Val5 odstraňovaných položek

JavaScriptVyber a zkopíruj do schránky



var oSequencer = pMe.Pm("/Sequencer");

var aRemoved = oSequencer.Remove(1, 100, "return:values;");

// 1030 = PmArray

if (Pm.GetVarType(aRemoved, 2) == 1030 && aRemoved.GetSize(1) == 5)

{

	var nItem = aRemoved.GetSize(2);

	for (iItem = 0; iItem < nItem; iItem++)

	{

		var val1 = aRemoved.GetItem(0, iItem);

		var val2 = aRemoved.GetItem(1, iItem);

		var val3 = aRemoved.GetItem(2, iItem);

		var val4 = aRemoved.GetItem(3, iItem);

		var val5 = aRemoved.GetItem(4, iItem);

		Pm.Debug("val1 = " + val1 + ", val2 = " + val2 + ", val3 = " + val3 + ", val4 = " + val4 + ", val5 = " + val5);

	}

}