IviFgen_CreateArbWaveform

IviFgenArbWfm Capability Group

C Function Prototype

ViStatus IviFgen_CreateArbWaveform (ViSession vi, ViInt32 waveformSize, ViReal64 waveformDataArray[], ViInt32 *waveformHandle);

Purpose

This function creates an arbitrary waveform and returns a handle that identifies that waveform. You pass this handle to the IviFgen_ConfigureArbWaveform function to produce that waveform. You also use the handles that this function returns to specify a sequence of arbitrary waveforms with the IviFgen_CreateArbSequence function.

Parameters

Name	Type	Description
vi	ViSessionClassPrefix_init	The instrument handle that you obtain from the IviFgen_init or IviFgen_InitWithOptions functions. The handle identifies a particular IVI session.
waveformSize	ViInt32	Pass the size of the arbitrary waveform you want create. The size must comply with the following restrictions: The size is less than or equal to the maximum waveform size the instrument allows. The size is greater than or equal to the minimum waveform size that the instrument allows. The size is an integer multiple of the instrument's waveform quantum. You can obtain these values from the maximumWaveformSize, minimumWaveformSize, and waveformQuantum parameters of the IviFgen_QueryArbWfmCapabilities function.
waveform DataArray	ViReal64[]	Specify the array of data you want to use for the new arbitrary waveform. The array must have at least as many elements as the value you specify in the waveformSize parameter. You must normalize the data points in the array to be between –1.00 and +1.00.
waveform Handle	ViInt32 (passed by reference)	Returns the handle that identifies the new arbitrary waveform. You pass this handle to the IviFgen_ConfigureArbWaveform function to generate the arbitrary waveform. You pass an array of these handles to the IviFgen_CreateArbSequence function to create an arbitrary sequence.

Return Values