DeleteVariable
Script function

world.DeleteVariable

DOC_scripting Read about scripting

Type

Method

Summary

Deletes a variable

Prototype

long DeleteVariable(BSTR VariableName);

DOC_data_types View list of data type meanings

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


DOC_errors View list of return code meanings

See Also ...

Topics

DOC_Arrays Arrays
DOC_plugins Plugins
DOC_scripting Scripting
DOC_variables Variables

Functions

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

(Help topic: function=DeleteVariable)

DOC_contents Documentation contents page