====== var_EditUI ======

===== Description =====

Edit the value of a variable using L3DT's standard variable editing graphical user interface.

===== Function prototype =====

<code>bool CExtAPI::var_EditUI(ZVAR hVar, const char* lpPrompt);</code>



===== Arguments =====

^ Name ^ Type ^ Comment ^
| hVar | ZVAR | A ZVAR handle to a variable, the value of which is to be edited. |
| lpPrompt | const char* | A handle to a C-style string containing the title of the editor window. If null is given, a default title is used. |

===== Return value =====

False if:
  * The //hVar// handle is invalid (i.e. null.)
  * The [[zeolite:varID|variable type]] of //hVar// cannot be edited (see comments below.)
  * The user selects the 'Cancel' button in the user interface.
True otherwise.

===== Comments =====





==== Compatible types ====

The following [[zeolite:varID|variable types]] are compatible with the //var_EditUI// function:

  * VarID_char
  * VarID_byte
  * VarID_short
  * VarID_ushort
  * VarID_int
  * VarID_uint
  * VarID_int64
  * VarID_float
  * VarID_double
  * VarID_colour
  * VarID_vector3f
  * VarID_double
  * VarID_string
  * VarID_varlist
  * VarID_filesel
  * VarID_dirsel
  * VarID_combosel
  * VarID_Climate
  * VarID_LandType