Ping.Send Method (IPAddress, Int32, Byte[], PingOptions) (System.Net.NetworkInformation)

Send Method (IPAddress, Int32, Byte...

Switch on low bandwidth view

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 2008/.NET Framework 3.5

Other versions are also available for the following:

.NET Framework Class Library

Ping..::.Send Method (IPAddress, Int32, array<Byte>[]()[], PingOptions)

Attempts to send an Internet Control Message Protocol (ICMP) echo message with the specified data buffer to the computer that has the specified IPAddress and receive a corresponding ICMP echo reply message from that computer. This overload allows you to specify a time-out value for the operation and control fragmentation and Time-to-Live values for the ICMP echo message packet.

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

Syntax

Visual Basic (Declaration)

Public Function Send ( _
    address As IPAddress, _
    timeout As Integer, _
    buffer As Byte(), _
    options As PingOptions _
) As PingReply

Visual Basic (Usage)

Dim instance As Ping
Dim address As IPAddress
Dim timeout As Integer
Dim buffer As Byte()
Dim options As PingOptions
Dim returnValue As PingReply

returnValue = instance.Send(address, timeout, _
    buffer, options)

public PingReply Send(
    IPAddress address,
    int timeout,
    byte[] buffer,
    PingOptions options
)

Visual C++

public:
PingReply^ Send(
    IPAddress^ address, 
    int timeout, 
    array<unsigned char>^ buffer, 
    PingOptions^ options
)

JScript

public function Send(
    address : IPAddress, 
    timeout : int, 
    buffer : byte[], 
    options : PingOptions
) : PingReply

Parameters

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

timeout: Type: System..::.Int32
An Int32 value that specifies the maximum number of milliseconds (after sending the echo message) to wait for the ICMP echo reply message.

buffer: Type: array<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.Net.NetworkInformation..::.PingReply
A PingReply object that provides information about the ICMP echo reply message, if one was received, or provides the reason for the failure, if no message was received. The method will return PacketTooBig if the packet exceeds the Maximum Transmission Unit (MTU).

Exceptions

Exception	Condition
ArgumentNullException	address is nullNothingnullptra null reference (Nothing in Visual Basic). -or- buffer is nullNothingnullptra null reference (Nothing in Visual Basic), or the buffer size is greater than 65500 bytes.
ArgumentOutOfRangeException	timeout is less than zero.
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.
SocketException	address is not a valid IP address.
ObjectDisposedException	This object has been disposed.
ArgumentException	The size of buffer exceeds 65500 bytes.

Remarks

If the ICMP echo reply message is not received within the time specified by the timeout parameter, the ICMP echo fails, and the Status property is set to TimedOut.

Note:
When specifying very small numbers for timeout, the Ping reply can be received even if timeout milliseconds have elapsed.

If the DontFragment property 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.

Use the Ttl property to specify the maximum number of times the ICMP echo message can be forwarded before reaching its destination. 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 how to call this method.

public static void ComplexLocalPing ()
{
    // Ping's the local machine.
    Ping pingSender = new Ping ();
    IPAddress address = IPAddress.Loopback;

    // Create a buffer of 32 bytes of data to be transmitted.
    string data = "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa";
    byte[] buffer = Encoding.ASCII.GetBytes (data);

    // Wait 10 seconds for a reply.
    int timeout = 10000;

    // Set options for transmission:
    // The data can go through 64 gateways or routers
    // before it is destroyed, and the data packet
    // cannot be fragmented.
    PingOptions options = new PingOptions (64, true);
    PingReply reply = pingSender.Send (address, timeout, buffer, options);

    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);
    }
}

Visual C++

void ComplexLocalPing()
{

   // Ping's the local machine.
   Ping ^ pingSender = gcnew Ping;
   IPAddress^ address = IPAddress::Loopback;

   // Create a buffer of 32 bytes of data to be transmitted.
   String^ data = "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa";
   array<Byte>^buffer = Encoding::ASCII->GetBytes( data );

   // Wait 10 seconds for a reply.
   int timeout = 10000;

   // Set options for transmission:
   // The data can go through 64 gateways or routers
   // before it is destroyed, and the data packet
   // cannot be fragmented.
   PingOptions ^ options = gcnew PingOptions( 64,true );
   PingReply ^ reply = pingSender->Send( address, timeout, buffer, options );
   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 );
   }
}

.NET Framework Security

NetworkInformationPermission
To send an ICMP echo message.
Associated enumeration: Ping

Platforms

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

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

Version Information

.NET Framework

Supported in: 3.5, 3.0, 2.0

Reference

Ping Class

Ping Members

Send Overload

System.Net.NetworkInformation Namespace