Table of Contents

EditUI

Description

Open a user interface to edit the value of a variable.

Function prototype

bool EditUI <hvar:hVar> <string:Prompt>

Arguments

Name Type Comment
hVar hvar A handle to the variable to be edited.
Prompt string A string containing a prompt for the user (usually the window title).

Return value

The return value is true if the user presses OK in the editor dialog box, and false otherwise.

Example

string s
set s "This is a test"
EditUI &s "Edit this string"

… the output of which is the dialog box below:

The 'EditUI' window.

Comments

None.