Table Of Contents

Get NI-SWITCH Session (G Dataflow)

Version:
    Last Modified: September 16, 2017

    Retrieves an NI-SWITCH instrument session for an NI-SWITCH switch that is being managed by Switch Executive. The retrieved session reference can be used to access instrument-specific functionality through the instrument driver.

    spd-note-note
    Note  

    Use caution when using the session reference. Calling nodes on an instrument driver can invalidate the Switch Executive configuration and cache. You should not use the retrieved session reference to make or break connections or modify the configuration channels, as doing so can cause undefined, and potentially unwanted, behavior.

    Programming Patterns

    When you finish using the NI-SWITCH session, call Release NI-SWITCH Session.

    connector_pane_image
    datatype_icon

    session in

    Handle that identifies your Switch Executive virtual device session previously allocated by Open Session.

    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

    resource name

    IVI logical name of the switch in an NI-SWITCH session for which to retrieve the NI-SWITCH session.

    datatype_icon

    session out

    Reference to your virtual device session to wire to the next node.

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

    NI-SWITCH session out

    Reference to your NI-SWITCH session to wire to the next node.

    Where This Node Can Run:

    Desktop OS: Windows

    FPGA: Not supported

    Web Server: Not supported in VIs that run in a web application


    Recently Viewed Topics