Section 7: Command reference Model 2651A High Power System SourceMeter® Instrument Reference Manual
7-58 2651A-901-01 Rev. A / March 2011
display.gettext()
This function reads the text displayed on the instrument front panel.
Type TSP-Link accessible
Affected by Where saved Default value
Function Yes
Usage
text = display.gettext()
text = display.gettext(embellished)
text = display.gettext(embellished, row)
text = display.gettext(embellished, row, columnStart)
text = display.gettext(embellished, row, columnStart, columnEnd)
text
The returned value, which contains the text that is presently displayed
embellished
Indicates type of returned text: false (simple text); true (text with embedded
character codes)
row
Selects the row from which to read the text: 1 (row 1); 2 (row 2). If row is not
included, both rows of text are read
columnStart
Selects the first column from which to read text; for row 1, the valid column numbers
are 1 to 20; for row 2, the valid column numbers are 1 to 32; if nothing is selected, 1
is used
columnEnd
Selects the last column from which to read text; for row 1, the valid column numbers
are 1 to 20; for row 2, the valid column numbers are 1 to 32; the default is 20 for row
1, and 32 for row 2
Details
Using the command without any parameters returns both lines of the display.
The $N character code is included in the returned value to show where the top line ends and the bottom line
begins. This is not affected by the value of embellished.
When embellished is set to true, all other character codes are returned along with the message. When
embellished is set to false, only the message and the $N character code is returned. For information on the
embedded character codes, see display.settext()
(on page 7-70).
The display is not switched to the user screen (the screen set using display.settext()). Text will be read
from the active screen.
To Next Page
Loading...
Need help?
General
