world.GetAlias

MUSHclient script function (Method)

Gets details about an alias

Prototype

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

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 almatch
local alresponse
local alflags
local alscriptname


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

print (iStatus, 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

Return code meanings

Related topic

Aliases

See also