FetchPreamblePeakPowersCommon(string, double, out double, out double, out double)
- Updated2025-04-08
- 2 minute(s) read
Fetches the peak power of the preamble fields.
Use "segment(n)/chain(k)" as the selector string to read results from this method.
Syntax
Namespace: NationalInstruments.RFmx.WlanMX
public int FetchPreamblePeakPowersCommon(string selectorString, double timeout, out double lStfPeakPowerMaximum, out double lLtfPeakPowerMaximum, out double lSigPeakPowerMaximum)
Parameters
| Name | Type | Description |
|---|---|---|
| selectorString | string | Specifies a selector string comprising of the result name, segment number, and chain number. If you do not specify the result name, the default result instance is used. Example: |
| timeout | double | 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 method waits until the measurement is complete. This value is expressed in seconds. |
| lStfPeakPowerMaximum | out double | Upon return, contains the peak power of the L-STF or STF field. When you set the SetAveragingEnabled(string, RFmxWlanMXOfdmModAccAveragingEnabled) method to True , this parameter returns the maximum of the L-STF or STF peak power results computed for each averaging count. This value is expressed in dBm. |
| lLtfPeakPowerMaximum | out double | Upon return, contains the peak power of the L-LTF or LTF field. When you set the OFDMModAccAveragingEnabled method to True , this parameter returns the maximum of the L-LTF or LTF peak power results computed for each averaging count. This value is expressed in dBm. |
| lSigPeakPowerMaximum | out double | Upon return, contains the peak power of the L-SIG or SIGNAL field. When you set the OFDMModAccAveragingEnabled method to True , this parameter returns the maximum of the L-SIG or SIGNAL field peak power results computed for each averaging count. This value is expressed in dBm. |
Returns
Returns the status code of this method. The status code either indicates success or describes a warning condition.