RFmxSpecAn_ACPCfgCarrierFrequency
- Updated2025-04-08
- 1 minute(s) read
Configures the center frequency of the carrier, relative to the RF center frequency.
Use "carrier< <i> n </i> >" as the selector string to configure this function.
Syntax
int32 __stdcall RFmxSpecAn_ACPCfgCarrierFrequency(niRFmxInstrHandle instrumentHandle, char selectorString[], float64 carrierFrequency)
Parameters
Name | Direction | Type | Description |
---|---|---|---|
instrumentHandle | [in] | niRFmxInstrHandle | This parameter specifies the RFmx session refnum. Instrument Handle In is obtained from the RFmxInstr_Initialize function. |
selectorString | [in] | char | This parameter specifies a Selector String comprising of the signal name and carrier number. If you do not specify the signal name, the default signal instance is used. The default value is "carrier0". |
carrierFrequency | [in] | float64 | This parameter specifies the center frequency, in Hz, of the carrier, relative to the RF RFMXSPECAN_ATTR_CENTER_FREQUENCY. The default value is 0. |
Returns
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 RFmx 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 RFmxSpecAn_GetError function.
The general meaning of the status code is as follows:
Value | Meaning |
---|---|
0 | Success |
Positive Values | Warnings |
Negative Values | Errors |