Stores the S-parameter table from the S2P file in the calibration plane specified by the Selector String parameter. S-parameter tables are used for fixture de-embedding. 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.

Syntax

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

Remarks

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

Parameters

NameDirectionTypeDescription
instrumentHandle[in]niRFmxInstrHandle

This parameter identifies the instrument session. This parameter is obtained from the RFmxInstr_Initialize function or the RFmxInstr_InitializeFromNIRFSASessionArray function.

selectorString[in]char

This parameter 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. The default value is "" (empty string).
Note

For PXIe-5830/5831/5832 devices, port names should also be specified along with Calplane names. Hence, the valid selector string is "calplane::<calplanename>/port::<portname>". If you specify "port::all", all ports are considered configured. For a MIMO port, the valid selector string is "calplane::<calplanename>/port::<devicename>/<channelnumber>/<portname>". If you specify "port::all", all MIMO ports are considered configured. Use RFmxInstr_GetAvailablePorts function to get the valid port names. </portname></channelnumber></devicename></calplanename></portname></calplanename>

Example:
""
"calplane::plane0"
"calplane::plane0/port::if0"
"port::if0"
"calplane::plane0/port::all"
"calplane::plane0/port::myrfsa1/0"
"calplane::plane0/port::myrfsa1/0, port::myrfsa2/0"
"calplane::plane0/port::myrfsa1/0/if0"

tableName[in]char

This parameter specifies the name to be associated with S-parameter table within a calibration plane. Provide a unique name, such as "table1" to configure the table. The default value is "" (empty string). Example:
""
"table1"

s2PFilePath[in]char

This parameter specifies the path to the S2P file that contains S-parameter table information for the specified port.

sParameterOrientation[in]int32

This parameter specifies the orientation of the data in the S-parameter table relative to the port you specify. The default value is Port2 Towards DUT.

Name (Value)

Description

Port1 Towards DUT (0)

Port 1 of the S2P is oriented towards the DUT.

Port2 Towards DUT (1)

Port 2 of the S2P is oriented towards the DUT.

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

The general meaning of the status code is as follows:

Value

Meaning

0

Success

Positive Values

Warnings

Negative Values

Errors