Dequeue Element
- Updated2023-02-17
- 3 minute(s) read
Dequeue Element
Removes an element from the front of a queue and returns the element.
If the queue becomes invalid because the queue reference is released, then this node stops waiting and returns an error.
Inputs/Outputs

queue
A reference to a queue.

timeout in milliseconds
The number of milliseconds that the node waits for an element to become available in the queue if the queue is empty.
If an element becomes available in the queue during the wait, the node removes and returns the element and does not time out.
Default value: -1 — The node never times out.

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.

element
The element at the front of the queue.
The data type of this output changes to match the data type of the queue elements.
If the node times out or an error occurs, this output returns the default value of the element data type.

timed out?
A Boolean value that indicates whether an element became available in the queue before the node timed out or if an error occurred.
| True | An element did not become available before the node timed out or this node generated an error. |
| False | An element did become available before the node timed out or an error occurred before this node executed. |

error out
The node produces this output according to standard error behavior.
This node can return the following error codes.
| 1122 | The reference became invalid while the node was waiting for it. |
Programming Patterns
Transferring Data Between Loops Using Queue Nodes