RFmxLTE_SEMCfgOffsetFrequencyArray
- Updated2025-04-08
- 2 minute(s) read
Configures the arrays of the start and stop frequencies and the sideband of an offset segment.
Use "subblock<n>" as the selector string to configure this function.
Syntax
int32 __stdcall RFmxLTE_SEMCfgOffsetFrequencyArray(niRFmxInstrHandle instrumentHandle, char selectorString[], float64 offsetStartFrequency[], float64 offsetStopFrequency[], int32 offsetSideband[], int32 numberOfElements)
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, result name, and subblock number. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used. The default value is "subblock0". | ||||||||||||
offsetStartFrequency | [in] | float64 | This parameter specifies the array of the start frequency values of the offset segment relative to the carrier channel bandwidth edge (single-carrier) or the subblock aggregated channel bandwidth edge (multi-carrier). This value is expressed in Hz. The default value is 0. | ||||||||||||
offsetStopFrequency | [in] | float64 | This parameter specifies the array of the stop frequency values of the offset segment relative to the carrier channel bandwidth edge (single-carrier) or the subblock aggregated channel bandwidth edge (multi-carrier). This value is expressed in Hz. The default value is 1 MHz. | ||||||||||||
offsetSideband | [in] | int32 | This parameter specifies whether the offset segment is present on one side, or on both sides of the carrier for each offset. The default value is Both.
| ||||||||||||
numberOfElements | [in] | int32 | Specifies the number of elements in each array. |
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 RFmxLTE_GetError function.
The general meaning of the status code is as follows:
Value | Meaning |
---|---|
0 | Success |
Positive Values | Warnings |
Negative Values | Errors |