Dns.GetHostAddressesAsync Method (String)

.NET Framework (current version)

Note
The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Returns the Internet Protocol (IP) addresses for the specified host as an asynchronous operation.

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

Syntax

C++

[<HostProtectionAttribute(SecurityAction.LinkDemand, ExternalThreading = true)>]
static member GetHostAddressesAsync : 
        hostNameOrAddress:string -> Task<IPAddress[]>

Parameters

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

Return Value

Type: System.Threading.Tasks.Task<IPAddress[]>

Returns Task<'TResult>.

The task object representing the asynchronous operation. The Result property on the task object returns an array of type IPAddress that holds the IP addresses for the host that is specified by the hostNameOrAddress parameter.

Exceptions

Exception	Condition
ArgumentNullException	hostNameOrAddress is null.
ArgumentOutOfRangeException	The length of hostNameOrAddress is greater than 255 characters.
SocketException	An error is encountered when resolving hostNameOrAddress.
ArgumentException	hostNameOrAddress is an invalid IP address.

Remarks

This operation will not block. The returned Task<'TResult> object will complete after the hostNameOrAddress has been resolved.

This method queries a DNS server for the IP addresses associated with a host name. If hostNameOrAddress is an IP address, this address is returned without querying the DNS server.

Version Information

.NET Framework
Available since 4.5