world.GetXMLEntity

MUSHclient script function (Method) — introduced in version 3.66

Retrieves the value of a standard entity

Prototype

BSTR GetXMLEntity(BSTR Entity);

Data type meanings

Description

Returns the value of a standard XML/MXP (HTML) entity.

To get user (server defined) entities use GetEntity.

Entity names are the standard HTML ones. There is a list on this page:

http://www.gammon.com.au/mushclient/mxpentities.htm

You can also use entities in the form: #nnn where nnn is a decimal number in the range 32 to 255.

You can also use entities in the form: #xhh where hh is a hexadecimal number in the range 20 to FF.

The entity name should *not* include the leading ampersand or trailing semicolon that you use in XML, MXP or HTML.

VBscript example

world.Note world.GetXMLEntity("lt")

Jscript example

world.Note (world.GetXMLEntity("lt"));

PerlScript example

$world->Note (world.GetXMLEntity("lt"));

Python example

world.Note (world.GetXMLEntity ("lt"))

Lua example

Note (GetXMLEntity ("lt"))

Return value

The contents of the specified entity, or an empty string if no such entity is found, or the syntax is invalid (eg. #999).

Related topic

Information

See also