VTI Instruments EX1629 - Vtex1629_Get_Excitation_Enabled

VTI Instruments Corp.
156 EX1629 Command Set
vtex1629_get_excitation_enabled
FUNCTION PROTOTYPE
ViStatus vtex1629_get_excitation_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 excitation source will
be returned. Valid input values: 0 to 47.
enabled = a Boolean return value indicating the enabled status of the excitation source. A returned value of “1”
indicates that the excitation source for the given channel is enabled.
DATA ITEM RESET VALUE
Not applicable to this function.
DESCRIPTION
This function queries and returns the enabled status of the excitation source for a particular channel. An excitation
source that is not enabled will output 0 V, regardless of its programmed value.
EXAMPLE
ViSession instrumentHandle;
ViStatus status;
ViBoolean exc_ena;
…
status = vtex1629_get_excitation_enabled(instrumentHandle, 0, &exc_ena);