niSwitch Initialize VI

NI Switches Help

Edition Date: April 2015

Part Number: 375472H-01

»View Product Info

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 this VI is called twice in the same process for the same resource with the same topology.

Related Topics

niSwitch Initialize

/images/reference/en-XX/help/375472H-01/cio.gif

resource name specifies the resource name of the switch module to initialize. IVI logical names are also valid resource names.

Syntax:

Optional fields are shown in square brackets ([]). The default values for optional fields are as follows:

chassis ID = 1

bus number = 0

Configured in MAX Under	Valid Syntax
Devices and Interfaces	DeviceName
Traditional NI-DAQ (Legacy) Devices	SCXI[chassis ID]::slot number
PXI System	PXI[bus number]::device number

The following table lists example resource names.

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

/images/reference/en-XX/help/375472H-01/cbool.gif

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 an ID Query Failed error even if this parameter is set to VI FALSE.

reset device specifies whether to reset the switch module during initialization. The default value is TRUE (1).

Note The first call to the niSwitch Initialize With Topology VI after you reboot your computer will reset the hardware. This is the only case when the Reset flag is not honored.

TRUE (1)	The device will reset.
FALSE (0)	The device will not reset.

/images/reference/en-XX/help/375472H-01/cerrcodeclst.gif

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

	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 that produced the error or warning. The default is an empty string.

/images/reference/en-XX/help/375472H-01/iio.gif

instrument handle out identifies a particular NI-SWITCH session established with the niSwitch Initialize With Topology VI, the niSwitch Initialize With Options VI, or the niSwitch Initialize VI and used for all subsequent NI-SWITCH calls.

/images/reference/en-XX/help/375472H-01/ierrcodeclst.gif

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

	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 that produced the error or warning.

WAS THIS ARTICLE HELPFUL?

Helpful

Not Helpful