Script function
world.DeleteAlias
Read about scripting
Type
Method
Summary
Deletes an alias
Prototype
long DeleteAlias(BSTR AliasName);
View list of data type meanings
Description
Deletes the named alias from the list of aliases.
WARNING - if the alias is executing a script it cannot be deleted. For example, an alias cannot delete itself.
If you need to delete an alias from within itself use DoAfterSpecial to delete it after a short delay. You might also want to use EnableGroup to disable it first.
VBscript example
world.DeleteAlias "my_alias"
Jscript example
world.DeleteAlias("my_alias");
PerlScript example
$world->DeleteAlias("my_alias");
Python example
world.DeleteAlias("my_alias")
Lua example
DeleteAlias("my_alias")
Return value
eInvalidObjectLabel: The alias name is not valid
eAliasNotFound: The named alias does not exist
eItemInUse: Cannot delete trigger/alias/timer because it is executing a script
eOK: deleted OK
View list of return code meanings
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
(DeleteAliasGroup) Deletes a group of aliases
(DeleteTemporaryAliases) Deletes all temporary aliases
(DoAfterSpecial) Adds a one-shot, temporary, timer to carry out some special action
(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
(IsAlias) Tests to see if an alias exists
(SetAliasOption) Sets the value of a named alias option
(Help topic: function=DeleteAlias)