RFmxVnaMXSParamsConfiguration.GetFormat Method
- Updated2024-07-17
- 1 minute(s) read
RFmx
Gets the format of S-Parameter measurement. Use 'sparam(n)' as the selector string to configure or read this attribute.
Use RFmxVNA SParams Fetch Real Data to fetch the S-Parameters for which you configured this attribute to Magnitude (0), Phase (1) or SWR (3). Use RFmxVNA SParams Fetch Complex Data to fetch the S-Parameters for which you configured this attribute to Complex (2), Smith Impedance (4) or Smith Admittance (5).
Use RFmxVNA SParams Fetch Real Data to fetch the S-Parameters for which you configured this attribute to Magnitude (0), Phase (1) or SWR (3). Use RFmxVNA SParams Fetch Complex Data to fetch the S-Parameters for which you configured this attribute to Complex (2), Smith Impedance (4) or Smith Admittance (5).
Namespace: NationalInstruments.RFmx.VnaMX
Assembly: NationalInstruments.RFmx.VnaMX.Fx40 (in NationalInstruments.RFmx.VnaMX.Fx40.dll) Version: 24.5.0.49286 (24.5.0.49286)
Syntax
public int GetFormat( string selectorString, out RFmxVnaMXSParamsFormat value )
Public Function GetFormat ( selectorString As String, <OutAttribute> ByRef value As RFmxVnaMXSParamsFormat ) As Integer
Parameters
- selectorString String
- Pass an empty string. The signal name that is passed when creating the signal configuration is used.
- value RFmxVnaMXSParamsFormat
- Upon return, contains the format of S-Parameter measurement.
Return Value
Int32Returns the status code of this method. The status code either indicates success or describes a warning condition.
Remarks
This method gets the value of SParamsFormat attribute.The default value is (format type="bold")RFMXVNA_VAL_Magnitude(/format).