niseCfg Remove Object VI

Download PDF

Updated2023-02-21
23 minute(s) read

Removes an object.

After NI Switch Executive removes an object, it does not need to be released using the niseCfg Close Object VI.

niseCfg Remove Virtual Device

Deletes a virtual device from the configuration.

niseCfg Remove Virtual Device

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

Virtual Device specifies the virtual device to remove.

Specify the virtual device using any of the following data types:

The reference to the virtual device, which you can obtain with the niseCfg Get Virtual Device VI
A one-based index to the collection of virtual devices in your NI Switch Executive configuration
The name of the virtual device 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.

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 Remove Bus

Deletes a bus from the virtual device.

niseVirtualDevice Remove Bus

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

Bus specifies the bus to remove from the virtual device.

Specify the bus using any of the following data types:

The reference to the bus, which you can obtain with the niseVirtualDevice Get Bus VI
A one-based index to the collection of buses on a virtual device
The bus name

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.

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 Remove Exclusion

Deletes an exclusion from the virtual device.

niseVirtualDevice Remove Exclusion

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

Exclusion specifies the exclusion to remove from the virtual device.

Specify the exclusion using any of the following data types:

The reference to the exclusion, which you can obtain with the niseVirtualDevice Get Exclusion VI
A one-based index to the collection of exclusions on a virtual device
The exclusion name

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.

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 Remove Hardwire

Deletes a hardwire from the virtual device.

niseVirtualDevice Remove Hardwire

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

Hardwire specifies the hardwire to remove from the virtual device.

Specify the hardwire using any of the following data types:

The reference to the hardwire, which you can obtain with the niseVirtualDevice Get Hardwire VI
A one-based index to the collection of hardwires on a virtual device
The hardwire name

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.

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 Remove IVI Device

Deletes an IVI device from the virtual device.

niseVirtualDevice Remove IVI Device

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

IVI Device specifies the IVI device to remove from the virtual device.

Specify the IVI device using any of the following data types:

The reference to the IVI device, which you can obtain with the niseVirtualDevice Get IVI Device VI
A one-based index to the collection of IVI devices on a virtual device
The IVI device name

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.

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 Remove Route Group

Deletes a route group from the virtual device.

niseVirtualDevice Remove Route Group

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

Route Group specifies the route group to remove from the virtual device.

Specify the route group using any of the following data types:

The reference to the route group, which you can obtain with the niseVirtualDevice Get Route Group VI
A one-based index to the collection of route groups on a virtual device
The route group name

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.

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 Remove Route

Deletes a route from the virtual device.

niseVirtualDevice Remove Route

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

Route specifies the route to remove from the virtual device.

Specify the route using any of the following data types:

The reference to the route, which you can obtain with the niseVirtualDevice Get Route VI
A one-based index to the collection of routes on a virtual device
The route name

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.

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.

niseExclusion Remove Channel

Removes a channel from the specified set of excluded channels.

niseExclusion Remove Channel

Exclusion is the reference to the exclusion. Call the niseVirtualDevice Get Exclusion VI to obtain the reference.

Channel specifies the channel to remove from the exclusion collection.

Specify the channel using any of the following data types:

The reference to the channel, which you can obtain with the niseVirtual Device Get Channel VI
A one-based index to the collection of channels in the exclusion set
The channel name

Channel Group specifies the type of the collection of channels in the exclusion.

If the exclusion type is 'Mutual Exclusion', you must specify 'mutual channels' as the type of the channel group. If the exclusion type is 'Set Exclusion', you must specify either Set1 or Set2 channels as the collection from which to remove the channel.

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.

Exclusion out is the reference to the exclusion. Call the niseVirtualDevice Get Exclusion VI to obtain the reference.

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.

niseHardwire Remove Channel

Removes the channel from the hardwire.

niseHardwire Remove Channel

Hardwire is the reference to the hardwire. Call the niseVirtualDevice Get Hardwire VI to obtain the reference.

Channel specifies the channel to remove from the exclusion collection.

Specify the channel using any of the following data types:

The reference to the channel, which you can obtain with the niseVirtual Device Get Channel VI
A one-based index to the collection of channels in the exclusion set
The channel name

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.

Hardwire out is the reference to the hardwire. Call the niseVirtualDevice Get Hardwire VI to obtain the reference.

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.

niseRouteGroup Remove Route Group

Disassociates the child route group from the route group.

niseRouteGroup Remove Route Group

Route Group is the reference to the route group. Call the niseVirtualDevice Get Route Group VI to obtain the reference.

Child Route Group specifies the route group to remove from the collection of child route groups.

Specify the route group using any of the following data types:

The reference to the route group, which you can obtain with the niseVirtualDevice Get Route Group VI
A one-based index to the route group in the collection of child route groups
The route group name

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.

Route Group out is the reference to the route group. Call the niseVirtualDevice Get Route Group VI to obtain the reference.

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.

niseRouteGroup Remove Route

Disassociates the child route from the route group.

niseRouteGroup Remove Route

Route Group is the reference to the route group. Call the niseVirtualDevice Get Route Group VI to obtain the reference.

Child Route specifies the route to remove from the child route groups collection.

Specify the route using any of the following data types:

The reference to the route, which you can obtain with the niseVirtualDevice Get Route VI
A one-based index to the route group in the collection of child routes
The route name

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.

Route Group out is the reference to the route group. Call the niseVirtualDevice Get Route Group VI to obtain the reference.

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.

niseBus Remove Channel Pair

Removes a channel pair from a bus.

niseBus Remove Channel Pair

Bus is the reference to the bus. Call the niseVirtualDevice Get Bus VI to obtain the reference.

Bus Channel Pair specifies the reference to the channel pair to remove from the bus.

You can pass a one-based index to the collection of bus channel pairs as this parameter. Alternatively, you can pass the bus channel pair reference from the array of references you obtain with the niseBus Get Channel Pairs VI. You cannot refer to a bus channel pair by its name.

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.

Bus out is the reference to the bus. Call the niseVirtualDevice Get Bus VI to obtain the reference.

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 Remove Object VI

niseCfg Remove Virtual Device

niseVirtualDevice Remove Bus

niseVirtualDevice Remove Exclusion

niseVirtualDevice Remove Hardwire

niseVirtualDevice Remove IVI Device

niseVirtualDevice Remove Route Group

niseVirtualDevice Remove Route

niseExclusion Remove Channel

niseHardwire Remove Channel

niseRouteGroup Remove Route Group

niseRouteGroup Remove Route

niseBus Remove Channel Pair

Log in to get a better experience