151 lines
11 KiB
XML
151 lines
11 KiB
XML
|
<?xml version="1.0" encoding="utf-8"?>
|
||
|
|
<Type Name="PingReply" FullName="System.Net.NetworkInformation.PingReply">
|
||
|
|
<TypeSignature Language="C#" Value="public class PingReply" />
|
||
|
|
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit PingReply extends System.Object" />
|
||
|
|
<AssemblyInfo>
|
||
|
|
<AssemblyName>System</AssemblyName>
|
||
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
||
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
||
|
|
</AssemblyInfo>
|
||
|
|
<Base>
|
||
|
|
<BaseTypeName>System.Object</BaseTypeName>
|
||
|
|
</Base>
|
||
|
|
<Interfaces />
|
||
|
|
<Docs>
|
||
|
|
<since version=".NET 2.0" />
|
||
|
|
<remarks>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>The <see cref="T:System.Net.NetworkInformation.Ping" /> class attempts to send an Internet Control Message Protocol (ICMP) echo request to a remote computer and receive information back from the computer via an ICMP echo reply message. The <see cref="T:System.Net.NetworkInformation.Ping" /> class uses instances of the <see cref="T:System.Net.NetworkInformation.PingReply" /> class to return information about the operation, such as its status and the time taken to send the request and receive the reply. </para>
|
||
|
|
<para>The <see cref="Overload:System.Net.NetworkInformation.Ping.Send" /> methods return instances of the <see cref="T:System.Net.NetworkInformation.PingReply" /> class directly. The <see cref="Overload:System.Net.NetworkInformation.Ping.SendAsync" /> methods return a <see cref="T:System.Net.NetworkInformation.PingReply" /> in the <see cref="T:System.Net.NetworkInformation.PingCompletedEventHandler" /> method's <see cref="T:System.Net.NetworkInformation.PingCompletedEventArgs" /> parameter. The <see cref="T:System.Net.NetworkInformation.PingReply" /> is accessed through the <see cref="P:System.Net.NetworkInformation.PingCompletedEventArgs.Reply" /> property.</para>
|
||
|
|
<para>If the value of <see cref="P:System.Net.NetworkInformation.PingReply.Status" /> is not <see cref="F:System.Net.NetworkInformation.IPStatus.Success" />, you should not use the values returned by the <see cref="P:System.Net.NetworkInformation.PingReply.RoundtripTime" />, <see cref="P:System.Net.NetworkInformation.PingReply.Options" /> or <see cref="P:System.Net.NetworkInformation.PingReply.Buffer" /> properties. The <see cref="P:System.Net.NetworkInformation.PingReply.RoundtripTime" /> property will return zero, the <see cref="P:System.Net.NetworkInformation.PingReply.Buffer" /> property will return an empty array, and the <see cref="P:System.Net.NetworkInformation.PingReply.Options" /> property will return null.</para>
|
||
|
|
</remarks>
|
||
|
|
<summary>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>Provides information about the status and data resulting from a <see cref="Overload:System.Net.NetworkInformation.Ping.Send" /> or <see cref="Overload:System.Net.NetworkInformation.Ping.SendAsync" /> operation.</para>
|
||
|
|
</summary>
|
||
|
|
</Docs>
|
||
|
|
<Members>
|
||
|
|
<Member MemberName="Address">
|
||
|
|
<MemberSignature Language="C#" Value="public System.Net.IPAddress Address { get; }" />
|
||
|
|
<MemberSignature Language="ILAsm" Value=".property instance class System.Net.IPAddress Address" />
|
||
|
|
<MemberType>Property</MemberType>
|
||
|
|
<AssemblyInfo>
|
||
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
||
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
||
|
|
</AssemblyInfo>
|
||
|
|
<ReturnValue>
|
||
|
|
<ReturnType>System.Net.IPAddress</ReturnType>
|
||
|
|
</ReturnValue>
|
||
|
|
<Docs>
|
||
|
|
<value>To be added.</value>
|
||
|
|
<since version=".NET 2.0" />
|
||
|
|
<remarks>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>The <see cref="P:System.Net.NetworkInformation.PingReply.Address" /> returned by any of the <see cref="Overload:System.Net.NetworkInformation.Ping.Send" /> overloads can originate from a malicious remote computer. Do not connect to the remote computer using this address. Use DNS to determine the IP address of the machine to which you want to connect.</para>
|
||
|
|
</remarks>
|
||
|
|
<summary>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>Gets the address of the host that sends the Internet Control Message Protocol (ICMP) echo reply.</para>
|
||
|
|
</summary>
|
||
|
|
</Docs>
|
||
|
|
</Member>
|
||
|
|
<Member MemberName="Buffer">
|
||
|
|
<MemberSignature Language="C#" Value="public byte[] Buffer { get; }" />
|
||
|
|
<MemberSignature Language="ILAsm" Value=".property instance unsigned int8[] Buffer" />
|
||
|
|
<MemberType>Property</MemberType>
|
||
|
|
<AssemblyInfo>
|
||
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
||
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
||
|
|
</AssemblyInfo>
|
||
|
|
<ReturnValue>
|
||
|
|
<ReturnType>System.Byte[]</ReturnType>
|
||
|
|
</ReturnValue>
|
||
|
|
<Docs>
|
||
|
|
<value>To be added.</value>
|
||
|
|
<since version=".NET 2.0" />
|
||
|
|
<remarks>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>The data buffer sent with the ICMP echo request is returned to the sender in the echo reply so the roundtrip travel time for a packet of a known size can be computed. The data buffer, combined with the <see cref="P:System.Net.NetworkInformation.PingOptions.DontFragment" /> option, can be used to discover the maximum transmission unit for the network path between the source and destination computers. For additional information, see "Traceroute" in RFC 1574, Section 3.2, available at http://www.ietf.org.</para>
|
||
|
|
<para>The default buffer used with <see cref="Overload:System.Net.NetworkInformation.Ping.Send" /> and <see cref="Overload:System.Net.NetworkInformation.Ping.SendAsync" /> contains 32 bytes of data. </para>
|
||
|
|
</remarks>
|
||
|
|
<summary>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>Gets the buffer of data received in an Internet Control Message Protocol (ICMP) echo reply message.</para>
|
||
|
|
</summary>
|
||
|
|
</Docs>
|
||
|
|
</Member>
|
||
|
|
<Member MemberName="Options">
|
||
|
|
<MemberSignature Language="C#" Value="public System.Net.NetworkInformation.PingOptions Options { get; }" />
|
||
|
|
<MemberSignature Language="ILAsm" Value=".property instance class System.Net.NetworkInformation.PingOptions Options" />
|
||
|
|
<MemberType>Property</MemberType>
|
||
|
|
<AssemblyInfo>
|
||
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
||
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
||
|
|
</AssemblyInfo>
|
||
|
|
<ReturnValue>
|
||
|
|
<ReturnType>System.Net.NetworkInformation.PingOptions</ReturnType>
|
||
|
|
</ReturnValue>
|
||
|
|
<Docs>
|
||
|
|
<value>To be added.</value>
|
||
|
|
<since version=".NET 2.0" />
|
||
|
|
<remarks>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>The TTL defines the number of times nodes can forward a packet as it travels between its source and destination. If the number of forwards, also known as hops, exceeds the value specified for the TTL, the packet is deemed undeliverable and is discarded. </para>
|
||
|
|
<para>The <see cref="P:System.Net.NetworkInformation.PingOptions.DontFragment" /> value specified in the ICMP echo request controls packet fragmentation. If <see cref="P:System.Net.NetworkInformation.PingOptions.DontFragment" /> is true and the packet size exceeds the maximum transmission unit of the network path taken by the packet, the packet is discarded and the <see cref="F:System.Net.NetworkInformation.IPStatus.PacketTooBig" /> error is returned.</para>
|
||
|
|
</remarks>
|
||
|
|
<summary>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>Gets the options used to transmit the reply to an Internet Control Message Protocol (ICMP) echo request.</para>
|
||
|
|
</summary>
|
||
|
|
</Docs>
|
||
|
|
</Member>
|
||
|
|
<Member MemberName="RoundtripTime">
|
||
|
|
<MemberSignature Language="C#" Value="public long RoundtripTime { get; }" />
|
||
|
|
<MemberSignature Language="ILAsm" Value=".property instance int64 RoundtripTime" />
|
||
|
|
<MemberType>Property</MemberType>
|
||
|
|
<AssemblyInfo>
|
||
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
||
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
||
|
|
</AssemblyInfo>
|
||
|
|
<ReturnValue>
|
||
|
|
<ReturnType>System.Int64</ReturnType>
|
||
|
|
</ReturnValue>
|
||
|
|
<Docs>
|
||
|
|
<value>To be added.</value>
|
||
|
|
<since version=".NET 2.0" />
|
||
|
|
<remarks>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>If the Echo request fails, the <see cref="P:System.Net.NetworkInformation.PingReply.RoundtripTime" /> time is reported as 0, which is also a valid value when the request succeeds. You must check the <see cref="P:System.Net.NetworkInformation.PingReply.Status" /> to determine whether the value returned by this property should be ignored.</para>
|
||
|
|
</remarks>
|
||
|
|
<summary>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>Gets the number of milliseconds taken to send an Internet Control Message Protocol (ICMP) echo request and receive the corresponding ICMP echo reply message.</para>
|
||
|
|
</summary>
|
||
|
|
</Docs>
|
||
|
|
</Member>
|
||
|
|
<Member MemberName="Status">
|
||
|
|
<MemberSignature Language="C#" Value="public System.Net.NetworkInformation.IPStatus Status { get; }" />
|
||
|
|
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Net.NetworkInformation.IPStatus Status" />
|
||
|
|
<MemberType>Property</MemberType>
|
||
|
|
<AssemblyInfo>
|
||
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
||
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
||
|
|
</AssemblyInfo>
|
||
|
|
<ReturnValue>
|
||
|
|
<ReturnType>System.Net.NetworkInformation.IPStatus</ReturnType>
|
||
|
|
</ReturnValue>
|
||
|
|
<Docs>
|
||
|
|
<value>To be added.</value>
|
||
|
|
<since version=".NET 2.0" />
|
||
|
|
<remarks>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>If the value of <see cref="P:System.Net.NetworkInformation.PingReply.Status" /> is not <see cref="F:System.Net.NetworkInformation.IPStatus.Success" />, you should not use the values returned by the <see cref="P:System.Net.NetworkInformation.PingReply.RoundtripTime" />, <see cref="P:System.Net.NetworkInformation.PingReply.Options" /> or <see cref="P:System.Net.NetworkInformation.PingReply.Buffer" /> properties. The <see cref="P:System.Net.NetworkInformation.PingReply.RoundtripTime" /> and <see cref="P:System.Net.NetworkInformation.PingReply.Buffer" /> properties will return zero, and the <see cref="P:System.Net.NetworkInformation.PingReply.Options" /> property will return null.</para>
|
||
|
|
</remarks>
|
||
|
|
<summary>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>Gets the status of an attempt to send an Internet Control Message Protocol (ICMP) echo request and receive the corresponding ICMP echo reply message.</para>
|
||
|
|
</summary>
|
||
|
|
</Docs>
|
||
|
|
</Member>
|
||
|
|
</Members>
|
||
|
|
</Type>
|