Ping.SendPingAsync Method (String, Int32, Byte[], PingOptions)
Sends an Internet Control Message Protocol (ICMP) echo message with the specified data buffer to the specified computer, and receive 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, a buffer to use for send and receive, and control fragmentation and Time-to-Live values for the ICMP echo message packet.
Namespace: System.Net.NetworkInformation
Assembly: System (in System.dll)
[<HostProtectionAttribute(SecurityAction.LinkDemand, ExternalThreading = true)>] member SendPingAsync : hostNameOrAddress:string * timeout:int * buffer:byte[] * options:PingOptions -> Task<PingReply>
Parameters
- hostNameOrAddress
- Type: System.String
The computer that is the destination for the ICMP echo message. The value specified for this parameter can be a host name or a string representation of an IP address.
- 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.
- options
- Type: System.Net.NetworkInformation.PingOptions
A PingOptions object used to control fragmentation and Time-to-Live values for the ICMP echo message packet.
Return Value
Type: System.Threading.Tasks.Task(PingReply)Returns Task(TResult).
The task object representing the asynchronous operation.
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.
Note |
|---|
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. |
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.
Note