14: TSP command reference 2470 High Voltage SourceMeter Instrument
14-80 2470-901-01 Rev. A / May 2019
file.read()
This function reads data from a file on the USB flash drive.
Type TSP-Link accessible
Affected by Where saved Default value
Usage
fileContents = file.read(fileNumber, readAction)
The contents of the file based on the readAction parameter
The file number returned from the file.open() function to read
ï‚§ Return the next line; returns nil if the present file position is at the end of the
file: file.READ_LINE
ï‚§ Return a string that represents the number found; returns an event string if no
number was found; returns nil if the current file position is at the end of file:
file.READ_NUMBER
ï‚§ Return the whole file, starting at the present position; returns nil if the present
file position is at the end of the file:
Details
This command reads data from a file.
Example
file_num = file.open("/usb1/testfile.txt", file.MODE_READ)
if file_num != nil then
file_contents = file.read(file_num, file.READ_ALL)
file.close(file_num)
Open testfile.txt on the USB flash drive for reading. If it opens successfully, read the entire contents of
the file and store it in variable file_contents.
Also see
None