GetString

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

Syntax

sString, bSuccess = GetString()

sString, bSuccess = GetString( s )

sString, bSuccess = GetString( s, sPrompt )

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

where

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.

bSuccess is an optional success flag. If [OK] is clicked, the function returns the sString and bSuccess=true. If the dialog is canceled, "", false is returned.

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, bSuccess = GetString( "My string", "Enter a string :" )