Name GetAliasInfo
Type Method
Summary Gets details about an alias
Prototype VARIANT GetAliasInfo(BSTR AliasName, short InfoType);
Description Gets details about the specified alias name.

You can obtain one of 22 "types" of information about the alias by specifying an "InfoType". The possible InfoTypes are:

1: What to match on (string)
2: What to send (string)
3: Script procedure name (string)
4: Omit from log (boolean)
5: Omit from output (boolean)
6: Enabled (boolean)
7: Regular expression (boolean)
8: Ignore case (boolean)
9: Expand variables (boolean)
10: Invocation count (long)
11: Times matched (long)
12: Menu (boolean)
13: Date/time alias last matched (date)
14: 'temporary' flag (boolean)
15: Alias was included from an include file (boolean)


101: Wildcard %1 from last time it matched
102: Wildcard %2 from last time it matched
103: Wildcard %3 from last time it matched
104: Wildcard %4 from last time it matched
105: Wildcard %5 from last time it matched
106: Wildcard %6 from last time it matched
107: Wildcard %7 from last time it matched
108: Wildcard %8 from last time it matched
109: Wildcard %9 from last time it matched
110: Wildcard %0 from last time it matched

The word in brackets indicates the "type" of data returned.
String: a character string (eg. "north")
Boolean: TRUE or FALSE
Long: a 32-bit number

The field "invocation count" is a count of how many times the script routine was called.
The field "times matched" is a count of how many times the alias matched. These two would normally be the same, unless scripting was disabled, or there was an error in the script file.

If the named alias does not exist, EMPTY is returned. If the name given is invalid, NULL is returned. If the InfoType given is out of range, NULL is returned. (Use "IsEmpty" and "IsNull" to test for these possibilities).

See AddAlias for a description of the meanings of the fields.
VBscript example 
world.note world.getaliasinfo ("my_alias", 2)
Jscript example 
/world.note(world.getaliasinfo ("my_alias", 2));
PerlScript example 
/$world->note ($world->getaliasinfo ("my_alias", 2));
Returns The specified information about the alias, as described above.
An EMPTY variant, if the alias does not exist.
A NULL variant if the alias name is invalid.
A NULL variant if the InfoType is not a valid type.

See also ...