RFmxVnaMXWavesConfiguration.GetFormat Method
- Updated2024-07-17
- 1 minute(s) read
RFmx
Gets the format for wave measurement. Use 'wave(n)' as the selector string to configure or read this attribute.
Use RFmxVNA Waves Fetch Real Data to fetch the waves for which you configured this attribute to Magnitude (0), Phase (1) or SWR (3). Use RFmxVNA Waves Fetch Complex Data to fetch the waves for which you configured this attribute to Complex (2), Smith Impedance (4) or Smith Admittance (5).
Use RFmxVNA Waves Fetch Real Data to fetch the waves for which you configured this attribute to Magnitude (0), Phase (1) or SWR (3). Use RFmxVNA Waves Fetch Complex Data to fetch the waves 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 RFmxVnaMXWavesFormat value )
Public Function GetFormat ( selectorString As String, <OutAttribute> ByRef value As RFmxVnaMXWavesFormat ) As Integer
Parameters
- selectorString String
- Pass an empty string. The signal name that is passed when creating the signal configuration is used.
- value RFmxVnaMXWavesFormat
- Upon return, contains the format for wave 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 WavesFormat attribute.The default value is (format type="bold")RFMXVNA_VAL_Magnitude(/format).