Model 2461 Interactive SourceMeter® Instrument Reference Manual
Section 8: TSP command reference
2461-901-01 A/November 2015
8-61
display.input.prompt()
This function allows you to create a prompt that accepts a user response from the front-panel display.
Type
TSP-Link accessible
Affected by
Where saved
Default value
Function
Yes
Usage
buttonReturn
= display.input.prompt(
buttonSet
,
dialogTitle
)
buttonReturn
Indicates which button was pressed:
•
OK:
display.BUTTON_OK
•
Cancel:
display.BUTTON_CANCEL
•
Yes:
display.BUTTON_YES
•
No:
display.BUTTON_NO
buttonSet
The set of buttons to display:
•
OK button only:
display.BUTTONS_OK
•
Cancel button only:
display.BUTTONS_CANCEL
•
OK and Cancel buttons:
display.BUTTONS_OKCANCEL
•
Yes and No buttons:
display.BUTTONS_YESNO
•
Yes, No, and Cancel buttons:
display.BUTTONS_YESNOCANCEL
dialogTitle
A string that contains the text to be displayed as the title of the dialog box on the
front-panel display; up to 63 characters
Details
This command waits for a user response to the prompt. You can use the text to ask questions that
can be used to configure your test.
The prompt is displayed until it has been responded to by the user. You can only send one input
prompt command at a time.
Example
result = display.input.prompt(display.BUTTONS_YESNO, "Do you want to display the
graph screen?")
if result == display.BUTTON_YES then
display.changescreen(display.SCREEN_GRAPH)
end
This displays the prompt "Do you want to display the graph screen?" on the front-panel display:
If the operator selects
Yes
, the graph screen is displayed.
