RFmx VNA C

Table of Contents

RFmxVNA_SParamsGetSParameter

  • Updated2024-10-21
  • 1 minute(s) read

RFmxVNA_SParamsGetSParameter

int32 __stdcall RFmxVNA_SParamsGetSParameter (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 arraySize, char sParameter[]);

Purpose

Returns the S-Parameter being measured in format S<receiver port number><source port number>
Use "sparam<n>" as the selector string for this function.
supporteddevices: NI PXIe-5633

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the RFmx session refnum.
selectorString char[] Specifies a selector string comprising of the signal name, result name, and S-Parameter number. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
"sparam0"
"signal::sig1/sparam0"
"result::r1/sparam0"
"signal::sig1/result::r1/sparam0"
You can use the RFmxVNA_BuildSParameterString function to build the selector string.
arraySize int32 Specifies the size of the array.
sParameter char[] Specifies the S-Parameter to be measured.
supporteddevices: NI-5663

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

The general meaning of the status code is as follows:

Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

Log in to get a better experience