RFmxWCDMA_CfgContiguousCarriers
- Updated2025-04-08
- 2 minute(s) read
Configures the contiguous carriers based on the number of carriers and the carrier at the center frequency.
Syntax
int32 __stdcall RFmxWCDMA_CfgContiguousCarriers(niRFmxInstrHandle instrumentHandle, char selectorString[], int32 numberOfCarriers, int32 carrierAtCenterFrequency)
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. If you do not specify the signal name, the default signal instance is used. The default value is "" (empty string). |
| numberOfCarriers | [in] | int32 | This parameter specifies the number of carriers. The default value is 1. |
| carrierAtCenterFrequency | [in] | int32 | This parameter specifies the index of the carrier that is at the center frequency. Set this parameter to -1 to specify a center frequency at the center of all carriers. For example, if you set the value of the Number of Carriers parameter to 2, and set the value of the Carrier at Center Frequency parameter to 1, the center frequency is at carrier1. If you set the value of the Number of Carriers parameter to 2, and set the value of the Carrier at Center Frequency parameter to -1, the center frequency is at the center of carrier0 and carrier1. If you set the value of the Number of Carriers parameter to 3, and set the value of the Carrier at Center Frequency parameter to either -1 or 1, the center frequency is at carrier1, which is the center of all carriers. |
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 RFmxWCDMA_GetError function.
The general meaning of the status code is as follows:
Value | Meaning |
|---|---|
0 | Success |
Positive Values | Warnings |
Negative Values | Errors |