GetAlias
Script function world.GetAlias 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);` 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
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) 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) 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) IsAlias (Tests to see if an alias exists) SetAliasOption (Sets the value of a named alias option) (Help topic: function=GetAlias) Documentation contents page