:DISK:FILE:ASCii:READ?

Instrument:
N1000A
DCA-M
Meas. mode:
Scope
Eye
Jitter
TDR
Flex Apps:
FlexDCA
FlexRT

Query Syntax

:DISK:FILE:ASCii:READ? "filename"

Description

Returns the contents of the requested text file. If the file does not contain text, the return string will be terminated at the first zero (0) values byte in the file. The :DISK:FILE:ASCii:READ? and :DISK:FILE:READ? commands allow you to read the contents of a file and save the contents to a file in another location. The difference is that the :DISK:FILE:ASCii:READ? may attempt to change the file to match the receiving environment (PC, Mac, etc.). For example, this command could change the characters used to define the end of a line. For this reason, it is best to use the :DISK:FILE:READ? command instead to ensure that the file contents remain untouched.

For this command, the file size must be smaller than 65,536 characters. To return the size of a file, use the :DISK:FILE:SIZE? query.

Path Substitution Strings

Use FlexDCA's Path Substitution Stings in you file names to eliminate the need to enter long path strings. For security reasons, this command only allows the %USER_DATA_DIR% and %TEMP_DIR% path substitution strings to be used. All other path substitution strings will result in a failed query with a –258, Media protected. error code.

Security Restrictions

Starting with FlexDCA revision A.07.90, file I/O security was increased when reading or writing files using the :DISK:FILE commands. FlexDCA no longer permits arbitrary file types, arbitrary folder access, or reading and writing to network share drives. The following "Valid File Types" and "Standard FlexDCA Directories" tables identify the type of files and location that you can read or write using the :DISK:FILE commands.

Sending a :DISK:FILE:ASCii:READ command that specifies a network share drive, a restricted directory, or with a restricted file name results in –258, Media protected. error code.

You can use the :DISK:FILE:ASCii:READ? query for the files marked in the following table as format Text.

Valid File Types
Description File Name
Extension
Adapter definitions xml
Color-Grade Gray Scale (CGGS) waveform database for channel or CGGS Memory. csv
cgsx
Documentation Wizard file. zip
Eye Mode mask file. The preferred file name extension is .mskx. mskx
Graphics files. For example, images of screen. bmp, gif, jpeg, jpg, png, tiff
Instrument Report is an XPS (XML Paper Specification) file. XPS files can be viewed using Microsoft's XPS Viewer application. xps
Jitter database jdx
Jitter Spectrum Analysis (JSA) data jsax
License file to enable features for FlexDCA. lic
Limit line file lltx
Limit test summary file sum
Log files log
SCPI command file to run when FlexDCA's Multipurpose button is clicked. scpi
Presets files save settings for various FlexDCA features that can be re-imported to setup the feature. For example, for the TDECQ Reference Equalizer function's Reference Rx preset. xml
S-parameters Touchstone or Citifile (.cti, .cit) formatted files. For single-ended devices with one port, the preferred Touchstone file name extension is .s1p, but .txt can also be used. s1p, s2p, s4p, s8p, s12p, s16p, cti, cit, ts, txt
Instrument Setup file for saving and recalling the current overall state of FlexDCA. setx
TDR/TDT calibration file tdrx
TDR De-embedding networks tf2, tf4
Waveform file (channels, Diff channels, waveform memories, etc.)
Waveform file (internal) wfmx
Waveform file (Y-values) txt
Waveform file (XY-values) txt
Pattern file csv
Pattern file (internal) wfmx
Waveform file (VSA format). VSA Waveform Recording files are ASCII files that you can import into Keysight's 89600 VSA and WLA software. Two file types include comma separated values (.csv) Tab separated values. VSA files are available to save when Pattern Lock and Acquire Entire Pattern are on. csv
txt
Pattern file from a BERT instrument which can be imported into FlexDCA. ptrn
Waveform file (Mask Limit Waveform). Reporting action for limit test.
Pattern waveform .csv
Pattern waveform (Internal) .wfmx

When using the :DISK:FILE commands, files can only be read from or written to the directories that are listed in the following two tables. This includes any sub-directories that are in the listed directories. The first table lists FlexDCA's standard directories. The second table lists folders that are not typically used but are available for you to read and write to.

Standard FlexDCA Directories
Drive/Directory FlexDCA Installed On
N1000A Windows PC
Without OneDrive With OneDrive
C:\Users\user-name\Documents\Keysight\FlexDCA  
C:\Users\user-name\Documents\Keysight    
C:\Users\user-name\OneDrive - Keysight Technologies\Documents\Keysight\FlexDCA    
D:\User Files    
Additional Non-Standard FlexDCA Directories
Drive/Directory FlexDCA Installed On
N1000A Windows PC
C:\Temp
C:\Keysight  
C:\ProgramData\Keysight\FlexDCA
C:\Users\user-name\AppData\Local\Keysight\FlexDCA
C:\Users\user-name\AppData\Local\Temp
C:\Users\user-name\AppData\Local\Temp\Keysight\FlexDCA

Requires FlexDCA revision A.05.30 and above. FlexDCA revision A.07.90 increases file I/O security.