niFgen_QueryArbWfmCapabilities
ViStatus niFgen_QueryArbWfmCapabilities (ViSession vi, ViInt32* maximumNumberofWaveforms, ViInt32* waveformQuantum, ViInt32* minimumWaveformSize, ViInt32* maximumWaveformSize);
Purpose
Returns the attributes of the signal generator that are related to creating arbitrary waveforms. These attributes are the maximum number of waveforms, waveform quantum, minimum waveform size, and maximum waveform size.
 |
Note If you do not want to obtain the waveform quantum, pass a value of VI_NULL for this parameter. |
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 |
| maximumNumberofWaveforms | ViInt32* | Returns the maximum number of arbitrary waveforms that the signal generator allows. NI-FGEN obtains this value from the NIFGEN_ATTR_MAX_NUM_WAVEFORMS attribute. |
| waveformQuantum | ViInt32* | The size (number of points) of each waveform must be a multiple of a constant quantum value. This parameter obtains the quantum value that the signal generator uses. NI-FGEN returns this value from the NIFGEN_ATTR_WAVEFORM_QUANTUM attribute.
For example, when this attribute returns a value of 8, all waveform sizes must be a multiple of 8. |
| minimumWaveformSize | ViInt32* | Returns the minimum number of points that the signal generator allows in a waveform. NI-FGEN obtains this value from the NIFGEN_ATTR_MIN_WAVEFORM_SIZE attribute. |
| maximumWaveformSize | ViInt32* | Returns the maximum number of points that the signal generator allows in a waveform. NI-FGEN obtains this value from the NIFGEN_ATTR_MAX_WAVEFORM_SIZE 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:
|