GetString

The GetString function opens a dialog to request a string. If you click [OK], the entered string is returned.

Syntax

sString, bOK = GetString()

sString, bOK = GetString( s )

sString, bOK = GetString( s, sPrompt )

sString, bOK = GetString( s, sPrompt, sTitle )

    s is the initial string. If nil, a blank string is used. If nil, a blank string is used.

    sPrompt is the message above the string field. If nil, a default is used.

    sTitle is the window title. If nil, a default is used.

    If [OK] is clicked, the function returns the sString and bOK=true.

    If the dialog is canceled, "",false is returned.

Remarks

All arguments are optional and assume default values beyond the last argument you specify. To use a default argument but follow it with a specified argument, use a nil in its place.

Example

The window shown above was created using the following code. Note that the last argument, the window title, was omitted and left to the default:

     string, bOK = GetString( "My string", "Enter a string :" )

Related Topics

GetText

GetNumber

Mira Pro x64 Script User's Guide, v.8.73 Copyright Ⓒ 2024 Mirametrics, Inc. All Rights Reserved.