Get Queue Status

Returns information about the current state of a queue, such as the number of elements currently in the queue. You also can use this function to verify that queue is a valid queue refnum. If queue is not a valid queue refnum, the function returns error code 1.

queue is a reference to a queue. Use the Obtain Queue function to obtain a queue reference.
return elements? indicates whether to return the elements in the queue. If FALSE (default), the function does not return the elements in the queue.
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.
status is TRUE (X) if an error occurred before this VI or function ran or FALSE (checkmark) to indicate a warning or that no error occurred before this VI or function ran. The default is FALSE.
code is the error or warning code. The default is 0. If status is TRUE, code is a non-zero error code. If status is FALSE, code is 0 or a warning code.
source describes the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning. The default is an empty string.
queue name is the name of the queue.
queue out returns queue unedited.
# pending remove is the number of Dequeue Element or Preview Queue Element functions currently waiting to remove an element from the queue. Refer to the Dequeue Element and Preview Queue Element functions for more information.
# pending insert is the number of functions currently waiting to insert an element in the queue. Use the Enqueue Element or Enqueue Element at Opposite End functions to insert an element in the queue.

If the max queue size is –1, # pending insert is 0.

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.
status is TRUE (X) if an error occurred or FALSE (checkmark) to indicate a warning or that no error occurred.
code is the error or warning code. If status is TRUE, code is a non-zero error code. If status is FALSE, code is 0 or a warning code.
source describes the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning.
# elements in queue returns the current number of elements in the queue.
elements returns all the elements currently in the queue, but does not remove them from the queue. If return elements? is FALSE, this array is empty.

This data type changes to match the subtype of queue.