Remove - method of the PmaSequencer object
Description:
Removes waiting items.
Syntax:
Long Remove(Long CheckType, [Variant CheckVal])
Parameters:
| CheckType | (Long) Specifies what waiting items have to be removed
0 - remove all items (in this case the CheckVal parameter has no meaning)
1 (2,3) - remove items that meet: Val1 (2,3) = CheckVal
10 - remove only the first item from the queue (in this case the CheckVal parameter has no meaning)
11 (12,13) - remove only the first item from the queue that meets: Val1 (2,3) = CheckVal |
|---|
| CheckVal | [optional] (Variant) compared value, see the CheckType parameter |
|---|
Return values:
Returns the number of removed items
Note:
The method removes the selected items from the waiting items queue. The removal means that the item is deleted
without triggering the
onStep event.
Example1:
Removes all items from the queue
JavaScriptVBScriptSelect and copy to clipboard
var oSequencer = pMe.Pm("/Sequencer");
oSequencer.Remove(0);
Dim oSequencer
Set oSequencer = pMe.Pm("/Sequencer")
oSequencer.Remove 0Example2:
Removes all items from the queue that have the value Val1 = "ID1"
JavaScriptVBScriptSelect and copy to clipboard
var oSequencer = pMe.Pm("/Sequencer");
oSequencer.Remove(1, "ID1");
Dim oSequencer
Set oSequencer = pMe.Pm("/Sequencer")
oSequencer.Remove 1, "ID1"