Export (0) Print
Expand All

Ping.SendPingAsync Method (IPAddress, Int32, Byte[])

.NET Framework 4.5

Send an Internet Control Message Protocol (ICMP) echo message with the specified data buffer to the computer that has the specified IPAddress, and receives a corresponding ICMP echo reply message from that computer as an asynchronous operation. This overload allows you to specify a time-out value for the operation and a buffer to use for send and receive.

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

[<HostProtectionAttribute(SecurityAction.LinkDemand, ExternalThreading = true)>]
member SendPingAsync : 
        address:IPAddress * 
        timeout:int * 
        buffer:byte[] -> Task<PingReply> 

Parameters

address
Type: System.Net.IPAddress

An IP address that identifies the computer that is the destination for the ICMP echo message.

timeout
Type: System.Int32

The maximum number of milliseconds (after sending the echo message) to wait for the ICMP echo reply message.

buffer
Type: System.Byte[]

A Byte array that contains data to be sent with the ICMP echo message and returned in the ICMP echo reply message. The array cannot contain more than 65,500 bytes.

Return Value

Type: System.Threading.Tasks.Task(PingReply)
Returns Task(TResult).
The task object representing the asynchronous operation.

ExceptionCondition
ArgumentNullException

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

-or-

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

ArgumentOutOfRangeException

timeout is less than zero.

InvalidOperationException

A call to SendPingAsync is in progress.

PingException

An exception was thrown while sending or receiving the ICMP messages. See the inner exception for the exact exception that was thrown.

SocketException

address is not a valid IP address.

ObjectDisposedException

This object has been disposed.

ArgumentException

The size of buffer exceeds 65,500 bytes.

This operation will not block. The returned Task(TResult)> object will complete after the ICMP packet has been sent and the response has been received.

NoteNote

The HostProtectionAttribute attribute applied to this type or member has the following Resources property value: ExternalThreading. The HostProtectionAttribute does not affect desktop applications (which are typically started by double-clicking an icon, typing a command, or entering a URL in a browser). For more information, see the HostProtectionAttribute class or SQL Server Programming and Host Protection Attributes.

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

Show:
© 2014 Microsoft