Name GetVariable
Type Method
Summary Gets the contents of a variable
Prototype VARIANT GetVariable(BSTR VariableName);
Description Gets the contents of the named variable. If the named variable does not exist, EMPTY is returned. If the name given is invalid, NULL is returned. (Use \"IsEmpty\" and \"IsNull\" to test for these possibilities).

If GetVariable is called from within a plugin, the variables for the current plugin are used, not the \"global\" MUSHclient variables.

If you want to find the value of a variable in another plugin, or the global MUSHclient variables, use \"GetPluginVariable\".
VBscript example
dim MyName

MyName = world.GetVariable (\"MyName\")

if isempty (MyName) then
  world.note \"My name is not defined\"
end if

if isnull (MyName) then
  world.note \"Invalid variable name\"
end if

world.note MyName
Jscript example
var MyName;

MyName = world.GetVariable(\"MyName\");

if (MyName == null)
  world.note(\"MyName is not defined\");
else
  world.note(MyName);
PerlScript example
$MyName = $world->GetVariable(\"MyName\");

if (!defined ($MyName)) 
  {
  $world->note (\"MyName is not defined\");
  }
else 
  {
  $world->note ($MyName);
  }
Returns The contents of the specified variable.
An EMPTY variant, if the variable does not exist.
A NULL variant if the variable name is invalid.

See also ...