niSwitch Initialize

NI-SWITCH LabVIEW

niSwitch Initialize

Returns a session handle used to identify the switch module in all subsequent NI-SWITCH calls.

This VI creates a new IVI instrument driver session for the switch module specified in the resource name parameter. If multiple topologies are valid for that switch module, NI-SWITCH uses the default topology specified in MAX.

By default, the switch module is reset to a known state.

An error is returned if a session to the specified resource exists in another process. The same session is returned if niSwitch Initialize is called twice in the same process for the same resource with the same topology.

resource name specifies the resource name of the switch module to initialize.

Syntax:

Optional fields are shown in square brackets ([]).

Configured in MAX UnderValid Syntax
NI-DAQmx DevicesDAQmxDeviceName
Traditional NI-DAQ (Legacy) DevicesSCXI[chassis ID]::slot number
PXI SystemPXI[bus number]::device number
Tip  IVI logical names are also valid for the resource name.

Default values for optional fields:

chassis ID = 1

bus number = 0

Example resource names:

Resource NameDescription
SC1Mod3NI-DAQmx module in chassis "SC1" Slot 3
MySwitchNI-DAQmx module renamed to "MySwitch"
SCXI1::3Traditional NI-DAQ (Legacy) module in chassis 1, Slot 3
SCXI::3Traditional NI-DAQ (Legacy) module in chassis 1, Slot 3
PXI0::16PXI bus 0, device number 16
PXI::16PXI bus 0, device number 16

id query is ignored.

Because NI-SWITCH supports multiple switch modules, it always queries the switch module to determine which module is installed. For this reason, this VI may return ID Query Failed error even if this parameter is set to VI FALSE.

reset device specifies whether to reset the switch module during the initialization process.

TRUE (default)The device will reset.
FALSECurrently unsupported. The device will not reset.
error in describes error conditions that occur before this VI or function runs. The default is no error. If an error occurred before this VI or function runs, the VI or function passes the error in value to error out. This VI or function runs normally only if no error occurs before this VI or function runs. If an error occurs while this VI or function runs, it runs normally and sets its own error status in error out. Use the Simple Error Handler or General Error Handler VIs to display the description of the error code. Use error in and error out to check errors and to specify execution order by wiring error out from one node to error in of the next node.
status is TRUE (X) if an error occurred before this VI ran or FALSE (checkmark) to indicate a warning or that no error occurred before this VI ran. The default is FALSE.
code is the error or warning code. The default is 0. If status is TRUE, code is a non-zero error code. If status is FALSE, code is 0 or a warning code.
source describes the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning. The default is an empty string.
instrument handle out identifies a particular NI-SWITCH session established with niSwitch Initialize With Topology, niSwitch Initialize With Options, or niSwitch Initialize and used for all subsequent NI-SWITCH calls.
error out contains error information. If error in indicates that an error occurred before this VI or function ran, error out contains the same error information. Otherwise, it describes the error status that this VI or function produces. Right-click the error out indicator on the front panel and select Explain Error from the shortcut menu for more information about the error.
status is TRUE (X) if an error occurred or FALSE (checkmark) to indicate a warning or that no error occurred.
code is the error or warning code. If status is TRUE, code is a non-zero error code. If status is FALSE, code is 0 or a warning code.
source describes the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning.