Configures the harmonic frequency, acquisition bandwidth, and acquisition time for the harmonic, when you set the RFMXSPECAN_ATTR_HARM_AUTO_SETUP_ENABLED attribute to False. Use "harmonic<n>" as the selector string to configure this function. Supported devices: PXIe-5665, PXIe-5668.

Syntax

int32 __stdcall RFmxSpecAn_HarmCfgHarmonic(niRFmxInstrHandle instrumentHandle, char selectorString[], int32 harmonicOrder, float64 harmonicBandwidth, int32 harmonicEnabled, float64 harmonicMeasurementInterval)

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 specifies a Selector String comprising of the signal name and harmonic number. If you do not specify the signal name, the default signal instance is used. The default value is "harmonic0".
Example:
"harmonic0"
"signal::sig1/harmonic0"
You can use the RFmxSpecAn_BuildHarmonicString2 function to build the selector string.

harmonicOrder[in]int32

This parameter specifies the order of the harmonic. The default value is 1.
Frequency of Nth order harmonic = N * (Frequency of fundamental)

harmonicBandwidth[in]float64

This parameter specifies the resolution bandwidth, in Hz, for the harmonic. The default value is 100 kHz.

harmonicEnabled[in]int32

This parameter specifies whether to enable a particular harmonic for measurement. Only the enabled harmonics are used to measure the total harmonic distortion (THD). The default value is True.

Name

Value

Description

RFMXSPECAN_VAL_HARM_HARMONIC_ENABLED_FALSE

0 (0x0)

Disables the harmonic for measurement.

RFMXSPECAN_VAL_HARM_HARMONIC_ENABLED_TRUE

1 (0x1)

Enables the harmonic for measurement.

harmonicMeasurementInterval[in]float64

This parameter specifies the acquisition time, in seconds, for the harmonic. The default value is 1 ms.

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

The general meaning of the status code is as follows:

Value

Meaning

0

Success

Positive Values

Warnings

Negative Values

Errors