Gets the average power, in dB, relative to the fundamental power measured at the harmonic specified by the selector string.

Syntax

Namespace: NationalInstruments.RFmx.SpecAnMX

public int GetHarmonicAverageRelativePower(string selectorString, out double value)

Remarks

This method maps to the RFmxSpecAn_HarmGetResultsHarmonicAverageRelativePower() function in C.

Parameters

NameTypeDescription
selectorStringstring

Specifies the result name and harmonic number. Example: "harmonic0", "result::r1/harmonic0". You can use the BuildHarmonicString2(string, int) method to build the selector string.

valueout double

Upon return, contains the average power, in dB, relative to the fundamental power measured at the harmonic specified by the selector string.

Returns

Returns the status code of this method. The status code either indicates success or describes an error or warning condition.