Configures the sweep time. Use "range<n>" as the selector string to configure this function. Supported devices: PXIe-5665, PXIe-5668.

Syntax

int32 __stdcall RFmxSpecAn_SpurCfgRangeSweepTime(niRFmxInstrHandle instrumentHandle, char selectorString[], int32 sweepTimeAuto, float64 sweepTimeInterval)

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 range number. If you do not specify the signal name, the default signal instance is used. The default value is "range0".
Example:
"range0"
"signal::sig1/range0"
You can use the RFmxSpecAn_BuildRangeString2 function to build the selector string.

sweepTimeAuto[in]int32

This parameter specifies whether the measurement computes the sweep time. The default value is True.

Name

Value

Description

RFMXSPECAN_VAL_SPUR_SWEEP_TIME_AUTO_FALSE

0 (0x0)

The measurement uses the sweep time that you specify in the RFMXSPECAN_ATTR_SPUR_RANGE_SWEEP_TIME_INTERVAL attribute.

RFMXSPECAN_VAL_SPUR_SWEEP_TIME_AUTO_TRUE

1 (0x1)

The measurement calculates the sweep time based on the value of the RFMXSPECAN_ATTR_SPUR_RANGE_RBW_FILTER_BANDWIDTH attribute.

sweepTimeInterval[in]float64

This parameter specifies the sweep time, in seconds, when you set the Sweep Time Auto parameter to False. 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