Adds an element to the front of a queue. This function is similar to the Enqueue Element function. Details
![]() |
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 front of the queue. This data type changes to match the subtype of queue. | ||||||
![]() |
timeout in ms indicates how many milliseconds 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 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 out returns queue unedited. | ||||||
![]() |
timed out? is TRUE if space in the queue did not become available before the function timed out or if an error occurred. | ||||||
![]() |
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.
|
Queues typically use a first-in-first-out flow of data. In rare situations, you might want to interrupt this normal flow of data by adding an element to the front of the queue. After you add an element to the front of a queue, the next Dequeue Element function you call removes the element you added to the front. For example, you could use this function if you want to use the queue as a stack structure or add high-priority elements to the front of the queue.