Field-Map Scripting

4.1.1.2.1 InputInteger

InputInteger function


Prototype:

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

Description:

The InputInteger function displays a dialog allowing the user to input an integer number. 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 := InputInteger(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:

An integer variant if the user has entered a valid integer number and confirmed it by the "OK" button or a null variant if the user has pressed the "Cancel" button


Example:


Var n : variant;

Begin
  n := InputInteger('Number of branches', 'Enter number of branches');
  if not VarIsNull(n) then
    //do something   
End.


See also:

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