niFgen_QueryFreqListCapabilities
ViStatus niFgen_QueryFreqListCapabilities (ViSession vi, ViInt32* maximumNumberOfFreqLists, ViInt32* minimumFrequencyListLength, ViInt32* maximumFrequencyListLength, ViReal64* minimumFrequencyListDuration, ViReal64* maximumFrequencyListDuration, ViReal64* frequencyListDurationQuantum);
Purpose
Returns the attributes of the signal generator that are related to creating frequency lists. These attributes are NIFGEN_ATTR_MAX_NUM_FREQ_LISTS, NIFGEN_ATTR_MIN_FREQ_LIST_LENGTH, NIFGEN_ATTR_MAX_FREQ_LIST_LENGTH, NIFGEN_ATTR_MIN_FREQ_LIST_DURATION, NIFGEN_ATTR_MAX_FREQ_LIST_DURATION, and NIFGEN_ATTR_FREQ_LIST_DURATION_QUANTUM.
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. |
| Output | ||
| Name | Type | Description |
| maximumNumberOfFreqLists | ViInt32 | Returns the maximum number of frequency lists that the signal generator allows. NI-FGEN obtains this value from the NIFGEN_ATTR_MAX_NUM_FREQ_LISTS attribute. |
| minimumFrequencyListLength | ViInt32 | Returns the minimum number of steps that the signal generator allows in a frequency list. NI-FGEN obtains this value from the NIFGEN_ATTR_MIN_FREQ_LIST_LENGTH attribute. |
| maximumFrequencyListLength | ViInt32 | Returns the maximum number of steps that the signal generator allows in a frequency list. NI-FGEN obtains this value from the NIFGEN_ATTR_MAX_FREQ_LIST_LENGTH attribute. |
| minimumFrequencyListDuration | ViReal64 | Returns the minimum duration that the signal generator allows in a step of a frequency list. NI-FGEN obtains this value from the NIFGEN_ATTR_MIN_FREQ_LIST_DURATION attribute. |
| maximumFrequencyListDuration | ViReal64 | Returns the maximum duration that the signal generator allows in a step of a frequency list. NI-FGEN obtains this value from the NIFGEN_ATTR_MAX_FREQ_LIST_DURATION attribute. |
| frequencyListDurationQuantum | ViReal64 | Returns the quantum of which all durations must be a multiple in a frequency list. NI-FGEN obtains this value from the NIFGEN_ATTR_FREQ_LIST_DURATION_QUANTUM attribute. |
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:
|