Fetches the information of Spurs in the range. Use "range<n>/spur<k>" as the selector string to read results from this function.</k></n>

Syntax

int32 __stdcall RFmxSpecAn_SpurFetchSpurMeasurement(niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64 *spurFrequency, float64 *spurAmplitude, float64 *spurMargin, float64 *spurAbsoluteLimit)

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, result name, range number, and spur number. 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.
Example:
"range0/spur0"
"signal::sig1/range0/spur0"
"signal::sig1/result::r1/range0/spur0"
"result::r1/range0/spur0"
You can use the RFmxSpecAn_BuildSpurString2 function to build the selector string.

timeout[in]float64

This parameter specifies the timeout, in seconds, 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.

spurFrequency[out]float64 *

This parameter returns the frequency, in Hz, of the detected spur.

spurAmplitude[out]float64 *

This parameter returns the power, in dBm, of the detected spur.

spurMargin[out]float64 *

This parameter returns the difference between the spur amplitude and the absolute limit at the spur frequency.

spurAbsoluteLimit[out]float64 *

This parameter returns the threshold, in dBm, used to calculate the margin of the detected spur.

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