niSwitch_GetRelayPosition
Specific Function
C Function Prototype
ViStatus niSwitch_GetRelayPosition (ViSession vi, ViConstString relayName, ViInt32* relayPosition);
Purpose
Returns the relay position for the relay specified in the relayName parameter.
Parameters
| Name | Type | Description |
|---|---|---|
| vi | ViSession | A particular NI-SWITCH session established with niSwitch_InitWithTopology, niSwitch_InitWithOptions, or niSwitch_init and used for all subsequent NI-SWITCH calls. |
| relayName | ViConstString | Name of the relay. Refer to Devices for a list of valid relay names for the switch module. Examples of valid relay names: ch0, ab0, 1wire, hlselect |
| relayPosition | ViInt32 | Indicates whether the relay is open or closed. Valid Values: NISWITCH_VAL_OPEN (10) NISWITCH_VAL_CLOSED (11) |