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


fileName
Specifies the file name.
format
Specifies the file format.
doSaveHeader
Specifies if the Header is saved with the data.

Glossary Item Box

Save the trace in the specified format to a file.

Syntax

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

Parameters

fileName
Specifies the file name.
format
Specifies the file format.
doSaveHeader
Specifies if the Header is saved with the data.

Remarks

Saves the trace data to a specified file in a specified format.

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]
"TEXT" Text (Tab delimited) [*.txt]

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

If the format is an empty string, then the analyzer automatically determines the file format by looking at the file suffix. If this is not sufficient, then a default format is chosen.

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

Requirements

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

See Also