Keysight 89600 VSA .NET API
RecallFile Method
See Also 
Agilent.SA.Vsa.Interfaces Assembly > Agilent.SA.Vsa Namespace > DataRegister Class : RecallFile Method


fileName
Specifies the file path.
format
Specifies the file format.

Glossary Item Box

Recall the specified file into the data register.

Syntax

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

Parameters

fileName
Specifies the file path.
format
Specifies the file format.

Remarks

This operation overwrites the previous contents of the data register.

Supported File Formats:

Format Description
"CSV" CSV (Comma delimited) [*.csv]
"MAT" MAT-File [*.mat]
"MAT7" MAT-File (HDF5) [*.mat, *.hdf, *.h5]
"SDF" SDF (Fast) [*.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).

When the format is an empty string, then the application automatically determines the file format by looking at the file suffix. If this is not sufficient, then the file is scanned to determine the format. When the format cannot be determined or you specified an unknown format, then an error is raised.

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

Requirements

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

See Also