Export (0) Print
Expand All

Dns.BeginGetHostEntry Method (IPAddress, AsyncCallback, Object)

Asynchronously resolves an IP address to an IPHostEntry instance.

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

public static IAsyncResult BeginGetHostEntry (
	IPAddress address,
	AsyncCallback requestCallback,
	Object stateObject
)
public static IAsyncResult BeginGetHostEntry (
	IPAddress address, 
	AsyncCallback requestCallback, 
	Object stateObject
)
public static function BeginGetHostEntry (
	address : IPAddress, 
	requestCallback : AsyncCallback, 
	stateObject : Object
) : IAsyncResult
Not applicable.

Parameters

address

The IP address to resolve.

requestCallback

An AsyncCallback delegate that references the method to invoke when the operation is complete.

stateObject

A user-defined object that contains information about the operation. This object is passed to the requestCallback delegate when the operation is complete.

Return Value

An IAsyncResult instance that references the asynchronous request.

Exception typeCondition

ArgumentNullException

address is a null reference (Nothing in Visual Basic).

SocketException

An error is encountered when resolving address.

ArgumentException

address is an invalid IP address.

The BeginGetHostEntry method asynchronously queries a DNS server for the IP addresses and aliases associated with an IP address.

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

The asynchronous BeginGetHostEntry operation must be completed by calling the EndGetHostEntry method. Typically, the method is invoked by the requestCallback delegate.

This method does not block until the operation is complete. To block until the operation is complete, use the GetHostEntry method.

For detailed information about using the asynchronous programming model, see Calling Synchronous Methods Asynchronously

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

// Signals when the resolve has finished.
public static ManualResetEvent GetHostEntryFinished = 
    new ManualResetEvent(false);

// Define the state object for the callback. 
// Use hostName to correlate calls with the proper result.
public class ResolveState
{
    string hostName;
    IPHostEntry resolvedIPs;

    public ResolveState(string host)
    {
        hostName = host;
    }

    public IPHostEntry IPs
    {
        get { return resolvedIPs; } 
        set {resolvedIPs = value;}}
    public string host {get {return hostName;} 
        set {hostName = value;}}
}

// Record the IPs in the state object for later use.
public static void GetHostEntryCallback(IAsyncResult ar)
{
    ResolveState ioContext = (ResolveState)ar.AsyncState;

    ioContext.IPs = Dns.EndGetHostEntry(ar);
    GetHostEntryFinished.Set();
}       

// Determine the Internet Protocol (IP) addresses for 
// this host asynchronously.
public static void DoGetHostEntryAsync(string hostname)
{
    GetHostEntryFinished.Reset();
    ResolveState ioContext= new ResolveState(hostname);

    Dns.BeginGetHostEntry(ioContext.host, 
        new AsyncCallback(GetHostEntryCallback), ioContext);

    // Wait here until the resolve completes (the callback 
    // calls .Set())
    GetHostEntryFinished.WaitOne();

    Console.WriteLine("EndGetHostEntry({0}) returns:", ioContext.host);

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

Windows 98, Windows Server 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0

.NET Compact Framework

Supported in: 2.0

Community Additions

ADD
Show:
© 2014 Microsoft