GetAlias
Script function

world.GetAlias

DOC_scripting Read about scripting

Type

Method

Summary

Gets details about an alias

Prototype

long GetAlias(BSTR AliasName, VARIANT* MatchText, VARIANT* ResponseText, VARIANT* Parameter, VARIANT* Flags, VARIANT* ScriptName);

DOC_data_types View list of data type meanings

Description

Gets details about the specified alias name.

See AddAlias for a description of the meanings of the fields.

This function does not appear to work when using Jscript or PerlScript, so if you are using those languages you should see GetAliasInfo instead. See below for how it works with Lua.

VBscript example

dim alname
dim almatch
dim alresponse
dim alparameter
dim alflags
dim alscriptname
dim iStatus

iStatus = world.getalias (alname, almatch, alresponse, _
              alparameter, alflags, alscriptname)


Jscript example

// Use GetAliasInfo when using Jscript


PerlScript example

# Use GetAliasInfo when using PerlScript


Python example

# Use GetAliasInfo when using Python


Lua example

local iStatus

local alname
local almatch
local alresponse
local alflags
local alscriptname


iStatus, alname, almatch, alresponse, alflags, alscriptname  =
   GetAlias ("myalias")

print (iStatus, alname, almatch, alresponse, alflags, alscriptname)


Lua notes

Lua does not let you call by reference, however it can return multiple results.

Thus GetAlias is implemented to return the various fields as a multiple-return result, 
as shown in the example above.

The field Parameter is deprecated and thus not returned.


Return value

eInvalidObjectLabel: The alias name is not valid
eAliasNotFound: The named alias does not exist
eOK: completed OK


DOC_errors View list of return code meanings

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_DeleteAliasGroup DeleteAliasGroup (Deletes a group of aliases)
FNC_DeleteTemporaryAliases DeleteTemporaryAliases (Deletes all temporary aliases)
FNC_EnableAlias EnableAlias (Enables or disables an alias)
FNC_EnableAliasGroup EnableAliasGroup (Enables/disables a group of aliases)
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_IsAlias IsAlias (Tests to see if an alias exists)
FNC_SetAliasOption SetAliasOption (Sets the value of a named alias option)

(Help topic: function=GetAlias)

DOC_contents Documentation contents page