RFmxWLAN_TXPFetchMeasurement
- Updated2025-04-08
- 2 minute(s) read
Returns the average power and the peak power of the signal over which power measurements are performed.
Use "segment<n>/chain<k>" as the selector string to read results from this function.
Syntax
int32 __stdcall RFmxWLAN_TXPFetchMeasurement(niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64 *averagePowerMean, float64 *peakPowerMaximum)
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, and chain 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 "segment0/chain0". |
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. |
averagePowerMean | [out] | float64 * | This parameter returns the average power of the acquired signal. This value is expressed in dBm. When you set the RFMXWLAN_ATTR_TXP_AVERAGING_ENABLED attribute to True, this parameter returns the mean of the average power computed for each averaging count. |
peakPowerMaximum | [out] | float64 * | This parameter returns the peak power of the acquired signal. This value is expressed in dBm. When you set the TXP Averaging Enabled attribute to True, this parameter returns the maximum of the peak power computed for each averaging count. |
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 |