world.IsAlias

MUSHclient script function (Method)

Tests to see if an alias exists

Prototype

long IsAlias(BSTR AliasName);

Data type meanings

Description

Used to test if an alias exists.

Note that this function returns 0 if the alias *exists*.

VBscript example

world.note world.IsAlias ("myalias")

Jscript example

world.note(world.IsAlias("myalias"));

PerlScript example

$world->note($world->IsAlias("myalias"));

Python example

world.note(world.IsAlias("myalias"))

Lua example

Note(IsAlias("myalias"))

Return value

eInvalidObjectLabel: The alias name is not valid
eAliasNotFound: The named alias does not exist
eOK: completed OK - ie. The alias exists.

Return code meanings

Related topic

Aliases

See also