VTI Instruments EX1629 - Vtex1629_Set_Shunt_Enabled

VTI Instruments Corp.
280 EX1629 Command Set
vtex1629_set_shunt_enabled
FUNCTION PROTOTYPE
ViStatus vtex1629_set_shunt_enabled (ViSession vi, ViInt32 _VI_FAR channels[],ViInt32 numberOfChannels,
ViBoolean 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.
channels = an input integer array containing a list of channel numbers for which the shunt resistors will be
enabled/disabled. Valid input values: 0 to 47.
numberOfChannels = the size of the channels list. Valid input values: 1 to 48.
enabled = a Boolean input value indicating whether to enable the shunt resistors for the given list of channels.
VI_TRUE(1) will enable the shunt resistors for the given list of channels and VI_FALSE(0) will disable the shunt
resistors for the given list of channels..
DATA ITEM RESET VALUE
enabled = 0 (disabled)
DESCRIPTION
This function enables or disables the shunt resistors for a particular list of channels, based on the currently
configured shunt source for each channel. A shunt source that is not enabled will not actually be applied in
hardware.
NOTE The configuration of the shunt source and its enabling are separate operations. Thus, setting a
shunt source using the vtex1629_set_shunt_source function does not guarantee that the shunt
source is enabled. That must be set with the vtex1629_set_shunt_enabled command.
EXAMPLE
ViSession instrumentHandle;
ViStatus status;
ViInt32 channels[] = {0,1,2,3};
…
status = vtex1629_set_shunt_enabled(instrumentHandle, channels, 4, VI_TRUE);