Gets the frequency, in hertz (Hz), at which the peak power occurred in the carrier channel.

Syntax

Namespace: NationalInstruments.RFmx.SpecAnMX

public int GetCarrierPeakFrequency(string selectorString, out double value)

Remarks

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

Parameters

NameTypeDescription
selectorStringstring

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

valueout double

Upon return, contains the frequency, in Hz, at which the peak power occurred in the carrier channel.

Returns

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