Releases a queue and returns the remaining elements in the queue. All Enqueue Element, Enqueue Element at Opposite End, Preview Queue Element, and Dequeue Element functions currently waiting on the released queue time out immediately and return an error. Details
![]() |
queue is a reference to a queue. Use the Obtain Queue function to obtain a queue reference. | ||||||
![]() |
force destroy? indicates whether to destroy the queue. If FALSE (default) and you want to destroy the queue, call the Release Queue function a number of times equal to the number of times you obtained the queue or stop all VIs using the queue reference. If TRUE, the function destroys the queue and you do not have to call the function multiple times or stop all VIs using the queue reference. | ||||||
![]() |
error in describes error conditions that occur before this VI or function runs.
The default is no error. If an error occurred before this VI or function runs, the VI or function passes the error in value to error out. This VI or function runs normally only if no error occurs before this VI or function runs. If an error occurs while this VI or function runs, it runs normally and sets its own error status in error out. Use the Simple Error Handler or General Error Handler VIs to display the description of the error code. Use error in and error out to check errors and to specify execution order by wiring error out from one node to error in of the next node.
| ||||||
![]() |
queue name is the name of the queue. | ||||||
![]() |
remaining elements is the array of elements that were in the queue before the function released 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.
This data type changes to match the subtype of queue. |
||||||
![]() |
error out contains error information. If error in indicates that an error occurred before this VI or function ran, error out contains the same error information. Otherwise, it describes the error status that this VI or function produces.
Right-click the error out indicator on the front panel and select Explain Error from the shortcut menu for more information about the error.
|
You can use the Obtain Queue function to obtain the same queue with the same name multiple times. To destroy a queue, call the Release Queue function a number of times equal to the number of times you obtained the queue or stop all VIs using the queue reference.
If force destroy? is TRUE, this function releases all references to the queue and destroys the queue. Any Enqueue Element, Enqueue Element at Opposite End, Preview Queue Element, and Dequeue Element functions waiting on the queue time out and return error code 1.