Flush Queue
- Updated2023-02-17
- 2 minute(s) read
Flush Queue
Removes all elements from a queue and returns the elements as an array.
Inputs/Outputs
queue
A reference to a queue.
error in
Error conditions that occur before this node runs.
The node responds to this input according to standard error behavior.
Default value: No error
queue out
Reference to the queue.
remaining elements
An array of elements removed from the queue.
The first element in the array is the element from the front of the queue and the last element in the array is the element from the back of the queue.
The data type of this output changes to match the data type of the queue elements.
error out
Error information.
The node produces this output according to standard error behavior.
Programming Patterns
Use Release Queue to release a queue reference from memory.