niBTSG_RFSGRetrieveIQRate
- Updated2025-04-08
- 1 minute(s) read
Returns the I/Q rate stored in the RFSG database. The function uses the waveform name as the key to retrieve the waveform attributes.
Syntax
int32 __stdcall niBTSG_RFSGRetrieveIQRate(ViSession rfsgHandle, ViChar channelString, ViChar waveformName, float64 *iqRate)
Parameters
| Name | Direction | Type | Description |
|---|---|---|---|
| rfsgHandle | [in] | ViSession | Identifies the instrument session. You can obtain this parameter from the niRFSG_init function or the niRFSG_InitWithOptions function. |
| channelString | [in] | ViChar | Set this parameter to "" (empty string) or NULL. |
| waveformName | [in] | ViChar | Specifies the name of the waveform for which you want to retrieve the I/Q rate. The BT Generation uses the waveformName parameter as the key to retrieve the waveform attributes from the RFSG database. |
| iqRate | [out] | float64 * | Returns the I/Q rate stored in the RFSG database for the waveform that you specify in the waveformName parameter. |
Returns
Returns the status code of this operation. The status code either indicates success or describes an error or warning. Examine the status code from each call to an niBT SG function to determine if an error has occurred. To obtain a text description of the status code and additional information about the error condition, call the niBTSG_GetErrorString function. The general meaning of the status code is as follows:
Value | Meaning |
|---|---|
0 | Success |
Positive Values | Warnings |
Negative Values | Errors |