Export (0) Print
Expand All

Dns.GetHostEntry Method (String)

Resolves a host name or IP address to an IPHostEntry instance.

Namespace:  System.Net
Assembly:  System (in System.dll)

public static IPHostEntry GetHostEntry(
	string hostNameOrAddress
)

Parameters

hostNameOrAddress
Type: System.String
The host name or IP address to resolve.

Return Value

Type: System.Net.IPHostEntry
An IPHostEntry instance that contains address information about the host specified in hostNameOrAddress.

ExceptionCondition
ArgumentNullException

The hostNameOrAddress parameter is null.

ArgumentOutOfRangeException

The length of hostNameOrAddress parameter is greater than 255 characters.

SocketException

An error was encountered when resolving the hostNameOrAddress parameter.

ArgumentException

The hostNameOrAddress parameter is an invalid IP address.

The GetHostEntry method queries a DNS server for the IP address that is associated with a host name or IP address. If the DNS query fails, the system may fall back to a NetBIOS name query depending on the configuration of the local computer.

When an empty string is passed as the host name, this method returns the IPv4 addresses of the local host.

If the host name could not be found, the SocketException exception is returned with a value of 11001 (Windows Sockets error WSAHOST_NOT_FOUND). This exception can be returned if the name server does not respond. This exception can also be returned if the name is not an official host name or alias, or it cannot be found in the databases being queried.

The ArgumentException exception is also returned if the hostNameOrAddress parameter contains Any or IPv6Any.

The GetHostEntry method assumes that if an IP literal string is passed in the hostNameOrAddress parameter that the application wants an IPHostEntry instance returned with all of the properties set. These properties include the AddressList, Aliases, and HostName. As a result, the implementation of the GetHostEntry method exhibits the following behavior when an IP string literal is passed:

  1. The method tries to parse the address. If the hostNameOrAddress parameter contains a legal IP string literal, then the first phase succeeds.

  2. A reverse lookup using the IP address of the IP string literal is attempted to obtain the host name. This result is set as the HostName property.

  3. The host name from this reverse lookup is used again to obtain all the possible IP addresses associated with the name and set as the AddressList property.

For an IPv4 string literal, all three steps above may succeed. But it is possible for a stale DNS record for an IPv4 address that actually belongs to a different host to be returned. This may cause step #3 to fail and throw an exception (there is a DNS PTR record for the IPv4 address, but no DNS A record for the IPv4 address).

For IPv6, step #2 above may fail, since most IPv6 deployments do not register the reverse (PTR) record for an IPv6 address. So this method may return the string IPv6 literal as the fully-qualified domain (FQDN) host name in the HostName property.

The GetHostAddresses method has different behavior with respect to IP literals. If step #1 above succeeds (it successfully parses as an IP address), that address is immediately returned as the result. There is no attempt at a reverse lookup.

IPv6 addresses are filtered from the results of the GetHostEntry method if the local computer does not have IPv6 installed. As a result, it is possible to get back an empty IPHostEntry instance if only IPv6 results where available for the hostNameOrAddress.parameter.

The Aliases property of the IPHostEntry instance returned is not populated by this method and will always be empty.

NoteNote

This member emits trace information when you enable network tracing in your application. For more information, see Network Tracing.

The following example uses the GetHostEntry method to resolve an IP address to an IPHostEntry instance.


public static void DoGetHostEntry(string hostname)
{
    IPHostEntry host;

    host = Dns.GetHostEntry(hostname);

    Console.WriteLine("GetHostEntry({0}) returns:", hostname);

    foreach (IPAddress ip in host.AddressList)
    {
        Console.WriteLine("    {0}", ip);
    }
}


.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Community Additions

ADD
Show:
© 2014 Microsoft