VTI Instruments EX1629 - Vtex1629_Get_Sample_Frequency

VTI Instruments Corp.
180 EX1629 Command Set
vtex1629_get_sample_frequency
FUNCTION PROTOTYPE
ViStatus vtex1629_get_sample_frequency (ViSession vi, ViPReal64 sampleFrequency);
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.
sampleFrequency = a real return value indicating the currently configured sample frequency in hertz (Hz).
DATA ITEM RESET VALUE
Not applicable to this function.
DESCRIPTION
This function queries and returns the currently configured sample frequency, in hertz (Hz), for all channels. The
EX1629 offers a discrete number of sample frequencies. Programmed values that fall between valid values will be
rounded to the closest valid value. This function returns the actual sample frequency, which, due to this quantization,
may be different from that which was programmed with the vtex1629_set_sample_frequency call.
EXAMPLE
ViSession instrumentHandle;
ViStatus status;
ViReal64 samp_freq;
…
status = vtex1629_get_sample_frequency(instrumentHandle, &samp_freq);