niSwitch Get Relay Name

NI-SWITCH LabVIEW

previous page next page

niSwitch Get Relay Name

Returns the relay name that is in the relay list at the specified index.

Use this VI in a For Loop to get a complete list of valid relay names for the switch module. Use the Number of Relays property to determine the number of relays.

instrument handle identifies a particular NI-SWITCH session established with niSwitch Initialize With Topology, niSwitch Initialize With Options, or niSwitch Initialize.

index is a 1-based index into the channel table. The default value is 1. The maximum value is equal to the value of the Channel Count property.

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.

relay name specifies the name of the relay.

Examples of valid relay names:

ch0, ab0, 1wire, hlselect

For a list of valid relay names for the switch module, refer to Devices.

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.

previous page start next page