[OBSOLETE] niFgen_CreateArbWaveform
ViStatus niFgen_CreateArbWaveform (ViSession vi, ViInt32 waveformSize, ViReal64[] waveformDataArray, ViInt32* waveformHandle);
Purpose
[OBSOLETE] This function is obsolete. Use the niFgen_CreateWaveformF64, niFgen_CreateWaveformI16, or niFgen_CreateWaveformComplexF64 function instead of this function.
Creates an arbitrary waveform and returns a handle that identifies that waveform. You can pass this handle to the niFgen_ConfigureArbWaveform function to produce that waveform. You can also use the handles this function returns to specify a sequence of arbitrary waveforms with the niFgen_CreateArbSequence function.
 |
Note You must set the output mode to NIFGEN_VAL_OUTPUT_ARB before calling this function. |
|
Note You must scale the data between –1.00 and +1.00. Use the arbGain parameter to generate different output voltages. |
Parameters
| Input | ||
| Name | Type | Description |
| vi | ViSession | Identifies your instrument session. vi is obtained from the niFgen_init or the niFgen_InitWithOptions functions and identifies a particular instrument session. |
| waveformSize | ViInt32 | Specifies the size of the arbitrary waveform that you want created. The size must meet the following restrictions:
You can obtain these values from the maximumWaveformSize, minimumWaveformSize, and waveformQuantum parameters in the niFgen_QueryArbWfmCapabilities function. Default Value: None |
| waveformDataArray | ViReal64[] | Specifies 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 that you specify in waveformSize.
You must normalize the data points in the array to be between –1.00 and +1.00. Default Value: None |
| Output | ||
| Name | Type | Description |
| waveformHandle | ViInt32* | The handle that identifies the new waveform. This handle is used later when referring to this waveform. |
Return Value
| Name | Type | Description | ||||||||
| Status | ViStatus | Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. You can examine the status code from each call to an NI-FGEN function to determine if an error occurred.
To obtain a text description of the status code, call the niFgen_error_message function. To obtain additional information about the error condition, call the niFgen_GetError function. To clear the error information from NI-FGEN, call the niFgen_ClearError function. The general meaning of the status code is as follows:
|