Script function

world.GetAliasList

Type

Method

Summary

Gets the list of aliases

Prototype

VARIANT GetAliasList();

Description

Returns an array of all the named aliases currently defined. You can then use GetAlias or GetAliasInfo for more details about each one.

Note - from version 3.40 onwards GetAliasList returns all aliases, even unlabelled ones. The unlabelled aliases will have assigned an "internal" label (like "*alias42") that can be used in GetAliasInfo, and similar routines.

VBscript example

dim alList

alList = world.GetAliasList

If Not IsEmpty (alList) then

  For Each name In alList 
    world.Note name
  Next

End If

Jscript example

aliaslist = new VBArray(world.GetAliasList()).toArray();

if (aliaslist)  // if not empty
 for (i = 0; i < aliaslist.length; i++)
   world.note(aliaslist [i]);

PerlScript example

foreach $item (Win32::OLE::in ($world->GetAliasList))
 {
 $world->note($item);
 }

Python example

aliaslist = world.GetAliasList
if (aliaslist ):
  for a in aliaslist : world.Note (a)

Lua example

al = GetAliasList()
if al then
  for k, v in ipairs (al) do 
    Note (v) 
  end  -- for
end -- if we have any aliases

Lua notes

Lua returns nil where applicable instead of an "empty variant".

Return value

If there are no aliases (with names) then the return value is empty. Use "IsEmpty" to test for this possibility.

Otherwise, it returns a variant array containing the names of all the aliases. Use "ubound" to find the number of aliases in the list. You can then use "GetAlias" to find details about each alias.

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
(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=GetAliasList)