RFmxWCDMA_ModAccFetchRCDE
- Updated2025-04-08
- 2 minute(s) read
Returns the peak relative code domain error (RCDE) value of the active channels, along with the code number, spreading factor, and branch that correspond to this peak value for a carrier in the ModAcc measurement.
Use "carrier<n>" as the selector string to read results from this function.
Syntax
int32 __stdcall RFmxWCDMA_ModAccFetchRCDE(niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64 *peakRCDE, int32 *peakRCDESpreadingFactor, int32 *peakRCDECode, int32 *peakRCDEBranch)
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 carrier 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 "carrier0". | ||||||||||||
timeout | [in] | float64 | This parameter specifies the time for which the function waits for the measurement to complete. This value is expressed in seconds. A value of -1 specifies that the function waits until the measurement is complete. The default value is 10. | ||||||||||||
peakRCDE | [out] | float64 * | This parameter returns the maximum value among the relative code domain errors (RCDEs) for all active channels for a carrier. This value is expressed in dB. | ||||||||||||
peakRCDESpreadingFactor | [out] | int32 * | This parameter returns the spreading factor of the channel corresponding to the value of the Peak RCDE parameter for a carrier. | ||||||||||||
peakRCDECode | [out] | int32 * | This parameter returns the spreading code of the channel corresponding to the value of the Peak RCDE parameter for a carrier. | ||||||||||||
peakRCDEBranch | [out] | int32 * | This parameter returns the branch of the channel corresponding to the value of the Peak RCDE parameter for a carrier.
|
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 |