Owning Palette: Queue Operations Functions
Requires: Base Development System
Adds an element to the back of a queue.
|queue is a reference to a queue. Use the Obtain Queue function to obtain a queue reference.|
|element is the element you want to add to the back of the queue. This data type changes to match the subtype of queue.|
|timeout in ms specifies the time, in milliseconds, that the function waits for available space in the queue if the queue is full. The default is –1, indicating never to time out.
If the function waits timeout in ms and the queue remains full, timed out? is TRUE.
|error in describes error conditions that occur before this node runs. With the following exception, this input provides standard error in functionality.
This node runs normally even if an error occurred before this node runs.
|queue out returns the reference to the queue unchanged.|
|timed out? is TRUE if space in the queue did not become available before the function times out or if an error occurred.|
|error out contains error information. This output provides standard error out functionality.|
If the queue is full, the function waits timeout in ms before timing out. If space becomes available in the queue during the wait, the function inserts the element and timed out? is FALSE. If queue becomes invalid such as when you release the queue reference, the function stops waiting and returns error code 1122. Use the Obtain Queue function to set the maximum size of the queue.
Refer to the Queue Overflow and Underflow VI in the labview\examples\Synchronization\Queue directory for an example of using the Enqueue Element function.