Table Of Contents

Flush Queue (G Dataflow)

Version:
    Last Modified: March 15, 2017

    Removes all elements from a queue and returns the elements as an array.

    spd-note-note
    Note  

    This node does not release the queue reference.

    Programming Patterns

    Use Release Queue to release a queue reference from memory.

    connector_pane_image
    datatype_icon

    queue

    A reference to a queue.

    datatype_icon

    error in

    Error conditions that occur before this node runs.

    The node responds to this input according to standard error behavior.

    Standard Error Behavior

    Many nodes provide an error in input and an error out output so that the node can respond to and communicate errors that occur while code is running. The value of error in specifies whether an error occurred before the node runs. Most nodes respond to values of error in in a standard, predictable way.

    error in does not contain an error error in contains an error
    If no error occurred before the node runs, the node begins execution normally.

    If no error occurs while the node runs, it returns no error. If an error does occur while the node runs, it returns that error information as error out.

    If an error occurred before the node runs, the node does not execute. Instead, it returns the error in value as error out.

    Default: No error

    datatype_icon

    queue out

    Reference to the queue.

    datatype_icon

    remaining elements

    An array of elements removed from 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.

    The data type of this output changes to match the data type of the queue elements.

    datatype_icon

    error out

    Error information.

    The node produces this output according to standard error behavior.

    Standard Error Behavior

    Many nodes provide an error in input and an error out output so that the node can respond to and communicate errors that occur while code is running. The value of error in specifies whether an error occurred before the node runs. Most nodes respond to values of error in in a standard, predictable way.

    error in does not contain an error error in contains an error
    If no error occurred before the node runs, the node begins execution normally.

    If no error occurs while the node runs, it returns no error. If an error does occur while the node runs, it returns that error information as error out.

    If an error occurred before the node runs, the node does not execute. Instead, it returns the error in value as error out.

    Where This Node Can Run:

    Desktop OS: Windows

    FPGA: This product does not support FPGA devices


    Recently Viewed Topics