niSwitch Get Relay Position VI

NI Switches Help

Edition Date: April 2015

Part Number: 375472H-01

»View Product Info
Download Help (Windows Only)

Returns the relay position for the relay specified in relay name.

Refer to Devices to determine if the switch module supports individual relay control.

Related Topics

niSwitch Get Relay Position

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

instrument handle 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.
/images/reference/en-XX/help/375472H-01/cstr.gif

relay names is the name of the relay or set of relays to control. You can supply a single relay name or comma-delimited list of relay names to control these relays.

Examples of valid relay names are ch0, ab0, 1wire, and hlselect.

Refer to Devices for a list of valid relay names for the switch module.

Note   Use the niSwitch Wait For Debounce VI, the niSwitch Switch Is Debounced VI, and the Is Debounced property to determine if the relay has settled.
/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.

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

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.

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

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.
/images/reference/en-XX/help/375472H-01/cstr.gif

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/ii32.gif

position indicates the position of the relay.

Open (10)

Indicates that the relay is open.
Closed (11)

Indicates that the relay is closed.
/images/reference/en-XX/help/375472H-01/ierrcodeclst.gif

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

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

status is TRUE (X) if an error occurred or FALSE (checkmark) to indicate a warning or that no error occurred.

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

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.
/images/reference/en-XX/help/375472H-01/istr.gif

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?

Not Helpful