niseCfg Get Object VI

Download PDF

Updated2023-02-21
15 minute(s) read

Returns the reference to an object.

All objects that you retrieve from the API must be closed with the niseCfg Close Object VI.

niseCfg Get Virtual Device

Returns the virtual device from the NI Switch Executive configuration.

niseCfg Get Virtual Device

niseCfg is the NI Switch Executive configuration session handle. Call the niseCfg Open Configuration VI to obtain the session handle.

Virtual Device Name specifies the name of the virtual device to retrieve from the configuration.

error in (no error) 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.

niseCfg out is the NI Switch Executive configuration session handle. Call the niseCfg Open Configuration VI to obtain the session handle.

Virtual Device is the reference to the virtual device.

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.

niseVirtualDevice Get Bus

Returns a bus on the virtual device.

niseVirtualDevice Get Bus

Virtual Device is the reference to the virtual device. Call the niseCfg Get Virtual Device VI to obtain the reference.

Bus Name specifies the name of the bus to retrieve from the virtual device.

error in (no error) 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.

Virtual Device out is the reference to the virtual device. Call the niseCfg Get Virtual Device VI to obtain the reference.

Bus is the reference to the bus.

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.

niseVirtualDevice Get Channel

Returns a channel on the virtual device.

niseVirtualDevice Get Channel

Virtual Device is the reference to the virtual device. Call the niseCfg Get Virtual Device VI to obtain the reference.

Channel Name specifies the alias name or the full channel name of the channel to retrieve from the virtual device.

error in (no error) 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.

Virtual Device out is the reference to the virtual device. Call the niseCfg Get Virtual Device VI to obtain the reference.

Channel is the reference to the channel.

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.

niseVirtualDevice Get Exclusion

Returns the exclusion for the virtual device.

niseVirtualDevice Get Exclusion

Virtual Device is the reference to the virtual device. Call the niseCfg Get Virtual Device VI to obtain the reference.

Exclusion Name specifies the name of the exclusion to retrieve from the virtual device.

error in (no error) 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.

Virtual Device out is the reference to the virtual device. Call the niseCfg Get Virtual Device VI to obtain the reference.

Exclusion is the reference to the exclusion.

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.

niseVirtualDevice Get Hardwire

Returns a hardwire on the virtual device.

niseVirtualDevice Get Hardwire

Virtual Device is the reference to the virtual device. Call the niseCfg Get Virtual Device VI to obtain the reference.

Hardwire Name specifies the name of the hardwire to retrieve from the virtual device.

error in (no error) 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.

Virtual Device out is the reference to the virtual device. Call the niseCfg Get Virtual Device VI to obtain the reference.

Hardwire is the reference to the hardwire.

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.

niseVirtualDevice Get IVI Device

Returns an IVI device on the virtual device.

niseVirtualDevice Get IVI Device

Virtual Device is the reference to the virtual device. Call the niseCfg Get Virtual Device VI to obtain the reference.

IVI Logical Name specifies the IVI Logical Name for the switch device you want to use in the configuration.

Note IVI logical names are case sensitive.

error in (no error) 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.

Virtual Device out is the reference to the virtual device. Call the niseCfg Get Virtual Device VI to obtain the reference.

IVI Device is the reference to the IVI device.

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.

niseVirtualDevice Get Route Group

Returns a route group on the virtual device.

niseVirtualDevice Get Route Group

Virtual Device is the reference to the virtual device. Call the niseCfg Get Virtual Device VI to obtain the reference.

Route Group Name specifies the name of the route group you want to retrieve from the virtual device.

error in (no error) 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.

Virtual Device out is the reference to the virtual device. Call the niseCfg Get Virtual Device VI to obtain the reference.

Route Group is the reference to the route group.

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.

niseVirtualDevice Get Route

Returns a route on the virtual device.

niseVirtualDevice Get Route

Virtual Device is the reference to the virtual device. Call the niseCfg Get Virtual Device VI to obtain the reference.

Route Name specifies the name of the route you want to retrieve from the virtual device.

error in (no error) 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.

Virtual Device out is the reference to the virtual device. Call the niseCfg Get Virtual Device VI to obtain the reference.

Route is the reference to the route.

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.

NI Switch Executive

Table of Contents

niseCfg Get Object VI

niseCfg Get Virtual Device

niseVirtualDevice Get Bus

niseVirtualDevice Get Channel

niseVirtualDevice Get Exclusion

niseVirtualDevice Get Hardwire

niseVirtualDevice Get IVI Device

niseVirtualDevice Get Route Group

niseVirtualDevice Get Route

Log in to get a better experience