niRFSG_QueryArbWaveformCapabilities
C Function Prototype
ViStatus niRFSG_QueryArbWaveformCapabilities (ViSession vi, ViInt32* maxNumberWaveforms, ViInt32* waveformQuantum, ViInt32* minWaveformSize, ViInt32* maxWaveformSize);
Purpose
Queries and returns the waveform capabilities of the NI-RFSG device. These capabilities are related to the current device configuration. The NI-RFSG device must be in the Configuration or the Generation state before calling this function.
Supported Devices: NI 5670/5671/5672
Parameters
| Input | ||
| Name | Type | Description |
| vi | ViSession | Identifies your instrument session. The ViSession handle is obtained from the niRFSG_init function or the niRFSG_InitWithOptions function and identifies a particular instrument session. Default Value: None |
| Output | ||
| Name | Type | Description |
| maxNumberWaveforms | ViInt32* | Returns the value of the NIRFSG_ATTR_ARB_MAX_NUMBER_WAVEFORMSattribute. This value is the maximum number of waveforms you can write. |
| waveformQuantum | ViInt32* | Returns the value of the NIRFSG_ATTR_ARB_WAVEFORM_QUANTUM attribute. If the waveform quantum is q, then the size of the waveform that you write should be a multiple of q. The units are expressed in samples. |
| minWaveformSize | ViInt32* | Returns the value of the NIRFSG_ATTR_ARB_WAVEFORM_SIZE_MIN attribute. The number of samples of the waveform that you write must be greater than or equal to this value. |
| maxWaveformSize | ViInt32* | Returns the value of the NIRFSG_ATTR_ARB_WAVEFORM_SIZE_MAX attribute. The number of samples of the waveform that you write must be less than or equal to this value. |
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. Examine the status code from each call to an instrument driver function to determine if an error occurred.
To obtain a text description of the status code, call the niRFSG_error_message function. To obtain additional information about the error condition, call the niRFSG_GetError function. To clear the error information from the driver, call the niRFSG_ClearError function. The general meaning of the status code is as follows:
|