VTI Instruments EX1629 - Vtex1629_Get_Shunt_Enabled

VTI Instruments Corp.
184 EX1629 Command Set
vtex1629_get_shunt_enabled
FUNCTION PROTOTYPE
ViStatus vtex1629_get_shunt_enabled (ViSession vi, ViInt32 channel, ViPBoolean enabled);
FUNCTION PARAMETERS
vi = contains a session handle to the instrument. This handle is obtained by the function and remains valid until the
session is closed.
channel = an integer input value that specifies the channel for which the enabled status of the shunt resistor will be
returned. Valid input values: 0 to 47.
enabled = a Boolean return value indicating whether or not the shunt resistor is enabled for the given channel. A
returned value of “1” indicates that the shunt is enabled for that channel.
DATA ITEM RESET VALUE
Not applicable to this function.
DESCRIPTION
This function queries and returns the enabled status of a particular channel’s shunt resistor. Unless the shunt source
is enabled by using the vtex1629_set_shunt_enabled function, it will not be applied in hardware. The shunt source
can be configured using the vtex1629_set_shunt_source function.
EXAMPLE
ViSession instrumentHandle;
ViStatus status;
ViBoolean shunt_enabled;
…
status = vtex1629_get_shunt_enabled(instrumentHandle, 0, & shunt_enabled);