Remove - metoda obiektu PmaSequencer

Opis:

Usunie czekające pozycje.

Składnia:

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

Parametry:

CheckType	(Long) Określa, które czekające pozycje mają zostać usunięte 0 - usunąć wszystkie pozycje (w tym przypadku parametr CheckVal nie ma znaczenia) 1 (2,3,4,5) - usunąć pozycje, które spełniają warunek: Val1 (2,3,4,5) = CheckVal 10 - usunąć tylko pierwszą pozycję z kolejki (w tym przypadku parametr CheckVal nie ma znaczenia) 11 (12,13,14,15) - usunąć tylko pierwszą pozycję z kolejki, która spełnia warunek: Val1 (2,3,4,5) = CheckVal
CheckVal	[opcjonalne] (Variant) porównywana wartość, patrz parametr CheckType
Params	[opcjonalne] (String) Dodatkowe parametry metody. Dane są tutaj w formacie KeyVal, na przykład return:count;. "return:xxx;" - Określa, co metoda zwróci. "return:count;" (domyślnie) - Zwraca ilość usuniętych pozycji. "return:values;" - Zwraca tablicę 2-wymiarową PmArray z wartościami Val1, Val2, Val3, Val4, Val5 dla każdej pozycji. Tablica będzie w formacie (Col,Row) - tablica 2-wymiarowa mniemana jako tablica wierszy, gdzie Col to Val1, Val2, Val3, Val4, Val5 a Row to pojedyńcze usunięte pozycje. Jeżeli nie zostanie usunięta żadna pozycja, wtedy metoda zwraca: null dla JavaScript lub Empty dla VBScript (można sprawdzić przy pomocy metody Pm.IsValid).

Wartość zwrotna:

Zwraca ilość usuniętych pozycji lub tablicę wartości usuniętych pozycji

Notatka:

Metoda usunie wybrane pozycje z kolejki czekających pozycji. Usunięcie oznacza, że pozycja zostanie wykasowana bez wywołania zdarzenia onStep.

Patrz również:

- PmaSequencer.Add (metoda)

- PmaSequencer.Release (metoda)

Przykład1:

Usunie z kolejki wszystkie pozycje

JavaScriptVBScriptWybierz oraz skopiuj do schowka



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

oSequencer.Remove(0);

Przykład2:

Usunie z kolejki wszystkie pozycje, które posiadają wartość Val1 = "ID1"

JavaScriptVBScriptWybierz oraz skopiuj do schowka



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

oSequencer.Remove(1, "ID1");

Przykład3:

Stwierdzi wartości Val1, Val2, Val3, Val4, Val5 usuwanych pozycji

JavaScriptWybierz oraz skopiuj do schowka



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);

	}

}