Register forum user name Search FAQ

MUSHclient scripting

Description of MUSHclient world function: world.GetAlias

Name GetAlias
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 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.
Returns 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 ...

Function Description
AddAlias Adds an alias
DeleteAlias Deletes an alias
EnableAlias Enables or disables an alias
GetAliasInfo Gets details about an alias
GetAliasList Gets the list of aliases
IsAlias Tests to see if an alias exists

Search for script function

Enter a word or phrase in the box below to narrow the list down to those that match.

The function name, prototype, summary, and description are searched.

Search for:   

Leave blank to show all functions.

Return codes

Many functions return a "code" which indicates the success or otherwise of the function.

You can view a list of the return codes

Function prototypes

The "prototype" part of each function description lists exactly how the function is called (what arguments, if any, to pass to it).

You can view a list of the data types used in function prototypes

View all functions

[Back]

Information and images on this site are licensed under the Creative Commons Attribution 3.0 Australia License unless stated otherwise.

Home