Fetches all the spurs across all ranges.

Syntax

int32 __stdcall RFmxSpecAn_SpurFetchAllSpurs(niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64 spurFrequency[], float64 spurAmplitude[], float64 spurMargin[], float64 spurAbsoluteLimit[], int32 spurRangeIndex[], int32 arraySize, int32 *actualArraySize)

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 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 RFmxSpecAn_BuildSignalString 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 array of frequencies, in Hz, of all detected spurs across all ranges.

spurAmplitude[out]float64

This parameter returns the array of powers, in dBm, of all detected spurs across all ranges.

spurMargin[out]float64

This parameter returns the array of the differences between the spur amplitude and the absolute limit at the spur frequency.

spurAbsoluteLimit[out]float64

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

spurRangeIndex[out]int32

This parameter returns the array containing range indices corresponding to the detected spurs.

arraySize[in]int32

Specifies the size of the array. Set the arraySize parameter to 0 to get the size of all the arrays in the actualArraySize parameter.

actualArraySize[out]int32 *

Returns the actual size of the array, if you pass NULL to all output array parameters, and set the arraySize parameter to 0.

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