world.GetHostAddress

MUSHclient script function (Method) — introduced in version 3.39

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

Prototype

VARIANT GetHostAddress(BSTR HostName);

Data type meanings

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.

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.

Related topic

Information

See also

FunctionDescription
GetHostNameReturns the host name that corresponds to an IP address on the Internet