Script function

world.IsAlias

Type

Method

Summary

Tests to see if an alias exists

Prototype

long IsAlias(BSTR AliasName);

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.

See Also ...

Topics

Aliases
Auto-mapper
Default triggers/aliases/timers/macros/colours
Getting started
Groups
Keypad navigation
Macro keys
Plugins
Regular Expressions
Speed walking
Timers
Triggers

Functions

(AddAlias) Adds an alias
(DeleteAlias) Deletes an alias
(DeleteAliasGroup) Deletes a group of aliases
(DeleteTemporaryAliases) Deletes all temporary aliases
(EnableAlias) Enables or disables an alias
(EnableAliasGroup) Enables/disables a group of aliases
(GetAlias) Gets details about an alias
(GetAliasInfo) Gets details about an alias
(GetAliasList) Gets the list of aliases
(GetAliasOption) Gets the value of a named alias option
(GetAliasWildcard) Returns the contents of the specified wildcard for the named alias
(GetPluginAliasInfo) Gets details about a named alias for a specified plugin
(GetPluginAliasList) Gets the list of aliases in a specified plugin
(GetPluginAliasOption) Gets the value of a named alias option for a specified plugin
(SetAliasOption) Sets the value of a named alias option

(Help topic: function=IsAlias)