RFmx SpecAn DOTNET

RFmxSpecAnMXSpurResults.FetchAllSpurs Method

  • Updated2024-07-17
  • 2 minute(s) read
RFmxSpecAnMXSpurResults.FetchAllSpurs Method

RFmxSpecAnMXSpurResultsFetchAllSpurs Method

Fetches all the spurs across all ranges.

Namespace: NationalInstruments.RFmx.SpecAnMX
Assembly: NationalInstruments.RFmx.SpecAnMX.Fx40 (in NationalInstruments.RFmx.SpecAnMX.Fx40.dll) Version: 24.5.0.49286 (24.5.0.49286)

Syntax

public int FetchAllSpurs(
	string selectorString,
	double timeout,
	ref double[] spurFrequency,
	ref double[] spurAmplitude,
	ref double[] spurMargin,
	ref double[] spurAbsoluteLimit,
	ref int[] spurRangeIndex
)
Public Function FetchAllSpurs ( 
	selectorString As String,
	timeout As Double,
	ByRef spurFrequency As Double(),
	ByRef spurAmplitude As Double(),
	ByRef spurMargin As Double(),
	ByRef spurAbsoluteLimit As Double(),
	ByRef spurRangeIndex As Integer()
) As Integer

Parameters

selectorString  String
Specifies the signal name and result name. Example: "signal::sig1", "result::r1" "signal::sig1/result::r1". You can use the BuildRangeString2(String, Int32) method to build the selector string.
timeout  Double
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 method waits until the measurement is complete.
spurFrequency  Double
Upon return, contains the array of frequencies, in hertz (Hz), of all detected spurs across all ranges.
spurAmplitude  Double
Upon return, contains the array of powers, in dBm, of all detected spurs across all ranges.
spurMargin  Double
Upon return, contains the array of differences between the spur amplitude and the absolute limit at the spur frequency.
spurAbsoluteLimit  Double
Upon return, contains the array of thresholds, in dBm, used to calculate the margin of the detected spurs.
spurRangeIndex  Int32
Upon return, contains the array containing range indices corresponding to the detected spurs.

Return Value

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

Remarks

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

See Also