RFmxInstr_CfgSParameterExternalAttenuationType

RFmx WCDMA 19.1 Help

Edition Date: October 2019

Part Number: 375421H-01

»View Product Info

DOWNLOAD (Windows Only)


RFmx WCDMA 19.1 Help
RFmx WCDMA 20.0 Help

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/5840/5841

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxInstr_Initialize 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. The default value is "" (empty string).
For PXIe-5830/5831 - Port names should also be specified along with Calplane names, so the valid selector string format is "calplane::/port::". If you specify "port::all", all ports are considered configured.
Example:
""
"calplane::plane0"
"calplane::plane0/port::if0"
"port::if0"
"calplane::plane0/port::all"
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 Scalar or Vector, RFmx adjusts the instrument settings and the returned data to remove the effects of the external network between the instrument and the DUT. The default value is Scalar. PXIe-5840/5841: The only valid value for this parameter is Scalar.

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

WAS THIS ARTICLE HELPFUL?

Not Helpful