[Home] [Downloads] [Search] [Help/forum]

GetPluginAliasInfo

Script function

world.GetPluginAliasInfo

Read about scripting

Type

Method

Summary

Gets details about a named alias for a specified plugin

Prototype

VARIANT GetPluginAliasInfo(BSTR PluginID, BSTR AliasName, short InfoType);

View list of data type meanings

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)


Available in MUSHclient version 3.23 onwards.



VBscript example

world.note world.GetPluginAliasInfo ("c8efc9f9e1edd118c6f2dbf5", "my_alias", 2)


Jscript example

world.note(world.GetPluginAliasInfo  ("c8efc9f9e1edd118c6f2dbf5", "my_alias", 2));


PerlScript example

/$world->note ($world->GetPluginAliasInfo  ("c8efc9f9e1edd118c6f2dbf5", "my_alias", 2));


Python example

world.note(world.GetPluginAliasInfo  ("c8efc9f9e1edd118c6f2dbf5", "my_alias", 2))


Lua example

Note (GetPluginAliasInfo  ("c8efc9f9e1edd118c6f2dbf5", "my_alias", 2))


Lua notes

Lua returns nil where applicable instead of an "empty variant" or "null variant".


Return value

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.
A NULL variant if the plugin is not installed.


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
(GetAlias) Gets details about an alias
(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
(GetPluginAliasList) Gets the list of aliases in a specified plugin
(GetPluginAliasOption) Gets the value of a named alias option for a specified plugin
(IsAlias) Tests to see if an alias exists
(SetAliasOption) Sets the value of a named alias option

(Help topic: function=GetPluginAliasInfo)

Documentation contents page


Search ...

Enter a search string to find matching documentation.

Search for:   

Quick links: MUSHclient. MUSHclient help. Forum shortcuts. Posting templates. Lua modules. Lua documentation.

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

[Home]


Written by Nick Gammon - 5K   profile for Nick Gammon on Stack Exchange, a network of free, community-driven Q&A sites   Marriage equality

Comments to: Gammon Software support
[RH click to get RSS URL] Forum RSS feed ( https://gammon.com.au/rss/forum.xml )

[Best viewed with any browser - 2K]    [Hosted at FutureQuest]