Ping::Send Method (IPAddress^)

.NET Framework (current version)

Attempts to send an Internet Control Message Protocol (ICMP) echo message to the computer that has the specified IPAddress, and receive a corresponding ICMP echo reply message from that computer.

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

Syntax

C++

public:
PingReply^ Send(
	IPAddress^ address
)

Parameters

address: Type: System.Net::IPAddress^
An IPAddress that identifies the computer that is the destination for the ICMP echo message.

Return Value

Type: System.Net.NetworkInformation::PingReply^

A PingReply object that provides information about the ICMP echo reply message, if one was received, or describes the reason for the failure if no message was received.

Exceptions

Exception	Condition
ArgumentNullException	address is null.
InvalidOperationException	A call to SendAsync is in progress.
NotSupportedException	address is an IPv6 address and the local computer is running an operating system earlier than Windows 2000.
PingException	An exception was thrown while sending or receiving the ICMP messages. See the inner exception for the exact exception that was thrown.
ObjectDisposedException	This object has been disposed.

This method sends to the host that is specified by address a 32 Byte data buffer with the ICMP echo message. The method waits five seconds for an ICMP echo reply message. If it does not receive a reply in that time, the method returns and the Status property is set to TimedOut.

This overload uses default settings for packet fragmentation and packet forwarding. The packet that contains the ICMP echo message can be fragmented in transit if the total packet size exceeds the maximum packet size that can be transmitted by one of the routing nodes between the local and remote computers. To prevent fragmentation, use one of the Send methods that takes an options parameter, and set the DontFragment property to true. When DontFragment is true and the total packet size exceeds the maximum packet size that can be transmitted by one of the routing nodes between the local and remote computers, the ICMP echo request fails. When this happens, the Status is set to PacketTooBig. The packet or packet fragments (if fragmented) can be forwarded by routing nodes 128 times before being discarded. To change this setting, use a Send overload that takes an options parameter, and set the Ttl property to the desired value. If the packet does not reach its destination after being forwarded the specified number of times, the packet is discarded and the ICMP echo request fails. When this happens, the Status is set to TtlExpired.

Examples

The following code example demonstrates calling this method.

C++

void LocalPing()
{

   // Ping's the local machine.
   Ping ^ pingSender = gcnew Ping;
   IPAddress^ address = IPAddress::Loopback;
   PingReply ^ reply = pingSender->Send( address );
   if ( reply->Status == IPStatus::Success )
   {
      Console::WriteLine( "Address: {0}", reply->Address->ToString() );
      Console::WriteLine( "RoundTrip time: {0}", reply->RoundtripTime );
      Console::WriteLine( "Time to live: {0}", reply->Options->Ttl );
      Console::WriteLine( "Don't fragment: {0}", reply->Options->DontFragment );
      Console::WriteLine( "Buffer size: {0}", reply->Buffer->Length );
   }
   else
   {
      Console::WriteLine( reply->Status );
   }
}

Security

NetworkInformationPermission

To send an ICMP echo message.

Associated enumeration: Ping

Version Information

.NET Framework
Available since 2.0