niFgen_ClearFreqList
- Updated2023-02-21
- 2 minute(s) read
ViStatus niFgen_ClearFreqList (ViSession vi, ViInt32 frequencyListHandle);
Purpose
Removes a previously created frequency list from the signal generator memory and invalidates the frequency list 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, niFgen_InitWithOptions, or niFgen_InitializeWithChannels functions and identifies a particular instrument session. |
| frequencyListHandle | ViInt32 | Specifies the handle of the frequency list you want the signal generator to remove. You create multiple frequency lists using niFgen_CreateFreqList. niFgen_CreateFreqList returns a handle that you use to identify each list. Specify a value of -1 to clear all frequency lists.
Defined Value NIFGEN_VAL_ALL_FLISTS—Remove all frequency lists 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:
|