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.


icon

Inputs/Outputs

  • cqueuern.png queue —

    queue is a reference to a queue.

    Use the Obtain Queue function to obtain a queue reference.
  • cbool.png return elements? (F) —

    return elements? indicates whether to return the elements in the queue.

    If FALSE (default), the function does not return the elements in the queue.
  • cerrcodeclst.png error in (no error) —

    error in describes error conditions that occur before this node runs. This input provides standard error in functionality.

  • ii32.png max queue size —

    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.

    Note max queue size only limits the number of elements in the queue. It does not preallocate that number of elements in the queue.
  • istr.png queue name —

    queue name is the name of the queue.

  • iqueuern.png queue out —

    queue out returns the reference to the queue unchanged.

  • ii32.png # pending remove —

    # 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.
  • ii32.png # pending insert —

    # 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.

  • ierrcodeclst.png error out —

    error out contains error information. This output provides standard error out functionality.

  • ii32.png # elements in queue —

    # elements in queue returns the current number of elements in the queue.

  • i1dstr.png elements —

    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.