RFmxWLAN_SEMFetchUpperOffsetPower
- Updated2025-04-08
- 2 minute(s) read
Returns the total absolute and relative powers, peak absolute and relative powers and frequency at peak absolute power of upper offset segment. The relative power is relative to the peak power of the carrier.
Syntax
int32 __stdcall RFmxWLAN_SEMFetchUpperOffsetPower(niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64 *totalAbsolutePower, float64 *totalRelativePower, float64 *peakAbsolutePower, float64 *peakFrequency, float64 *peakRelativePower)
Remarks
Use "segment<n>/chain<k>/offset<<i>l</i>>" as the selector string to read results from this function.
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 or the RFmxInstr_InitializeFromNIRFSASessionArray function. |
| selectorString | [in] | char | This parameter specifies a Selector String comprising of the signal name, result name, segment number, chain number, and offset number. If you do not specify the signal name, the default signal instance is used. The default value is "segment0/chain0/offset0". |
| timeout | [in] | float64 | This parameter specifies the timeout for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the function waits until the measurement is complete. This value is expressed in seconds. The default value is 10. |
| totalAbsolutePower | [out] | float64 * | This parameter returns the average power of the upper (positive) offset over the bandwidth determined by the offset start and stop frequencies. This value is expressed in dBm. |
| totalRelativePower | [out] | float64 * | This parameter returns the average power of the upper offset relative to the peak power of the carrier channel. This value is expressed in dB. |
| peakAbsolutePower | [out] | float64 * | This parameter returns the peak power of the upper offset. This value is expressed in dBm. |
| peakFrequency | [out] | float64 * | This parameter returns the frequency at which the peak power occurs in the upper offset. This value is expressed in Hz. |
| peakRelativePower | [out] | float64 * | This parameter returns the peak power of the upper offset, relative to the peak power of the carrier channel. This value is expressed in dBm. |
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 RFmxWLAN_GetError function.
The general meaning of the status code is as follows:
Value | Meaning |
|---|---|
0 | Success |
Positive Values | Warnings |
Negative Values | Errors |