Keysight Pathwave 89600 VSA .NET API
SaveFile Method
See Also 
Agilent.SA.Vsa.Interfaces Assembly > Agilent.SA.Vsa Namespace > Recording Class : SaveFile Method


fileName
Specifies the name of the file.
format
Specifies the file format of the saved recording.
isHeader
Specifies to save header with data option.
isMeasurementFrequency
Specifies to only save the data in the current measurement's center/span frequency.
isPlayTime
Specifies to only save the data between the playback start/stop times.

Glossary Item Box

Save all or part of the current recording in the specified format to a file.

Syntax

Visual Basic (Declaration) 
Public MustOverride Sub SaveFile( _
   ByVal fileName As String, _
   ByVal format As String, _
   ByVal isHeader As Boolean, _
   ByVal isMeasurementFrequency As Boolean, _
   ByVal isPlayTime As Boolean _
) 
C# 
public abstract void SaveFile( 
   string fileName,
   string format,
   bool isHeader,
   bool isMeasurementFrequency,
   bool isPlayTime
)
C++/CLI 
public:
abstract void SaveFile( 
   String^ fileName,
   String^ format,
   bool isHeader,
   bool isMeasurementFrequency,
   bool isPlayTime
) 

Parameters

fileName
Specifies the name of the file.
format
Specifies the file format of the saved recording.
isHeader
Specifies to save header with data option.
isMeasurementFrequency
Specifies to only save the data in the current measurement's center/span frequency.
isPlayTime
Specifies to only save the data between the playback start/stop times.

Remarks

Recalls the recording from the specified file. The current recording, in SDF format, is overwritten.

Supported File Formats:

format Description
"CSV" CSV (Comma delimited) [*.csv]
"MAT" MAT-File [*.mat]
"MAT4" MAT-File (Version 4) [*.mat]
"MAT7" MAT-File (HDF5) [*.mat, *.hdf, *.h5]
"BINF" BINF (Little Endian Real32 Binary) [*.binf]
"N5110A" N5110A Waveform [*.bin]
"N5106A" N5106A Waveform [*.bin]
"SDF" SDF (Fast) [*.sdf, *.dat]
"SDFX" SDF (Export) [*.sdf, *.dat]
"TEXT" Text (Tab delimited) [*.txt]

Note:
MAT may be used instead of MAT7 for recall trace/recording (the matlab file format is auto detected for recall).

For all file formats except sdf, the SaveFile method provides three extended save recording parameters: isHeader, isMeasurementFrequency, and isPlayTime (described above). These parameters are the "Save header with data", "At measurement/span", and "Between playback start\stop times" options in the recording "Save Options" dialog box. To view the "Save Options" dialog box, click File > Save > Save Recording > Save and the dialog box will show for non-sdf formats.

If the isHeader parameter is False, then the recording header is not saved with the recording. This means if you recall the recording, the time\frequency parameters for the data will not be restored.

For more information about file types, see the "Supported File Formats" topic in the VSA application help.

Requirements

Target Platforms: Windows 11 Professional or Enterprise; Windows 10 Professional, Enterprise, or Education (64-bit)

See Also