Script function

world.DeleteVariable

Type

Method

Summary

Deletes a variable

Prototype

long DeleteVariable(BSTR VariableName);

Description

Deletes the named variable.

VBscript example

world.DeleteVariable "myvariable"

Jscript example

world.DeleteVariable("myvariable");

PerlScript example

$world->DeleteVariable("myvariable");

Python example

world.DeleteVariable("myvariable")

Lua example

DeleteVariable("myvariable")

Return value

eInvalidObjectLabel: The alias name is not valid
eVariableNotFound: The variable does not exist
eOK: deleted OK

See Also ...

Topics

Arrays
Plugins
Scripting
Variables

Functions

(GetVariable) Gets the contents of a variable
(GetVariableList) Gets the list of variables
(SetVariable) Sets the value of a variable

(Help topic: function=DeleteVariable)