Table Of Contents

Search Variable Container (G Dataflow)

Version:
    Last Modified: March 15, 2017

    Searches under a variable container and returns an array of references to variable objects that match your search criteria. You can use this node to find variables programmatically.

    All search criteria are optional. If you leave a search criterion input unwired, this node does not filter based on that criterion.

    spd-note-note
    Note  

    NI recommends that you use Tag nodes instead of this node for new applications you create.

    connector_pane_image
    datatype_icon

    class

    The class of the variable objects to search for.

    datatype_icon

    container refnum in

    The variable container under which to search. This node searches the partial URLs of all variables in the hierarchy under the container you specify. The partial URLs do not include the URL corresponding to this container.

    datatype_icon

    regular expression

    The pattern to search for within the variable object URLs. The default is an empty string. This node uses the same regular expression rules as the Match Regular Expression node.

    datatype_icon

    data type

    The data type of the variable container.

    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

    access type

    Read access and write access settings of the shared variables you want to search for.

    datatype_icon

    Read Access

    Options for filtering shared variables based on read access.

    Name Description
    Allowed Performs no filtering based on read access.
    Required Returns only shared variables with read access enabled.
    Denied Returns only shared variables with read access disabled.
    datatype_icon

    Write Access

    Options for filtering shared variables based on write access.

    Name Description
    Allowed Performs no filtering based on write access.
    Required Returns only shared variables with write access enabled.
    Denied Returns only shared variables with write access disabled.

    Default: Allowed for both Read Access and Write Access.

    datatype_icon

    container refnum out

    The reference to the variable container.

    datatype_icon

    refnum array out

    The variable object references that result from your search.

    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