Skip to content

NI RFmx Instruments Configuration Functions

Jump to bottom
Alex Starche edited this page Mar 1, 2022 · 1 revision

Configuration Functions

RFmxInstr_CfgFrequencyReference

int32 __stdcall RFmxInstr_CfgFrequencyReference (niRFmxInstrHandle instrumentHandle, char channelName[], char frequencyReferenceSource[], float64 frequencyReferenceFrequency);

Purpose

Configures the Reference Clock and the frequency reference source.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Identifies the instrument session. This parameter is obtained from the RFmxInstr_Initialize function or the RFmxInstr_InitializeFromNIRFSASessionArray function.
channelName char[] Specifies the channel to which the settings must be applied. Specify an empty string as the value of this parameter.
frequencyReferenceSource char[] Specifies the frequency reference source.
RFMXINSTR_VAL_ONBOARD_CLOCK_STR (OnboardClock)

PXIe-5663/5663E: RFmx locks the PXIe-5663/5663E to the PXIe-5652 LO source onboard clock. Connect the REF OUT2 connector (if it exists) on the PXIe-5652 to the PXIe-5622 CLK IN terminal. On versions of the PXIe-5663/5663E that lack a REF OUT2 connector on the PXIe-5652, connect the REF IN/OUT connector on the PXIe-5652 to the PXIe-5622 CLK IN terminal.

PXIe-5665: RFmx locks the PXIe-5665 to the PXIe-5653 LO source onboard clock. Connect the 100 MHz REF OUT terminal on the PXIe-5653 to the PXIe-5622CLK IN terminal.

PXIe-5668: Lock the PXIe-5668 to the PXIe-5653 LO SOURCE onboard clock. Connect the LO2 OUT connector on the PXIe-5606 to the CLK IN connector on the PXIe-5624.

PXIe-5644/5645/5646, PXIe-5820/5840/5841: RFmx locks the device to its onboard clock.

PXIe-5830/5831/5832: For the PXIe-5830, connect the PXIe-5820 REF IN connector to the PXIe-3621 REF OUT connector. For the PXIe-5831, connect the PXIe-5820 REF IN connector to the PXIe-3622 REF OUT connector.

For PXIe-5832, connect the PXIe-5820 REF IN connector to the PXIe-3623 REF OUT connector.

PXIe-5831 with PXIe-5653: Connect the PXIe-5820 REF IN connector to the PXIe-3622 REF OUT connector. Connect the PXIe-5653 REF OUT (10 MHz) connector to the PXIe-3622 REF IN connector.

PXIe-5832 with PXIe-5653: Connect the PXIe-5820 REF IN connector to the PXIe-3623 REF OUT connector. Connect the PXIe-5653 REF OUT (10 MHz) connector to the PXIe-3623 REF IN connector.

PXIe-5840 with PXIe-5653: Lock onto the PXIe-5653 onboard clock. Connect the REF OUT (10 MHz) connector on the PXIe-5653 to the PXIe-5840 REF IN connector. Configure open NI-RFSG sessions to the device to use RFMXINSTR_VAL_REF_IN_STR for PXIe-5840 or RFMXINSTR_VAL_REF2_IN_STR for the PXIe-5840 with the PXIe-5653.
RFMXINSTR_VAL_REF_IN_STR (RefIn)

PXIe-5663/5663E: Connect the external signal to the PXIe-5652 REF IN/OUT connector. Connect the REF OUT2 connector (if it exists) on the PXIe-5652 to the PXIe-5622 CLK IN terminal.

PXIe-5665: Connect the external signal to the PXIe-5653 REF IN connector. Connect the 100 MHz REF OUT terminal on the PXIe-5653 to the PXIe-5622 CLK IN connector. If your external clock signal frequency is set to a frequency other than 10 MHz, set the frequencyReferenceFrequency parameter according to the frequency of your external clock signal.

PXIe-5668: Connect the external signal to the PXIe-5653 REF IN connector. Connect the LO2 OUT on the PXIe-5606 to the CLK IN connector on the PXIe-5622. If your external clock signal frequency is set to a frequency other than 10 MHz, set the frequencyReferenceFrequency parameter according to the frequency of your external clock signal.

PXIe-5644/5645/5646, PXIe-5820/5840/5841: RFmx locks the device to the signal at the external REF IN connector.

PXIe-5830/5831/5832: For PXIe-5830, connect the PXIe-5820 REF IN connector to the PXIe-3621 REF OUT connector. For the PXIe-5831, connect the PXIe-5820 REF IN connector to the PXIe-3622 REF OUT connector. For the PXIe-5832, connect the PXIe-5820 REF IN connector to the PXIe-3623 REF OUT connector. For PXIe-5830, lock the external signal to the PXIe-3621 REF IN connector. For the PXIe-5831, lock the external signal to the PXIe-3622 REF IN connector. For the PXIe-5832, lock the external signal to the PXIe-3623 REF IN connector.

PXIe-5831 with PXIe-5653: Connect the PXIe-5820 REF IN connector to the PXIe-3622 REF OUT connector. Connect the PXIe-5653 REF OUT (10 MHz) connector to the PXIe-3622 REF IN connector. Lock the external signal to the PXIe-5653 REF IN connector.

PXIe-5832 with PXIe-5653: Connect the PXIe-5820 REF IN connector to the PXIe-3623 REF OUT connector. Connect the PXIe-5653 REF OUT (10 MHz) connector to the PXIe-3623 REF IN connector. Lock the external signal to the PXIe-5653 REF IN connector.

PXIe-5840 with PXIe-5653: Lock onto the PXIe-5653 onboard clock. Connect the REF OUT (10 MHz) connector on the PXIe-5653 to the PXIe-5840 REF IN connector. Configure open NI-RFSG sessions to the device to use RFMXINSTR_VAL_REF_IN_STR for PXIe-5840 or RefIn2 for the PXIe-5840 with the PXIe-5653.

PXIe-5831 with PXIe-5653: Lock the external signal to the PXIe-5653 REF IN connector.

PXIe-5832 with PXIe-5653: Lock the external signal to the PXIe-5653 REF IN connector.

PXIe-5840 with PXIe-5653: Lock to the signal at the REF IN connector on the associated PXIe-5653. Connect the REF OUT (10 MHz) connector on the PXIe-5653 to the PXIe-5840 REF IN connector.
RFMXINSTR_VAL_PXI_CLK_STR(PXI_Clk)

PXIe-5668: Lock the PXIe-5653 to the PXI backplane clock. Connect the PXIe-5606 LO2 OUT to the LO2 IN connector on the PXIe-5624.

PXIe-5644/5645/5646, PXIe-5663/5663E/5665, and PXIe-5820/5830/5831/5831 with PXIe-5653/5832/5832 with PXIe-5653/5840/5841/5840 with PXIe-5653:: RFmx locks these devices to the PXI backplane clock.
RFMXINSTR_VAL_CLK_IN_STR (ClkIn)

PXIe-5663/5663E: RFmx locks the PXIe-5663/5663E to an external 10 MHz signal. Connect the external signal to the PXIe-5622 CLK IN connector, and connect the PXIe-5622 CLK OUT connector to the REF IN/OUT connector on the PXIe-5652.

PXIe-5665: RFmx locks the PXIe-5665 to an external 100 MHz signal. Connect the external signal to the PXIe-5622 CLK IN connector, and connect the PXIe-5622 CLK OUT connector to the REF IN connector on the PXIe-5653. Set the frequencyReferenceFrequency parameter to 100 MHz.

PXIe-5668: Lock the PXIe-5668 to an external 100 MHz signal. Connect the external signal to the CLK IN connector on the PXIe-5624, and connect the PXIe-5624 CLK OUT connector to the REF IN connector on the PXIe-5653. Set the frequencyReferenceFrequency parameter to 100 MHz.

PXIe-5644/5645/5646, PXIe-5820/5830/5831/5831 with PXIe-5653/5832/5832 with PXIe-5653/5840/5841/5840 with PXIe-5653: This configuration does not apply.
RFMXINSTR_VAL_REF2_IN_STR (RefIn2)

PXIe-5840 with PXIe-5653: RFmx locks the reference clock to the clock sourced at the PXIe-5840 REF IN terminal that is previously configured by an NI-RFSG session. Connect the PXIe-5840 REF OUT connector to the PXIe-5653 REF IN connector.

Configure open NI-RFSG sessions to the device to use RFMXINSTR_VAL_REF_IN_STR for the PXIe-5840 or RFMXINSTR_VAL_ONBOARD_CLOCK_STR for the PXIe-5840 with PXIe-5653.

This configuration does not apply for PXIe-5663/5663E/5665/5668, PXIe-5644/5645/5646, and PXIe-5820/5830/5831/5831 with PXIe-5653/5832/5832 with PXIe-5653/5840/5841.

PXIe-5663/5663E/5665/5668, PXIe-5644/5645/5646, and PXIe-5820/5830/5831/5831 with PXIe-5653/5832/5832 with PXIe-5653/5840/5841: This configuration does not apply.
RFMXINSTR_VAL_PXI_CLKMASTER_IN_STR (PXI_ClkMaster)

PXIe-5831 with PXIe-5653: RFmx configures the PXIe-5653 to export the reference clock and configures the PXIe-5820 with PXIe-3622 to use RFMXINSTR_VAL_PXI_CLK_STR as the reference clock source. You must connect the PXIe-5653 REF OUT (10 MHz) connector to the PXI chassis REF IN connector. PXIe-5832 with PXIe-5653: RFmx configures the PXIe-5653 to export the reference clock and configures the PXIe-5820 with PXIe-3623 to use RFMXINSTR_VAL_PXI_CLK_STR as the reference clock source. You must connect the PXIe-5653 REF OUT (10 MHz) connector to the PXI chassis REF IN connector.

PXIe-5840 with PXIe-5653: RFmx configures the PXIe-5653 to export the reference clock, and configures PXIe-5840/5841 to use RFMXINSTR_VAL_PXI_CLK_STR. Connect the PXIe-5653 REF OUT (10 MHz) connector to the PXIe-5840 REF IN connector for this configuration. For best performance, configure all other devices in the system to use RFMXINSTR_VAL_PXI_CLK_STR as the reference clock source. PXIe-5663/5663E/5665/5668, PXIe-5644/5645/5646, PXIe-5820/5830/5831/5832/5840/5841: This configuration does not apply.
frequencyReferenceFrequency float64 Specifies the Reference Clock rate when you set the frequencyReferenceSource parameter to RFMXINSTR_VAL_CLK_IN_STR or RFMXINSTR_VAL_REF_IN_STR. This value is expressed in Hz.

Return Value

Name Type Description
status int32 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 RFmxInstr_GetError) function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxInstr_CfgRFAttenuation

int32 __stdcall RFmxInstr_CfgRFAttenuation (niRFmxInstrHandle instrumentHandle, char channelName[], int32 rfAttenuationAuto, float64 rfAttenuationValue);

Purpose

Configures the nominal attenuation and RFmx attenuation hardware settings.

Supported devices: PXIe-5663/5663E, PXIe-5665, PXIe-5668

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Identifies the instrument session. This parameter is obtained from the RFmxInstr_Initialize function or the RFmxInstr_InitializeFromNIRFSASessionArray function.
channelName char[] Specifies the channel to which the settings must be applied. Specify an empty string as the value of this parameter.
rfAttenuationAuto int32

Specifies whether RFmx computes the RF attenuation.

If you set this parameter to True, RFmx automatically chooses an attenuation setting based on the reference level configured on the personality.
RFMXINSTR_VAL_RF_ATTENUATION_AUTO_FALSE (0) Specifies that RFmx uses the value configured using the rfAttenuationValue parameter.
RFMXINSTR_VAL_RF_ATTENUATION_AUTO_TRUE (1) Specifies that RFmx computes the RF attenuation.
rfAttenuationValue float64

Specifies the nominal attenuation setting for all attenuators that are present before the first mixer in the RF signal chain. This value is expressed in dB.

If you set the RF Attenuation Auto parameter to True, RFmx chooses an attenuation setting automatically.

Return Value

Name Type Description
status int32 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 RFmxInstr_GetError) function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxInstr_CfgMechanicalAttenuation

int32 __stdcall RFmxInstr_CfgMechanicalAttenuation (niRFmxInstrHandle instrumentHandle, char channelName[], int32 mechanicalAttenuationAuto, float64 mechanicalAttenuationValue);

Purpose

Configures the mechanical attenuation and RFmx attenuation hardware settings.

Supported devices: PXIe-5663/5663E, PXIe-5665, PXIe-5668

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Identifies the instrument session. This parameter is obtained from the RFmxInstr_Initialize function or the RFmxInstr_InitializeFromNIRFSASessionArray function.
channelName char[] Specifies the channel to which the settings must be applied. Specify an empty string as the value of this parameter.
mechanicalAttenuationAuto int32 Specifies whether RFmx chooses an attenuation setting based on the hardware settings.
RFMXINSTR_VAL_MECHANICAL_ATTENUATION_AUTO_FALSE (0) Specifies that RFmx uses the value configured in the mechanicalAttenuationValue parameter.
RFMXINSTR_VAL_MECHANICAL_ATTENUATION_AUTO_TRUE (1) Specifies that the measurement computes the mechanical attenuation.
mechanicalAttenuationValue float64 Specifies the level of mechanical attenuation for the RF path. This value is expressed in dB.

Return Value

Name Type Description
status int32 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 RFmxInstr_GetError) function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxInstr_ExportSignal

int32 __stdcall RFmxInstr_ExportSignal (niRFmxInstrHandle instrumentHandle, int32 exportSignalSource, char exportSignalOutputTerminal[]);

Purpose

Routes signals (triggers, clocks, and events) to the specified output terminal. This function is not supported on a MIMO session.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Identifies the instrument session. This parameter is obtained from the RFmxInstr_Initialize function or the RFmxInstr_InitializeFromNIRFSASessionArray function.
exportSignalSource int32 Controls the source used to export signals.
RFMXINSTR_VAL_START_TRIGGER (0) Start trigger is sourced.
RFMXINSTR_VAL_REFERENCE_TRIGGER (1) Reference trigger is sourced.
RFMXINSTR_VAL_ADVANCE_TRIGGER (2) Advance trigger is sourced.
RFMXINSTR_VAL_READY_FOR_START_EVENT (3) Ready for Start event is sourced.
RFMXINSTR_VAL_READY_FOR_ADVANCE_EVENT (4) Ready for Advance event is sourced.
RFMXINSTR_VAL_READY_FOR_REFERENCE_EVENT (5) Ready for Reference event is sourced.
RFMXINSTR_VAL_END_OF_RECORD_EVENT (6) End of Record event is sourced.
RFMXINSTR_VAL_DONE_EVENT (7) Done event is sourced.
RFMXINSTR_VAL_REFERENCE_CLOCK (8) Reference Clock is exported.
exportSignalOutputTerminal char[] Specifies the terminal where the signal is exported. You can also choose not to export any signal.
RFMXINSTR_VAL_DO_NOT_EXPORT_STR () Does not export the signal.
RFMXINSTR_VAL_CLK_OUT (CLK_OUT) Export the Reference Clock on the CLK OUT terminal on the digitizer. This value is not valid for the PXIe-5644/5645/5646 or PXIe-5820/5830/5831/5832/5840/5841.
RFMXINSTR_VAL_REF_OUT (REF_OUT) The signal is exported to the REF IN/OUT terminal on the PXIe-5652, the REF OUT terminals on the PXIe-5653, or the REF OUT terminal on the PXIe-5644/5645/5646, or PXIe-5820/5830/5831/5832/5840/5841.
RFMXINSTR_VAL_REF_OUT_2 (REF_OUT_2) The signal is exported to the REF OUT2 terminal on the LO. This connector exists only on some versions of the PXIe-5652.
RFMXINSTR_VAL_PFI0_STR (PFI0) Exports the signal to the PFI 0 connector on the PXIe-5142.
RFMXINSTR_VAL_PFI1_STR (PFI1) Exports the signal to the PFI 1 connector on the PXIe-5142 and PXIe-5622.
RFMXINSTR_VAL_PXI_TRIG0_STR (PXI_Trig0) Exports the signal to the PXI trigger line 0.
RFMXINSTR_VAL_PXI_TRIG1_STR (PXI_Trig1) Exports the signal to the PXI trigger line 1.
RFMXINSTR_VAL_PXI_TRIG2_STR (PXI_Trig2) Exports the signal to the PXI trigger line 2.
RFMXINSTR_VAL_PXI_TRIG3_STR (PXI_Trig3) Exports the signal to the PXI trigger line 3.
RFMXINSTR_VAL_PXI_TRIG4_STR (PXI_Trig4) Exports the signal to the PXI trigger line 4.
RFMXINSTR_VAL_PXI_TRIG5_STR (PXI_Trig5) Exports the signal to the PXI trigger line 5.
RFMXINSTR_VAL_PXI_TRIG6_STR (PXI_Trig6) Exports the signal to the PXI trigger line 6.
RFMXINSTR_VAL_PXIE_DSTARC_STR (PXIE_DSTARC) Exports the signal to the PXI DStar C trigger line. This value is valid only on PXIe-5820/5830/5831/5832/5840/5841.

Return Value

Name Type Description
status int32 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 RFmxInstr_GetError) function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxInstr_SendSoftwareEdgeStartTrigger

int32 __stdcall RFmxInstr_SendSoftwareEdgeStartTrigger (niRFmxInstrHandle instrumentHandle);

Purpose

Sends a trigger to the waiting device when you choose a software version of Start trigger. You can also use this function to override a hardware trigger. This function returns an error if:

  • You configure an invalid trigger.
  • You have not previously called the RFmx Initiate function.

Supported Devices: PXIe-5644/5645/5646, PXIe-5663/5663E/5665/5668, PXIe-5820/5830/5831/5832/5840/5841

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Identifies the instrument session. This parameter is obtained from the RFmxInstr_Initialize function or the RFmxInstr_InitializeFromNIRFSASessionArray function.

Return Value

Name Type Description
status int32 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 RFmxInstr_GetError) function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxInstr_SendSoftwareEdgeAdvanceTrigger

int32 __stdcall RFmxInstr_SendSoftwareEdgeAdvanceTrigger (niRFmxInstrHandle instrumentHandle);

Purpose

Sends a trigger to the waiting device when you choose a software version of the Advance trigger. You can also use this function to override a hardware trigger. This function returns an error if:

  • You configure an invalid trigger.
  • You have not previously called the RFmx Initiate function.

Supported Devices: PXIe-5644/5645/5646, PXIe-5663/5663E/5665/5668, PXIe-5820/5830/5831/5832/5840/5841

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Identifies the instrument session. This parameter is obtained from the RFmxInstr_Initialize function or the RFmxInstr_InitializeFromNIRFSASessionArray function.

Return Value

Name Type Description
status int32 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 RFmxInstr_GetError) function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

External Attenuation Table

RFmxInstr_CfgExternalAttenuationTable

int32 __stdcall RFmxInstr_CfgExternalAttenuationTable (niRFmxInstrHandle instrumentHandle, char selectorString[], char tableName[], float64 frequency[], float64 externalAttenuation[], int32 arraySize);

Purpose

Stores the external attenuation table in the calibration plane specified by the selectorString parameter. On a MIMO session, the external attenuation table is stored for each MIMO port in the specified calibration plane.

If there is only one table configured in any calibration plane, it is automatically selected as the active table.

Supported devices: PXIe-5663/5663E, PXIe-5665, PXIe-5668, PXIe-5644/5645/5646, PXIe-5830/5831/5832/5840/5841

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Identifies the instrument session. This parameter is obtained from the RFmxInstr_Initialize function or the RFmxInstr_InitializeFromNIRFSASessionArray function.
selectorString char[]

Specifies the calibration plane name in which the external attenuation table is stored. This input accepts the calibration plane name with the "calplane::" prefix. If you do not specify the calibration plane name, the default calibration plane instance is used.

On a MIMO session if you do not specify the port name, this configuration is applied to all MIMO ports in the session for the default calibration plane instance. To configure external attenuation table for a specific MIMO port, use the port specifier with or without the calplane name. Example: "calplane::plane1/port::myrfsa1/0".
Note For PXIe-5830/5831/5832 devices, port names should also be specified along with Calplane names. Hence, the valid selector string is "calplane::/port::". If you specify "port::all", all ports are considered configured. For a MIMO port, the valid selector string is "calplane::/port:://". If you specify "port::all", all MIMO ports are considered configured. Use RFmxInstr_GetAvailablePorts function to get the valid port names.
tableName char[] Specifies the name to be associated with external attenuation table within a calibration plane. Provide a unique name, such as "table1" to configure the table.


example:
""
"table1"
frequency float64[] Specifies an array of frequencies in the external attenuation table. This value is expressed in Hz.
externalAttenuation float64[] Specifies an array of attenuations corresponding to the frequency specified by the frequency parameter. This value is expressed in dB.
arraySize int32 Specifies the size of the array.

Return Value

Name Type Description
status int32 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 RFmxInstr_GetError) function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxInstr_CfgSParameterExternalAttenuationType

int32 __stdcall RFmxInstr_CfgSParameterExternalAttenuationType (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 sParameterType);

Purpose

Configures the type of S-parameter to apply to measurements on the specified port for a Calplane. You can use the selector String input to specify the name of the Calplane and port to configure for S-parameter. Supported devices: PXIe-5830/5831/5832/5840/5841

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Identifies the instrument session. This parameter is obtained from the RFmxInstr_Initialize function or the RFmxInstr_InitializeFromNIRFSASessionArray function.
selectorString char[]

Specifies the calibration plane name in which either S-parameter or external attenuation is stored. This input accepts the calibration plane name with the "calplane::" prefix. If you do not specify the calibration plane name, the default calibration plane instance is used.

On a MIMO session if you do not specify the port name, this configuration is applied to all MIMO ports in the session for the default calibration plane instance. To configure S-parameter external attenuation type for a specific MIMO port, use the port specifier with or without the calplane name. Example: "calplane::plane1/port::myrfsa1/0".
Note For PXIe-5830/5831/5832 devices, port names should also be specified along with Calplane names. Hence, the valid selector string is "calplane::/port::". If you specify "port::all", all ports are considered configured. For a MIMO port, the valid selector string is "calplane::/port:://". If you specify "port::all", all MIMO ports are considered configured. Use RFmxInstr_GetAvailablePorts function to get the valid port names.
sParameterType int32 Specifies the type of S-parameter which applies to measurements on the specified port for a Calplane. If you set this parameter to RFMXINSTR_VAL_SPARAMETER_TYPE_SCALAR or RFMXINSTR_VAL_SPARAMETER_TYPE_VECTOR, RFmx adjusts the instrument settings and the returned data to remove the effects of the external network between the instrument and the DUT.

PXIe-5831/5832: Valid values for this parameter are RFMXINSTR_VAL_SPARAMETER_TYPE_SCALAR and RFMXINSTR_VAL_SPARAMETER_TYPE_VECTOR. RFMXINSTR_VAL_SPARAMETER_TYPE_VECTOR is only supported for TRX ports in a semiconductor test system (STS).

PXIe-5840/5841: The only valid value for this parameter is RFMXINSTR_VAL_SPARAMETER_TYPE_SCALAR.
RFMXINSTR_VAL_SPARAMETER_TYPE_SCALAR (1) De-embeds the measurement using the gain term.
RFMXINSTR_VAL_SPARAMETER_TYPE_VECTOR (2) De-embeds the measurement using the gain term and the reflection term.

Return Value

Name Type Description
status int32 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 RFmxInstr_GetError) function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxInstr_CfgSParameterExternalAttenuationTable

int32 __stdcall RFmxInstr_CfgSParameterExternalAttenuationTable( niRFmxInstrHandle instrumentHandle, char selectorString[], char tableName[], float64 frequency[], int32 frequencyArraySize, NIComplexDouble sParameters[], int32 sParameterTableSize, int32 numberOfPorts, int32 sParameterOrientation );

Purpose

Stores the S-parameter table in the calibration plane specified by the Selector String parameter. On a MIMO session, the S-parameter table is stored for each MIMO port in the specified calibration plane.

Supported devices: PXIe-5830/5831/5832/5840/5841

Note If there is only one table configured in any calibration plane, it is automatically selected as the active table.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Identifies the instrument session. This parameter is obtained from the RFmxInstr_Initialize function or the RFmxInstr_InitializeFromNIRFSASessionArray function.
selectorString char[]

Specifies the calibration plane name in which the external attenuation table is stored. This input accepts the calibration plane name with the "calplane::" prefix. If you do not specify the calibration plane name, the default calibration plane instance is used. If you do not specify the calibration plane name, the default calibration plane instance is used.

On a MIMO session if you do not specify the port name, this configuration is applied to all MIMO ports in the session for the default calibration plane instance. To configure S-parameter external attenuation table for a specific MIMO port, use the port specifier with or without the calplane name. Example: "calplane::plane1/port::myrfsa1/0".
Note For PXIe-5830/5831/5832 devices, port names should also be specified along with Calplane names. Hence, the valid selector string is "calplane::/port::". If you specify "port::all", all ports are considered configured. For a MIMO port, the valid selector string is "calplane::/port:://". If you specify "port::all", all MIMO ports are considered configured. Use RFmxInstr_GetAvailablePorts function to get the valid port names.
tableName char[] Specifies the name to be associated with the S-parameter table within a calibration plane. Provide a unique name, such as "table1" to configure the table.
Example:
""
"table1"
frequency float64[] Specifies an array of frequencies in the S-parameter table. This value is expressed in Hz.
frequencyArraySize int32 Specifies the size of the frequency array.
sParameters NIComplexDouble[] Specifies the S-parameters for each frequency. The first index indicates the corresponding frequency entry, the second index corresponds to the target port for the S-parameter, and the third index corresponds to the the source port. For example, to index the s21 parameter for the fourth frequency in the table, you would use {3, 1, 0} as the indexes since they are zero-based.
sParameterTableSize int32 Specifies the size of the S-parameter table.
numberOfPorts int32 Specifies the number of ports.
sParameterOrientation int32 Specifies the orientation of the data in the S-parameter table relative to the port you specify.
RFMXINSTR_VAL_PORT1_TOWARDS_DUT (0) Port 1 of the S2P is oriented towards the DUT.
RFMXINSTR_VAL_PORT2_TOWARDS_DUT (1) Port 2 of the S2P is oriented towards the DUT.

Return Value

Name Type Description
status int32 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 RFmxInstr_GetError) function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxInstr_CfgExternalAttenuationInterpolation

RFmxInstr_CfgExternalAttenuationInterpolationNearest

int32 __stdcall RFmxInstr_CfgExternalAttenuationInterpolationNearest (niRFmxInstrHandle instrumentHandle, char selectorString[], char tableName[]);

Purpose

Selects the nearest interpolation method when interpolating S-parameters for a specified table. The parameters of the table nearest to the carrier frequency are used.

Note Currently interpolation is supported only for S-parameter tables.
Supported devices: PXIe-5663/5663E, PXIe-5665, PXIe-5668, PXIe-5644/5645/5646, PXIe-5830/5831/5832/5840/5841

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Identifies the instrument session. This parameter is obtained from the RFmxInstr_Initialize function or the RFmxInstr_InitializeFromNIRFSASessionArray function.
selectorString char[] Specifies the calibration plane name in which either S-parameter or external attenuation table is stored. This input accepts the calibration plane name with the "calplane::" prefix. If you do not specify the calibration plane name, the default calibration plane instance is used.
Note For PXIe-5830/5831/5832 devices, port names should also be specified along with Calplane names. Hence, the valid selector string is "calplane::/port::". If you specify "port::all", all ports are considered configured. For a MIMO port, the valid selector string is "calplane::/port:://". If you specify "port::all", all MIMO ports are considered configured. Use RFmxInstr_GetAvailablePorts function to get the valid port names.
tableName char[] Specifies the name to be associated with either the S-parameter table or the external attenuation table within a calibration plane. Provide a unique name, such as "table1" to configure the table.


example:
""
"table1"

Return Value

Name Type Description
status int32 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 RFmxInstr_GetError) function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxInstr_CfgExternalAttenuationInterpolationLinear

int32 __stdcall RFmxInstr_CfgExternalAttenuationInterpolationLinear( niRFmxInstrHandle instrumentHandle, char selectorString[], char tableName[], int32 format );

Purpose

Selects the linear interpolation method when interpolating S-parameters for the specified table. If the carrier frequency does not match a row in the S-parameter table, this function performs a linear interpolation based on the entries above and below the rows in the table.

Currently interpolation is supported only for S-parameter tables.

Supported Devices: PXIe-5663/5663E, PXIe-5665, PXIe-5668, PXIe-5644/5645/5646, PXIe-5830/5831/5832/5840/5841

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Identifies the instrument session. This parameter is obtained from the RFmxInstr_Initialize function or the RFmxInstr_InitializeFromNIRFSASessionArray function.
selectorString char[] Specifies the calibration plane name in which either S-parameter table or external attenuation table is stored. This input accepts the calibration plane name with the "calplane::" prefix. If you do not specify the calibration plane name, the default calibration plane instance is used. If you do not specify the calibration plane name, the default calibration plane instance is used.
Note For PXIe-5830/5831/5832 devices, port names should also be specified along with Calplane names. Hence, the valid selector string is "calplane::/port::". If you specify "port::all", all ports are considered configured. For a MIMO port, the valid selector string is "calplane::/port:://". If you specify "port::all", all MIMO ports are considered configured. Use RFmxInstr_GetAvailablePorts function to get the valid port names.
tableName char[] Specifies the name to be associated with either the S-parameter table or the external attenuation table within a calibration plane. Provide a unique name, such as "table1" to configure the table.
Example:
""
"table1"
format int32 Specifies the format of parameters to interpolate.
RFMXINSTR_VAL_LINEAR_INTERPOLATION_FORMAT_REAL_AND_IMAGINARY (0) Results in a linear interpolation of the real portion of the complex number and a separate linear interpolation of the complex portion.
RFMXINSTR_VAL_LINEAR_INTERPOLATION_FORMAT_MAGNITUDE_AND_PHASE (1) Results in a linear interpolation.
RFMXINSTR_VAL_LINEAR_INTERPOLATION_FORMAT_MAGNITUDE_DB_AND_PHASE (2) Results in a linear interpolation.

Return Value

Name Type Description
status int32 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 RFmxInstr_GetError) function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxInstr_CfgExternalAttenuationInterpolationSpline

int32 __stdcall RFmxInstr_CfgExternalAttenuationInterpolationSpline (niRFmxInstrHandle instrumentHandle, char selectorString[], char tableName[]);

Purpose

Selects the spline interpolation method when interpolating parameters for the specified table. If the carrier frequency does not match a row in the S-parameter table, this function performs a spline interpolation based on the entries above and below the row in the table.

Note Currently interpolation is supported only for S-parameter tables.
Supported devices: PXIe-5663/5663E, PXIe-5665, PXIe-5668, PXIe-5644/5645/5646, PXIe-5830/5831/5832/5840/5841

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Identifies the instrument session. This parameter is obtained from the RFmxInstr_Initialize function or the RFmxInstr_InitializeFromNIRFSASessionArray function.
selectorString char[] Specifies the calibration plane name in which either S-parameter or external attenuation table is stored. This input accepts the calibration plane name with the "calplane::" prefix. If you do not specify the calibration plane name, the default calibration plane instance is used.
Note For PXIe-5830/5831/5832 devices, port names should also be specified along with Calplane names. Hence, the valid selector string is "calplane::/port::". If you specify "port::all", all ports are considered configured. For a MIMO port, the valid selector string is "calplane::/port:://". If you specify "port::all", all MIMO ports are considered configured. Use RFmxInstr_GetAvailablePorts function to get the valid port names.
tableName char[] Specifies the name to be associated with either the S-parameter table or the external attenuation table within a calibration plane. Provide a unique name, such as "table1" to configure the table.


example:
""
"table1"

Return Value

Name Type Description
status int32 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 RFmxInstr_GetError) function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxInstr_LoadSParameterExternalAttenuationTableFromS2PFile

int32 __stdcall RFmxInstr_LoadSParameterExternalAttenuationTableFromS2PFile( niRFmxInstrHandle instrumentHandle, char selectorString[], char tableName[], char S2PFilePath[], int32 sParameterOrientation );

Purpose

Stores the S-parameter table from S2P file in the calibration plane specified by the Selector String parameter. On a MIMO session, the S-parameter table is stored for each MIMO port in the specified calibration plane.

Note If there is only one table configured in any calibration plane, it is automatically selected as the active table.

Supported devices: PXIe-5830/5831/5832/5840/5841

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Identifies the instrument session. This parameter is obtained from the RFmxInstr_Initialize function or the RFmxInstr_InitializeFromNIRFSASessionArray function.
selectorString char[] Specifies the calibration plane name in which the external attenuation table is stored. This input accepts the calibration plane name with the "calplane::" prefix. If you do not specify the calibration plane name, the default calibration plane instance is used. If you do not specify the calibration plane name, the default calibration plane instance is used.
Note For PXIe-5830/5831/5832 devices, port names should also be specified along with Calplane names. Hence, the valid selector string is "calplane::/port::". If you specify "port::all", all ports are considered configured. For a MIMO port, the valid selector string is "calplane::/port:://". If you specify "port::all", all MIMO ports are considered configured. Use RFmxInstr_GetAvailablePorts function to get the valid port names.
tableName char[] Specifies the name to be associated with the S-parameter table within a calibration plane. Provide a unique name, such as "table1" to configure the table.

Example:
""
"table1"
S2PFilePath char[] Specifies the path to the S2P file that contains S-parameter table information for the specified port.
sParameterOrientation int32 Specifies the orientation of the data in the S-parameter table relative to the port you specify.
RFMXINSTR_VAL_PORT1_TOWARDS_DUT (0) Port 1 of the S2P is oriented towards the DUT.
RFMXINSTR_VAL_PORT2_TOWARDS_DUT (1) Port 2 of the S2P is oriented towards the DUT.

Return Value

Name Type Description
status int32 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 RFmxInstr_GetError) function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxInstr_GetExternalAttenuationTableActualValue

int32 __stdcall RFmxInstr_GetExternalAttenuationTableActualValue (niRFmxInstrHandle instrumentHandle, char selectorString[], float64* externalAttenuation);

Purpose

Returns the external attenuation table actual value that is applied to the measurements for a specified signal and calibration plane. On a MIMO session, this function returns the external attenuation table actual value for a specified port. You can use the selectorString parameter to specify the name of the signal, calibration plane, and MIMO port to return the external attenuation table actual value.

Supported devices: PXIe-5663/5663E, PXIe-5665, PXIe-5668, PXIe-5644/5645/5646, PXIe-5830/5831/5832/5840/5841

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Identifies the instrument session. This parameter is obtained from the RFmxInstr_Initialize function or the RFmxInstr_InitializeFromNIRFSASessionArray function.
selectorString char[] Specifies a Selector String) comprising of the signal name and calibration plane name. This input accepts the calibration plane name with the "calplane::" prefix. If you do not specify the calibration plane name, the default calibration plane instance is used. On a MIMO session, you must use "port::/" as part of the selector string to read the external attenuation table actual value for the specified port. If you do not specify the signal name, the value is returned for the last committed signal instance.


example:
""
"signal::sig1"
"calplane::plane0"
"signal::sig1/calplane::plane0"
"port::rfsa1/0"
"signal::sig1/port::rfsa1/0"
"calplane::plane0/port::rfsa1/0"
"signal::sig1/calplane::plane0/port::rfsa1/0"
Output
Name Type Description
externalAttenuation float64* Returns the external attenuation table actual value applied to the measurements for a specified signal and calibration plane. This further includes interpolation of the external attenuation table based on the specified signal. On a MIMO session, this value corresponds to a specified port. This value is expressed in dB.

Return Value

Name Type Description
status int32 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 RFmxInstr_GetError) function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxInstr_GetSParameterExternalAttenuationType

int32 __stdcall RFmxInstr_GetSParameterExternalAttenuationType (niRFmxInstrHandle instrumentHandle, char selectorString[], int32* sParameterType);

Purpose

Returns the type of S-parameter that is applied to the measurements on the specified port on a Calplane. Use the Selector String input to specify the name of the Calplane and port to configure for s-parameter. Supported devices: PXIe-5830/5831/5832/5840/5841

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Identifies the instrument session. This parameter is obtained from the RFmxInstr_Initialize function or the RFmxInstr_InitializeFromNIRFSASessionArray function.
selectorString char[]

Specifies the calibration plane name in which either S-parameter or external attenuation is stored. This input accepts the calibration plane name with the "calplane::" prefix. If you do not specify the calibration plane name, the default calibration plane instance is used.

On a MIMO session if you do not specify the port name, this VI will return an error. To get S-parameter external attenuation type from a specific MIMO port, use the port specifier with or without the calplane name. Example: "calplane::plane1/port::myrfsa1/0".
Note For PXIe-5830/5831/5832 devices, port names should also be specified along with Calplane names. Hence, the valid selector string is "calplane::/port::". If you specify "port::all", all ports are considered configured. For a MIMO port, the valid selector string is "calplane::/port:://". If you specify "port::all", all MIMO ports are considered configured. Use RFmxInstr_GetAvailablePorts function to get the valid port names.
sParameterType int32 Returns the type of S-parameter which is applied to measurements on the specified port of a Calplane.

Return Value

Name Type Description
status int32 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 RFmxInstr_GetError) function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxInstr_SelectActiveExternalAttenuationTable

int32 __stdcall RFmxInstr_SelectActiveExternalAttenuationTable (niRFmxInstrHandle instrumentHandle, char selectorString[], char tableName[]);

Purpose

Activates the external attenuation table set by the tableName parameter in the calibration plane specified by the selectorString parameter. On a MIMO session, this function selects the active external attenuation table for the specified MIMO port. The specified table will be used for amplitude correction during measurement. Supported devices: PXIe-5663/5663E, PXIe-5665, PXIe-5668, PXIe-5644/5645/5646, PXIe-5830/5831/5832/5840/5841

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Identifies the instrument session. This parameter is obtained from the RFmxInstr_Initialize function or the RFmxInstr_InitializeFromNIRFSASessionArray function.
selectorString char[]

Specifies the calibration plane name in which either S-parameter or external attenuation table is stored. This input accepts the calibration plane name with the "calplane::" prefix. If you do not specify the calibration plane name, the default calibration plane instance is used.

On a MIMO session, the default "" (empty string) selects the active external attenuation table for all the MIMO Ports. To configure external attenuation type for a specific MIMO port, use the port specifier with or without the calplane name. Example: "calplane::plane1/port::myrfsa1/0".
Note For PXIe-5830/5831/5832 devices, port names should also be specified along with Calplane names. Hence, the valid selector string is "calplane::/port::". If you specify "port::all", all ports are considered configured. For a MIMO port, the valid selector string is "calplane::/port:://". If you specify "port::all", all ports are considered configured. Use RFmxInstr_GetAvailablePorts function to get the valid port names.
tableName char[] Specifies the name to be associated with external attenuation table within a calibration plane. Provide a unique name, such as "table1" to configure the table.


example:
""
"table1"

Return Value

Name Type Description
status int32 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 RFmxInstr_GetError) function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxInstr_DeleteExternalAttenuationTable

int32 __stdcall RFmxInstr_DeleteExternalAttenuationTable (niRFmxInstrHandle instrumentHandle, char selectorString[], char tableName[]);

Purpose

Deletes the external attenuation table set by the tableName parameter in the calibration plane specified by the selectorString parameter. On a MIMO session, this function deletes the external attenuation table for the specified MIMO port. Supported devices: PXIe-5663/5663E, PXIe-5665, PXIe-5668, PXIe-5644/5645/5646, PXIe-5830/5831/5832/5840/5841

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Identifies the instrument session. This parameter is obtained from the RFmxInstr_Initialize function or the RFmxInstr_InitializeFromNIRFSASessionArray function.
selectorString char[]

Specifies the calibration plane name in which the external attenuation table is stored. This input accepts the calibration plane name with the "calplane::" prefix. If you do not specify the calibration plane name, the default calibration plane instance is used.

On a MIMO session, the default "" (empty string) deletes the active external attenuation table for all the MIMO Ports. To delete an external attenuation type for a specific MIMO port, use the port specifier with or without the calplane name. Example: "calplane::plane1/port::myrfsa1/0".
Note For PXIe-5830/5831/5832 devices, port names should also be specified along with Calplane names. Hence, the valid selector string is "calplane::/port::". If you specify "port::all", all ports are considered configured. For a MIMO port, the valid selector string is "calplane::/port:://". If you specify "port::all", all MIMO ports are considered configured. Use RFmxInstr_GetAvailablePorts function to get the valid port names.
tableName char[] Specifies the name to be associated with external attenuation table within a calibration plane. Provide a unique name, such as "table1" to configure the table.


example:
""
"table1"

Return Value

Name Type Description
status int32 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 RFmxInstr_GetError) function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxInstr_DeleteAllExternalAttenuationTables

int32 __stdcall RFmxInstr_DeleteAllExternalAttenuationTables (niRFmxInstrHandle instrumentHandle, char selectorString[]);

Purpose

Deletes all the external attenuation tables in the calibration plane specified by the selectorString parameter. On a MIMO session, this function deletes all the external attenuation tables for the specified MIMO port. Supported devices: PXIe-5663/5663E, PXIe-5665, PXIe-5668, PXIe-5644/5645/5646, PXIe-5830/5831/5832/5840/5841

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Identifies the instrument session. This parameter is obtained from the RFmxInstr_Initialize function or the RFmxInstr_InitializeFromNIRFSASessionArray function.
selectorString char[]

Specifies the calibration plane name in which either S-parameter or external attenuation table is stored. This input accepts the calibration plane name with the "calplane::" prefix. If you do not specify the calibration plane name, the default calibration plane instance is used.

On a MIMO session, the default "" (empty string) deletes all the external attenuation tables for all MIMO Ports. To delete an external attenuation type for a specific MIMO port, use the port specifier with or without the calplane name. Example: "calplane::plane1/port::myrfsa1/0".
Note For PXIe-5830/5831/5832 devices, port names should also be specified along with Calplane names. Hence, the valid selector string is "calplane::/port::". If you specify "port::all", all ports are considered configured. For a MIMO port, the valid selector string is "calplane::/port:://". If you specify "port::all", all MIMO ports are considered configured. Use RFmxInstr_GetAvailablePorts function to get the valid port names.

Return Value

Name Type Description
status int32 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 RFmxInstr_GetError) function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxInstr_EnableCalibrationPlane

int32 __stdcall RFmxInstr_EnableCalibrationPlane (niRFmxInstrHandle instrumentHandle, char selectorString[]);

Purpose

Enables the calibration plane specified by the selectorString parameter for amplitude correction. Supported devices: PXIe-5663/5663E, PXIe-5665, PXIe-5668, PXIe-5644/5645/5646, PXIe-5830/5831/5832/5840/5841

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Identifies the instrument session. This parameter is obtained from the RFmxInstr_Initialize function or the RFmxInstr_InitializeFromNIRFSASessionArray function.
selectorString char[] Specifies the calibration plane name in which the external attenuation table or S-parameter is stored. This input accepts the calibration plane name with the "calplane::" prefix. If you do not specify the calibration plane name, the default calibration plane instance is used. If "calplane::all" is specified, all the calibration planes are enabled.


example:
""
"calplane::plane0"
"calplane::all"

Return Value

Name Type Description
status int32 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 RFmxInstr_GetError) function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxInstr_DisableCalibrationPlane

int32 __stdcall RFmxInstr_DisableCalibrationPlane (niRFmxInstrHandle instrumentHandle, char selectorString[]);

Purpose

Disables the calibration plane specified by the selectorString parameter for amplitude correction. Supported devices: PXIe-5663/5663E, PXIe-5665, PXIe-5668, PXIe-5644/5645/5646, PXIe-5830/5831/5832/5840/5841

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Identifies the instrument session. This parameter is obtained from the RFmxInstr_Initialize function or the RFmxInstr_InitializeFromNIRFSASessionArray function.
selectorString char[] Specifies the calibration plane name in which the external attenuation table is stored. This input accepts the calibration plane name with the "calplane::" prefix. If you do not specify the calibration plane name, the default calibration plane instance is used. If you specify "calplane::all", all the calibration planes are disabled.


example:
""
"calplane::plane0"
"calplane::all"

Return Value

Name Type Description
status int32 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 RFmxInstr_GetError) function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

Table of Contents

Home

Internal Development

Creating and Setting Up a gRPC Server

Server Security Support

Creating a gRPC Client

gRPC Client Examples

Session Utilities API Reference

Driver Documentation

gRPC API Differences From C API

Sharing Driver Sessions Between Clients

C API Docs
NI-DAQmx
NI-DCPOWER
NI-DIGITAL PATTERN DRIVER
NI-DMM
NI-FGEN
NI-FPGA
NI-RFmx Bluetooth
NI-RFmx NR
NI-RFmx WCDMA
NI-RFmx GSM
NI-RFmx CDMA2k
NI-RFmx Instr
NI-RFmx LTE
NI-RFmx SpecAn
NI-RFmx TD-SCDMA
NI-RFmx WLAN
NI-RFSA
NI-RFSG
NI-SCOPE
NI-SWITCH
NI-TCLK
NI-XNET
Clone this wiki locally