Section 14: TSP command reference
2470 High Voltage SourceMeter Instrument Reference Manual
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
Function
No
Usage
fileContents
= file.read(
fileNumber
,
readAction
)
fileContents
The contents of the file based on the
readAction
parameter
fileNumber
The file number returned from the
file.open()
function to read
readAction
The action:
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:
file.READ_ALL
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)
end
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
.
Close the file.
Also see
None
