IPStatus Enumeration

Reports the status of sending an Internet Control Message Protocol (ICMP) echo message to a computer.

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

public enum IPStatus

Member nameDescription
SuccessThe ICMP echo request succeeded; an ICMP echo reply was received. When you get this status code, the other PingReply properties contain valid data.
DestinationNetworkUnreachableThe ICMP echo request failed because the network that contains the destination computer is not reachable.
DestinationHostUnreachableThe ICMP echo request failed because the destination computer is not reachable.
DestinationProtocolUnreachableThe ICMP echo request failed because the destination computer that is specified in an ICMP echo message is not reachable, because it does not support the packet's protocol.
DestinationPortUnreachableThe ICMP echo request failed because the port on the destination computer is not available.
DestinationProhibitedThe ICMP echo request failed because contact with the destination computer is administratively prohibited.
NoResourcesThe ICMP echo request failed because of insufficient network resources.
BadOptionThe ICMP echo request failed because it contains an invalid option.
HardwareErrorThe ICMP echo request failed because of a hardware error.
PacketTooBigThe ICMP echo request failed because the packet containing the request is larger than the maximum transmission unit (MTU) of a node (router or gateway) located between the source and destination. The MTU defines the maximum size of a transmittable packet.
TimedOutThe ICMP echo Reply was not received within the allotted time. The default time allowed for replies is 5 seconds. You can change this value using the Send or SendAsync methods that take a timeout parameter.
BadRouteThe ICMP echo request failed because there is no valid route between the source and destination computers.
TtlExpiredThe ICMP echo request failed because its Time to Live (TTL) value reached zero, causing the forwarding node (router or gateway) to discard the packet.
TtlReassemblyTimeExceededThe ICMP echo request failed because the packet was divided into fragments for transmission and all of the fragments were not received within the time allotted for reassembly. RFC 2460 (available at www.ietf.org) specifies 60 seconds as the time limit within which all packet fragments must be received.
ParameterProblemThe ICMP echo request failed because a node (router or gateway) encountered problems while processing the packet header. This is the status if, for example, the header contains invalid field data or an unrecognized option.
SourceQuenchThe ICMP echo request failed because the packet was discarded. This occurs when the source computer's output queue has insufficient storage space, or when packets arrive at the destination too quickly to be processed.
BadDestinationThe ICMP echo request failed because the destination IP address cannot receive ICMP echo requests or should never appear in the destination address field of any IP datagram. For example, calling Send and specifying IP address "000.0.0.0" returns this status.
DestinationUnreachableThe ICMP echo request failed because the destination computer that is specified in an ICMP echo message is not reachable; the exact cause of problem is unknown.
TimeExceededThe ICMP echo request failed because its Time to Live (TTL) value reached zero, causing the forwarding node (router or gateway) to discard the packet.
BadHeaderThe ICMP echo request failed because the header is invalid.
UnrecognizedNextHeaderThe ICMP echo request failed because the Next Header field does not contain a recognized value. The Next Header field indicates the extension header type (if present) or the protocol above the IP layer, for example, TCP or UDP.
IcmpErrorThe ICMP echo request failed because of an ICMP protocol error.
DestinationScopeMismatchThe ICMP echo request failed because the source address and destination address that are specified in an ICMP echo message are not in the same scope. This is typically caused by a router forwarding a packet using an interface that is outside the scope of the source address. Address scopes (link-local, site-local, and global scope) determine where on the network an address is valid.
UnknownThe ICMP echo request failed for an unknown reason.

The Ping class uses the values in this enumeration to set the PingReply.Status property. The Ping class returns PingReply objects when you call the Ping.Send or Ping.SendAsync methods to check whether you can reach a computer across the network.

The following code example sends an ICMP echo message and checks the status.

using System;
using System.Net;
using System.Net.NetworkInformation;
using System.Text;

namespace Examples.System.Net.NetworkInformation.PingTest
{
    public class PingExample
    {
        // args[0] can be an IPaddress or host name. 
        public static void Main (string[] args)
        {
            Ping pingSender = new Ping ();
            PingOptions options = new PingOptions ();

            // Use the default Ttl value which is 128, 
            // but change the fragmentation behavior.
            options.DontFragment = true;

            // Create a buffer of 32 bytes of data to be transmitted.
            string data = "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa";
            byte[] buffer = Encoding.ASCII.GetBytes (data);
            int timeout = 120;
            PingReply reply = pingSender.Send (args[0], 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);
            }
        }
    }
}
#using <mscorlib.dll>
#using <System.dll>
using namespace System;
using namespace System::Net;
using namespace System::Net::NetworkInformation;
using namespace System::Text;

// args[1] can be an IPaddress or host name.
int main ()
{
    String* args[] = Environment::GetCommandLineArgs();

    Ping* pingSender = new Ping ();
    PingOptions* options = new PingOptions ();

    // Use the default Ttl value which is 128,
    // but change the fragmentation behavior.
    options->DontFragment = true;

    // Create a buffer of 32 bytes of data to be transmitted.
    String* data = S"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa";
    Byte buffer[] = Encoding::ASCII->GetBytes (data);
    int timeout = 120;
    PingReply* reply = pingSender->Send (args[1], buffer, timeout, options);
    if (reply->Status == IPStatus::Success)
    {
        Console::WriteLine (S"Address: {0}", reply->Address->ToString ());
        Console::WriteLine (S"RoundTrip time: {0}", __box(reply->RoundTripTime));
        Console::WriteLine (S"Time to live: {0}", __box(reply->Options->Ttl));
        Console::WriteLine (S"Don't fragment: {0}", __box(reply->Options->DontFragment));
        Console::WriteLine (S"Buffer size: {0}", __box(reply->Buffer->Length));
    }
}

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.

.NET Framework

Supported in: 3.5, 3.0, 2.0
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft