Field-Map Scripting

4.1.1.2.4 InputString

InputString function


Prototype:

function InputString (const caption, msg: string): variant;

Description:

The InputString function displays a dialog allowing the user to input a string. The dialog has a caption specified by the caption parameter, contains the text specified by the msg parameter and "OK" and "Cancel" buttons.

Syntax:

variable := InputString(Caption,Msg);


Part

Description


variable

variable declared as variant


Caption

A string parameter which specifies the caption of the dialog box.


Msg

A string parameter which specifies the message displayed in the dialog box.




Return value:

A string variable if the user has entered a valid string and confirmed it by the "OK" button or a null if the user has pressed the "Cancel" button


Example:


Var plotName : variant;

Begin
  plotName := InputString('Plot name', 'Enter the plot name:');
End.




See also:

InputInteger; InputIntegerWithCounter; InputFloat; InputString; InputText; InputOption; InputOptionWithStartingValue; InputFromList;InputFromListWithStartingValue; InputFromCheckListTab; InputFromListTab