Jackson Labs PHASE STATION 53100A, User Manual

Page: 159 / 225

PhaseStation 53100A User’s Manual V1.04 25-Apr-2022 159
ScriptGetString(String heading, String message, Object user_text, String b1_text [, String b2_text [, String b3_txt]])
Presents a modal dialog box to the user that accepts freeform text entry. An example
appears below.
var trace_caption = { value:"(Some default text could go here)" };
if (ScriptGetString( "OCXO Stability Test",
"Enter trace caption above, then click 'OK' to continue.",
trace_caption,
"OK",
"Cancel") != 0)
{
ScriptEnd();
return;
}
When executed, the result is a dialog box of the form
Text for one, two, or three buttons can be specified as the
b1_text
,
b2_text
, and/or
b3_text
argument(s) to
ScriptGetString()
. The returned value will equal the numeric index of the
button selected by the user, beginning with 0 for the
b1_text
button.
All text fields accept up to 1024 bytes. Note that the
user_text
argument is an Object
containing a String property called
value
, not a String in itself. The
value
property is used
both as the default text used to initialize the edit control and for reception of the
returned text. (This is necessary because Strings are always passed by copy in
JavaScript, while Objects are passed by reference and may be modified by the called
function.)
ScriptHostFilename([bool full_path])
Returns a String containing the TimeLab executable filename and version information.
Either the full pathname or only the filename portion may be requested, depending in
the value of the optional
full_path
parameter.
Figure 67: ScriptGetString() dialog