IviScope_SampleRate

CVI/LabWindows IVI Class Driver

IviScope_SampleRate

IviScopeBase Capability Group

C Function Prototype

ViStatus IviScope_SampleRate (ViSession vi, ViReal64 *sampleRate);

Purpose

This function returns the effective sample rate of the acquired waveform using the current configuration in samples per second.

Parameters

Inputs Type Description
vi ViSession The instrument handle that you obtain from the IviScope_init or IviScope_InitWithOptions functions. The handle identifies a particular IVI session.
     
Outputs Type Description
sampleRate ViReal64 Returns the effective sample rate of the acquired waveform the oscilloscope acquires for each channel. The driver returns the value held in the IVISCOPE_ATTR_HORZ_SAMPLE_RATE attribute.

Return Values