Owning Palette: Queue Operations Functions
Requires: Base Development System
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 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.
|max queue size is the maximum number of elements the queue can contain. If max queue size is –1, the queue can contain any number of elements.
|queue name is the name of the queue.|
|queue out returns the reference to the queue unchanged.|
|# 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. This output provides standard error out functionality.|
|# 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.|