GetXMLEntity
Script function

world.GetXMLEntity

DOC_scripting Read about scripting

Type

Method

Summary

Retrieves the value of a standard entity

Prototype

BSTR GetXMLEntity(BSTR Entity);

DOC_data_types View list of 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).



See Also ...

Topic

DOC_info Information

Functions

FNC_Debug Debug (Displays debugging information about the world)
FNC_EchoInput EchoInput (A flag to indicate whether we are echoing command input to the output window)
FNC_GetConnectDuration GetConnectDuration (Returns the number of seconds this world has been connected.)
FNC_GetEntity GetEntity (Retrieves the value of an MXP server-defined entity)
FNC_GetHostAddress GetHostAddress (Returns a list of IP addresses that correspond to a host name on the Internet)
FNC_GetHostName GetHostName (Returns the host name that corresponds to an IP address on the Internet)
FNC_GetInfo GetInfo (Gets information about the current world)
FNC_GetInternalCommandsList GetInternalCommandsList (Returns a list of the internal MUSHclient command names)
FNC_GetLineCount GetLineCount (Gets count of lines received)
FNC_GetLineInfo GetLineInfo (Gets details about a specified line in the output window)
FNC_GetLinesInBufferCount GetLinesInBufferCount (Returns the number of lines in the output window)
FNC_GetMainWindowPosition GetMainWindowPosition (Returns the position and size of the main MUSHclient window)
FNC_GetNotepadWindowPosition GetNotepadWindowPosition (Returns the position and size of the specified notepad window)
FNC_GetNotes GetNotes (Gets the world's notes)
FNC_GetQueue GetQueue (Returns a variant array which is a list of queued commands)
FNC_GetReceivedBytes GetReceivedBytes (Returns the number of bytes received from the world)
FNC_GetRecentLines GetRecentLines (Assembles a block of text from recent MUD output)
FNC_GetSelectionEndColumn GetSelectionEndColumn (Returns the endling column of the selection in the output window)
FNC_GetSelectionEndLine GetSelectionEndLine (Returns the last line of the selection in the output window)
FNC_GetSelectionStartColumn GetSelectionStartColumn (Returns the starting column of the selection in the output window)
FNC_GetSelectionStartLine GetSelectionStartLine (Returns the starting line of the selection in the output window)
FNC_GetSentBytes GetSentBytes (Returns the number of bytes sent to the world)
FNC_GetStyleInfo GetStyleInfo (Gets details about a specified style run for a specified line in the output window)
FNC_GetSysColor GetSysColor (Gets the colour of various windows items)
FNC_GetSystemMetrics GetSystemMetrics (Returns selected system information from Windows)
FNC_GetVariable GetVariable (Gets the contents of a variable)
FNC_GetWorldID GetWorldID (Returns the 24-character ID of the current world)
FNC_GetWorldWindowPosition GetWorldWindowPosition (Returns the position and size of the current world window)
FNC_GetWorldWindowPositionX GetWorldWindowPositionX (Returns the position and size of a specific world window)
FNC_IsConnected IsConnected (Tests to see if the world is connected to the MUD server)
FNC_SetChanged SetChanged (Sets or clears the "document has changed" flag)
FNC_SetEntity SetEntity (Sets the value of an MXP entity)
FNC_UdpPortList UdpPortList (Returns an array of all the UDP ports in use by this world)
FNC_Version Version (Gets the MUSHclient version string.)
FNC_WorldAddress WorldAddress (Returns the TCP/IP address of the current world.)
FNC_WorldName WorldName (Gets the world's name)
FNC_WorldPort WorldPort (Returns the port number of the current world.)

(Help topic: function=GetXMLEntity)

DOC_contents Documentation contents page