
Section 8: TSP command reference
Model 2461 Interactive SourceMeter® Instrument Reference Manual
8-62
2461-901-01 A/November 2015
Also see
(on page 8-57)
(on page 8-59)
(on page 8-62)
display.input.string()
This function allows you to create a dialog box that requests text from the user through the front-panel display.
Type
TSP-Link accessible
Affected by
Where saved
Default value
Function
Yes
Usage
textEntered
= display.input.string(
dialogTitle
)
textEntered
= display.input.string(
dialogTitle
,
textFormat
)
textEntered
The text that is entered from the front-panel display;
nil
if Cancel is pressed on the
keypad
dialogTitle
A string that contains the text to be displayed as the title of the dialog box on the
front-panel display; up to 32 characters
textFormat
The format of the entered text:
•
Allow any characters:
display.SFORMAT_ANY
(default)
•
Allow both upper and lower case letters (no special characters):
display.SFORMAT_UPPER_LOWER
•
Allow only upper case letters:
display.SFORMAT_UPPER
•
Allow both upper and lower case letters, no special characters, no spaces,
and limited to 32 characters:
display.SFORMAT_BUFFER_NAME
Details
This command creates a prompt to the instrument operator to enter a string value.
The prompt is displayed until it has been responded to. You can only send one input prompt
command at a time.