IviScope_ConfigureNumEnvelopes

CVI/LabWindows IVI Class Driver

IviScope_ConfigureNumEnvelopes

IviScopeMinMaxWaveform Capability Group

C Function Prototype

ViStatus IviScope_ConfigureNumEnvelopes(ViSession vi, ViInt32 numEnvelopes);

Purpose

This function configures the number of waveforms the oscilloscope acquires and analyzes to create the minimum and maximum waveforms.

When the acquisition type is set to IVISCOPE_VAL_ENVELOPE, the oscilloscope acquires multiple waveforms. After each waveform acquisition, the oscilloscope keeps the minimum and maximum values it finds for each element in the waveform record. This function configures the number of waveforms the oscilloscope acquires and analyzes to create the minimum and maximum waveforms.

After the oscilloscope acquires the specified number of waveforms, it returns to the Idle state.

Set the acquisition type to IVISCOPE_VAL_ENVELOPE before calling this function. To set the acquisition type, call the IviScope_ConfigureAcquisitionType function.

Parameters

Name 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.
numEnvelopes ViInt32 Specifies the number of waveforms the oscilloscope acquires and analyzes to create the minimum and maximum waveforms. The driver sets the IVISCOPE_ATTR_NUM_ENVELOPES attribute to this value.

Return Values