niFgen_ClearArbWaveform
ViStatus niFgen_ClearArbWaveform (ViSession vi, ViInt32 waveformHandle);
Purpose
Removes a previously created arbitrary waveform from the signal generator memory and invalidates the waveform handle.
 |
Note The signal generator must not be in the Generating state when you call this function. |
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. |
| waveformHandle | ViInt32 | Specifies the handle of the arbitrary waveform that you want the signal generator to remove.
You can create multiple arbitrary waveforms using one of the following niFgen Create Waveform functions:
Defined Value: NIFGEN_VAL_ALL_WAVEFORMS—Remove all waveforms from the signal generator. Default Value: None |
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:
|