Script function

world.GetHostAddress

Type

Method

Summary

Returns a list of IP addresses that correspond to a host name on the Internet

Prototype

VARIANT GetHostAddress(BSTR HostName);

Description

Returns a variant array which is a list of all the TCP/IP addresses which correspond to a given IP address, using DNS (Domain Name Server).

Warning - because this function has to connect to a DNS server and await a response it may take some time to execute, perhaps 20 seconds or more.

It should not be used in a script where speed is the essence, or which is executed frequently. If you need to know the answer multiple times you should "cache" the result for future use.

The intended purpose is to relate an address in the chat system (eg. during the connection phase) to a domain name.

The reason an array is returned is because a single name might have multiple hosts (eg. Microsoft, Netscape) so a list of all of them is returned.

Available in MUSHclient version 3.39 onwards.

VBscript example

For Each ip In GetHostAddress ("www.netscape.com")
  Note ip
Next

Jscript example

iplist = new VBArray(world.GetHostAddress ("www.netscape.com")).toArray();

if (iplist)  // if not empty
 for (i = 0; i < iplist.length; i++)
   Note (iplist [i]);

PerlScript example

foreach $item (Win32::OLE::in ($world->GetHostAddress ("www.netscape.com")))
 {
 Note ($item);
 }

Python example

iplist = world.GetHostAddress ("www.netscape.com")
if (iplist ):
  for ip in iplist : world.Note (ip)

Lua example

for k, v in pairs (GetHostAddress ("www.netscape.com")) do 
  Note (v) 
end

Return value

If there were no addresses returned then the return value is empty. Use "IsEmpty" to test for this possibility.

Otherwise, it returns a variant array containing the IP addresses for this domain name. Use "ubound" to find the number of addresses in the list.

See Also ...

Topic

Information

Functions

(Debug) Displays debugging information about the world
(EchoInput) A flag to indicate whether we are echoing command input to the output window
(GetConnectDuration) Returns the number of seconds this world has been connected.
(GetEntity) Retrieves the value of an MXP server-defined entity
(GetHostName) Returns the host name that corresponds to an IP address on the Internet
(GetInfo) Gets information about the current world
(GetInternalCommandsList) Returns a list of the internal MUSHclient command names
(GetLineCount) Gets count of lines received
(GetLineInfo) Gets details about a specified line in the output window
(GetLinesInBufferCount) Returns the number of lines in the output window
(GetMainWindowPosition) Returns the position and size of the main MUSHclient window
(GetNotepadWindowPosition) Returns the position and size of the specified notepad window
(GetNotes) Gets the world's notes
(GetQueue) Returns a variant array which is a list of queued commands
(GetReceivedBytes) Returns the number of bytes received from the world
(GetRecentLines) Assembles a block of text from recent MUD output
(GetSelectionEndColumn) Returns the endling column of the selection in the output window
(GetSelectionEndLine) Returns the last line of the selection in the output window
(GetSelectionStartColumn) Returns the starting column of the selection in the output window
(GetSelectionStartLine) Returns the starting line of the selection in the output window
(GetSentBytes) Returns the number of bytes sent to the world
(GetStyleInfo) Gets details about a specified style run for a specified line in the output window
(GetSysColor) Gets the colour of various windows items
(GetSystemMetrics) Returns selected system information from Windows
(GetWorldID) Returns the 24-character ID of the current world
(GetWorldWindowPosition) Returns the position and size of the current world window
(GetWorldWindowPositionX) Returns the position and size of a specific world window
(GetXMLEntity) Retrieves the value of a standard entity
(IsConnected) Tests to see if the world is connected to the MUD server
(SetChanged) Sets or clears the "document has changed" flag
(SetEntity) Sets the value of an MXP entity
(UdpPortList) Returns an array of all the UDP ports in use by this world
(Version) Gets the MUSHclient version string.
(WorldAddress) Returns the TCP/IP address of the current world.
(WorldName) Gets the world's name
(WorldPort) Returns the port number of the current world.

(Help topic: function=GetHostAddress)