Fetches the FM maximum deviation measurements.

Syntax

int32 __stdcall RFmxDemod_ADemodFetchFMMaximumDeviation(niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64 *maximumDeviation, float64 *maximumHalfPeakToPeak, float64 *maximumRMS, float64 *maximumPositivePeak, float64 *maximumNegativePeak)

Parameters

NameDirectionTypeDescription
instrumentHandle[in]niRFmxInstrHandle

This parameter specifies the RFmx session refnum. Instrument Handle In is obtained from the RFmxInstr_Initialize function.

selectorString[in]char[]

This parameter comprises the signal name and result name. 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 "" (empty string).

Example:

""

"signal::sig1"

"result::r1"

"signal::sig1/result::r1"

You can use the RFmxDemod_BuildSignalString function to build the Selector String.

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. The default value is 10. This value is expressed in seconds.

maximumDeviation[out]float64 *

This parameter returns the maximum frequency deviation, in Hz, of the frequency-modulated signal measured across multiple acquisitions.

maximumHalfPeakToPeak[out]float64 *

This parameter returns the maximum (peak-to-peak)/2 frequency variation, in Hz, around the nominal frequency of the FM carrier measured across multiple acquisitions.

maximumRMS[out]float64 *

This parameter returns the maximum RMS frequency deviation, in Hz, of the frequency-modulated signal measured across multiple acquisitions.

maximumPositivePeak[out]float64 *

This parameter returns the maximum positive peak frequency deviation, in Hz, of the frequency-modulated signal measured across multiple acquisitions.

maximumNegativePeak[out]float64 *

This parameter returns the maximum negative peak frequency deviation, in Hz, of the frequency-modulated signal measured across multiple acquisitions.

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 RFmxDemod_GetError function.

The general meaning of the status code is as follows:

Value

Meaning

0

Success

Positive Values

Warnings

Negative Values

Errors