DeleteAliasGroup
Script function

world.DeleteAliasGroup

DOC_scripting Read about scripting

Type

Method

Summary

Deletes a group of aliases

Prototype

long DeleteAliasGroup(BSTR GroupName);

DOC_data_types View list of data type meanings

Description

Triggers, aliases and timers can be placed in "groups" where a group is a bunch of related items. Groups have names, there is no restriction on the name of a group. Ungrouped items have blank (empty) names.

To delete an entire group of aliases do this:

world.DeleteAliasGroup "groupname"

For debugging purposes the function returns a count of the number of members deleted. eg.

dim mycount
mycount = world.DeleteAliasGroup ("groupname")

If you are using plugins only the members of the current plugin (if any) are deleted. If the call is made outside a plugin only the members of the group that are not in a plugin are deleted.

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 EnableAliasGroup to disable it first.

Since DeleteAliasGroup deletes multiple aliases, any found to be "in use" (that is, executing a script) will not be deleted.

VBscript example

world.DeleteAliasGroup "groupname"


Jscript example

world.DeleteAliasGroup ("groupname");


PerlScript example

$world->DeleteAliasGroup ("groupname");


Python example

world.DeleteAliasGroup ("groupname")


Lua example

DeleteAliasGroup ("groupname")


Return value

A count of the number of items deleted.



See Also ...

Topics

DOC_aliases Aliases
DOC_mapper Auto-mapper
DOC_defaults Default triggers/aliases/timers/macros/colours
DOC_starting Getting started
DOC_group Groups
DOC_keypad Keypad navigation
DOC_macros Macro keys
DOC_plugins Plugins
DOC_regexp Regular Expressions
DOC_speed_walking Speed walking
DOC_timers Timers
DOC_triggers Triggers

Functions

FNC_AddAlias AddAlias (Adds an alias)
FNC_DeleteAlias DeleteAlias (Deletes an alias)
FNC_DeleteGroup DeleteGroup (Deletes a group of triggers, aliases and timers)
FNC_DeleteTemporaryAliases DeleteTemporaryAliases (Deletes all temporary aliases)
FNC_DeleteTimerGroup DeleteTimerGroup (Deletes a group of timers)
FNC_DeleteTriggerGroup DeleteTriggerGroup (Deletes a group of triggers)
FNC_DoAfterSpecial DoAfterSpecial (Adds a one-shot, temporary, timer to carry out some special action)
FNC_EnableAlias EnableAlias (Enables or disables an alias)
FNC_EnableAliasGroup EnableAliasGroup (Enables/disables a group of aliases)
FNC_EnableGroup EnableGroup (Enables/disables a group of triggers, aliases and timers)
FNC_EnableTimerGroup EnableTimerGroup (Enables/disables a group of timers)
FNC_EnableTriggerGroup EnableTriggerGroup (Enables/disables a group of triggers)
FNC_GetAlias GetAlias (Gets details about an alias)
FNC_GetAliasInfo GetAliasInfo (Gets details about an alias)
FNC_GetAliasList GetAliasList (Gets the list of aliases)
FNC_GetAliasOption GetAliasOption (Gets the value of a named alias option)
FNC_GetAliasWildcard GetAliasWildcard (Returns the contents of the specified wildcard for the named alias)
FNC_GetPluginAliasInfo GetPluginAliasInfo (Gets details about a named alias for a specified plugin)
FNC_GetPluginAliasList GetPluginAliasList (Gets the list of aliases in a specified plugin)
FNC_GetTimerInfo GetTimerInfo (Gets details about a timer)
FNC_GetTriggerInfo GetTriggerInfo (Gets details about a named trigger)
FNC_IsAlias IsAlias (Tests to see if an alias exists)
FNC_SetAliasOption SetAliasOption (Sets the value of a named alias option)

(Help topic: function=DeleteAliasGroup)

DOC_contents Documentation contents page