Input

Displays a dialog box in which an operator can input a single value. The dialog box has a title, a prompt, and a single edit field. For multiple inputs, use the Form Functions.

This function is a blocking function. It will block the calling Cicode task until the operation is complete.

Syntax

Input(Title, Prompt, Default)

Title:

The title of the input box.

Prompt:

The prompt text.

Default:

The default text that the operator can edit or replace.

Return Value

The edit field entry (as a string). If the user presses the Cancel button , an empty string is returned and the IsError() function returns the error code 299.

Related Functions

Message, FormNew

Example

/* Shut down Plant SCADA if the user inputs "Yes". */
STRING sStr;
sStr=Input("Shutdown","Do you wish to shutdown?","Yes");
IF sStr="Yes" THEN
Shutdown();
END

See Also

Miscellaneous Functions