| Name | GetPluginAliasInfo |
|---|---|
| Type | Method |
| Summary | Gets details about a named alias for a specified plugin |
| Prototype | VARIANT GetPluginAliasInfo(BSTR PluginID, BSTR AliasName, short InfoType); |
| Description | Gets details about the specified alias for the specified plugin. You can obtain various "types" of information about the alias by specifying an "InfoType". The possible InfoTypes are described under GetAliasInfo. 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. If the plugin does not exist, NULL is returned. (Use "IsEmpty" and "IsNull" to test for these possibilities). If you want to find the value of a alias in the current plugin, use "GetAliasInfo". If you are writing a plugin and want to find "global" MUSHclient alias values, use an empty plugin ID, eg. world.Note world.GetPluginAliasInfo ("", "my_alias", 1) Note: Available in MUSHclient version 3.23 onwards. |
| VBscript example | |
| Jscript example | |
| PerlScript example | |
| Returns | The specified information about the alias, as described above. |
See also ...