Selects either the default calset of the specified signal or a named calset accessible across all signals as active calset for the specified signal.

Syntax

int32 __stdcall RFmxVNA_SelectActiveCalset(niRFmxInstrHandle instrumentHandle, char selectorString[], char calsetName[], int32 restoreConfiguration)

Remarks

  • Calset Name is "" (empty string): RFmx selects the default calset as the active calset for the signal instance specified in the Selector String. If you do not specify a Signal Name, then default RFmxVNA signal instance is used.

  • Calset Name is non-empty string: RFmx selects the named calset as the active calset for the signal instance specified in the Selector String. If you do not specify a Signal Name, then default RFmxVNA signal instance is used.

Parameters

NameDirectionTypeDescription
instrumentHandle[in]niRFmxInstrHandle

This parameter specifies the RFmx session refnum.

selectorString[in]char

This parameter specifies a Selector String comprising of the signal name. If you do not specify the signal name, the default signal instance is used. The default value is "" (empty string).

Example:

You can use the RFmxVNA_BuildSignalString function to build the selector string.

calsetName[in]char

This parameter specifies the name of the calset. If you do not specify this parameter, the calset is saved as default calset for the specified signal and is not available for use in other signals. If you specify non-empty Calset Name string, calset is saved as a named calset available for use across all signals and is also selected as the active calset for the current signal.

restoreConfiguration[in]int32

This parameter specifies whether the stimulus settings from the specified calset should be applied to the signal.

Name (Value)

Description

None (0)

Do not apply the stimulus settings from the calset.

Stimulus (1)

Applies the stimulus settings from the calset. List of stimulus settings that will be applied are as follows: SweepType List Sweep Type: IF Bandwidth, Power Level per Port, Test Receiver Attenuation per Port, Frequency List Linear Sweep Type: IF Bandwidth, Power Level per Port, Test Receiver Attenuation per Port, Start Frequency, Stop Frequency and Number of Frequency Points Segment Sweep Type: Segment IF Bandwidth, Segment Power Level per Port, Segment Test Receiver Attenuation per Port, Segment Start Frequency, Segment Stop Frequency and Segment Number of Frequency Points

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

The general meaning of the status code is as follows:

Value

Meaning

0

Success

Positive Values

Warnings

Negative Values

Errors