Merge pull request #820 from brendanzagaeski/master
[mono.git] / mcs / class / System / Documentation / en / System.Net / IPAddress.xml
1 <Type Name="IPAddress" FullName="System.Net.IPAddress" FullNameSP="System_Net_IPAddress" Maintainer="ecma">
2   <TypeSignature Language="ILASM" Value=".class public serializable IPAddress extends System.Object" />
3   <TypeSignature Language="C#" Value="public class IPAddress" />
4   <MemberOfLibrary>Networking</MemberOfLibrary>
5   <AssemblyInfo>
6     <AssemblyName>System</AssemblyName>
7     <AssemblyPublicKey>[00 00 00 00 00 00 00 00 04 00 00 00 00 00 00 00 ]</AssemblyPublicKey>
8     <AssemblyVersion>1.0.x.x</AssemblyVersion>
9     <AssemblyVersion>1.0.5000.0</AssemblyVersion>
10     <AssemblyVersion>2.0.0.0</AssemblyVersion>
11   </AssemblyInfo>
12   <ThreadingSafetyStatement>All public static members of this type are safe for multithreaded operations. No instance members are guaranteed to be thread safe.</ThreadingSafetyStatement>
13   <Base>
14     <BaseTypeName>System.Object</BaseTypeName>
15   </Base>
16   <Interfaces />
17   <Docs>
18     <summary>
19       <para>Represents an Internet Protocol (IP) address.</para>
20     </summary>
21     <remarks>
22       <para>An instance of the <see cref="T:System.Net.IPAddress" /> class contains the
23    value of an address on an IP
24    network. This address is stored internally as a <see cref="T:System.Int64" qualify="true" />
25    
26    in network-byte-order.</para>
27       <para>
28         <block subset="none" type="note">
29    
30    Different conventions are in use
31    for ordering bytes within multi-byte data types. All IP address values must be sent over the network in
32    network-byte-order. Network-byte-order puts the most significant byte first (also known
33    as big-endian order). On the host, the ordering of bytes
34    is platform-specific and this ordering is referred to as host-byte-order.</block>
35       </para>
36       <para>The IP address can be represented as four numbers in the range
37    0-255 separated by periods (for example, "192.168.1.2"), known as dotted-quad notation. </para>
38       <block subset="none" type="note">
39         <para> The address space is fragmented into
40       different types determined by bits 31-28 as shown in the following table.</para>
41         <list type="table">
42           <listheader>
43             <term> Bits 31-28</term>
44             <description>Address type</description>
45             <description>Address range</description>
46           </listheader>
47           <item>
48             <term> 0xxx</term>
49             <description>class A </description>
50             <description>0.0.0.0-127.255.255.255</description>
51           </item>
52           <item>
53             <term> 10xx</term>
54             <description>class B</description>
55             <description>128.0.0.0-191.255.255.255</description>
56           </item>
57           <item>
58             <term> 110x</term>
59             <description>class C</description>
60             <description>192.0.0.0-223.255.255.255</description>
61           </item>
62           <item>
63             <term> 1110</term>
64             <description>multicast</description>
65             <description>224.0.0.0-239.255.255.255</description>
66           </item>
67           <item>
68             <term> 1111</term>
69             <description>reserved</description>
70             <description>240.0.0.0-255.255.255.255</description>
71           </item>
72         </list>
73       </block>
74       <para>Instances of the <see cref="T:System.Net.IPAddress" /> class are provided for common IP address values as shown in the
75 following table.</para>
76       <para>
77         <list type="table">
78           <listheader>
79             <term>Field</term>
80             <description>IP
81          Address</description>
82           </listheader>
83           <item>
84             <term> Any</term>
85             <description>0.0.0.0</description>
86           </item>
87           <item>
88             <term> Broadcast</term>
89             <description>255.255.255.255</description>
90           </item>
91           <item>
92             <term> Loopback</term>
93             <description>127.0.0.1</description>
94           </item>
95           <item>
96             <term> None</term>
97             <description>255.255.255.255</description>
98           </item>
99         </list>
100       </para>
101     </remarks>
102   </Docs>
103   <Members>
104     <Member MemberName=".ctor">
105       <MemberSignature Language="C#" Value="public IPAddress (byte[] address);" />
106       <MemberType>Constructor</MemberType>
107       <Parameters>
108         <Parameter Name="address" Type="System.Byte[]" />
109       </Parameters>
110       <Docs>
111         <param name="address">To be added.</param>
112         <summary>To be added.</summary>
113         <remarks>To be added.</remarks>
114       </Docs>
115       <AssemblyInfo>
116         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
117         <AssemblyVersion>2.0.0.0</AssemblyVersion>
118       </AssemblyInfo>
119     </Member>
120     <Member MemberName=".ctor">
121       <MemberSignature Language="ILASM" Value="public rtspecialname specialname instance void .ctor(int64 newAddress)" />
122       <MemberSignature Language="C#" Value="public IPAddress (long addr);" />
123       <MemberType>Constructor</MemberType>
124       <ReturnValue />
125       <Parameters>
126         <Parameter Name="addr" Type="System.Int64" />
127       </Parameters>
128       <Docs>
129         <param name="addr">A <see cref="T:System.Int64" /> containing the IP address in host-byte-order. </param>
130         <summary>
131           <para>Constructs and initializes a new instance of the <see cref="T:System.Net.IPAddress" />
132 class.</para>
133         </summary>
134         <remarks>To be added.</remarks>
135         <exception cref="T:System.ArgumentOutOfRangeException">
136           <paramref name="newAddress" /> is less than 0 or greater than 0x00000000FFFFFFFF.</exception>
137       </Docs>
138       <Excluded>0</Excluded>
139       <AssemblyInfo>
140         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
141         <AssemblyVersion>2.0.0.0</AssemblyVersion>
142       </AssemblyInfo>
143     </Member>
144     <Member MemberName=".ctor">
145       <MemberSignature Language="C#" Value="public IPAddress (byte[] address, long scopeId);" />
146       <MemberType>Constructor</MemberType>
147       <Parameters>
148         <Parameter Name="address" Type="System.Byte[]" />
149         <Parameter Name="scopeId" Type="System.Int64" />
150       </Parameters>
151       <Docs>
152         <param name="address">To be added.</param>
153         <param name="scopeId">To be added.</param>
154         <summary>To be added.</summary>
155         <remarks>To be added.</remarks>
156       </Docs>
157       <AssemblyInfo>
158         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
159         <AssemblyVersion>2.0.0.0</AssemblyVersion>
160       </AssemblyInfo>
161     </Member>
162     <Member MemberName="Address">
163       <MemberSignature Language="ILASM" Value=".property int64 Address { public hidebysig specialname instance int64 get_Address() public hidebysig specialname instance void set_Address(int64 value) }" />
164       <MemberSignature Language="C#" Value="public long Address { set; get; }" />
165       <MemberType>Property</MemberType>
166       <ReturnValue>
167         <ReturnType>System.Int64</ReturnType>
168       </ReturnValue>
169       <Parameters />
170       <Docs>
171         <summary>
172           <para>Gets or sets an Internet Protocol (IP) address.</para>
173         </summary>
174         <value>
175           <para>A <see cref="T:System.Int64" /> containing
176    the IP address in host-byte-order.</para>
177         </value>
178         <remarks>
179           <block subset="none" type="note">
180             <para>To convert <see cref="P:System.Net.IPAddress.Address" />
181    to dotted-quad notation, use the <see cref="M:System.Net.IPAddress.ToString" />
182    method.</para>
183             <para>Values greater than 0x00000000FFFFFFFF  are permitted for IPv6 extensibility.</para>
184           </block>
185         </remarks>
186         <exception cref="T:System.ArgumentOutOfRangeException">The value specified in a set operation is less than 0.</exception>
187       </Docs>
188       <Excluded>0</Excluded>
189       <AssemblyInfo>
190         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
191         <AssemblyVersion>2.0.0.0</AssemblyVersion>
192       </AssemblyInfo>
193       <Attributes>
194         <Attribute>
195           <AttributeName>System.Obsolete("This property is obsolete. Use GetAddressBytes.")</AttributeName>
196         </Attribute>
197       </Attributes>
198     </Member>
199     <Member MemberName="AddressFamily">
200       <MemberSignature Language="ILASM" Value=".property valuetype System.Net.Sockets.AddressFamily AddressFamily { public hidebysig specialname instance valuetype System.Net.Sockets.AddressFamily get_AddressFamily() }" />
201       <MemberSignature Language="C#" Value="public System.Net.Sockets.AddressFamily AddressFamily { get; }" />
202       <MemberType>Property</MemberType>
203       <ReturnValue>
204         <ReturnType>System.Net.Sockets.AddressFamily</ReturnType>
205       </ReturnValue>
206       <Parameters />
207       <Docs>
208         <summary>
209           <para> Gets the address family.</para>
210         </summary>
211         <value>
212           <para>
213             <see cref="F:System.Net.Sockets.AddressFamily.InterNetwork" /> 
214 .</para>
215         </value>
216         <remarks>
217           <para>This property is read-only.</para>
218         </remarks>
219       </Docs>
220       <Excluded>0</Excluded>
221       <AssemblyInfo>
222         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
223         <AssemblyVersion>2.0.0.0</AssemblyVersion>
224       </AssemblyInfo>
225     </Member>
226     <Member MemberName="Any">
227       <MemberSignature Language="ILASM" Value=".field public static initOnly class System.Net.IPAddress Any" />
228       <MemberSignature Language="C#" Value="public static readonly System.Net.IPAddress Any;" />
229       <MemberType>Field</MemberType>
230       <ReturnValue>
231         <ReturnType>System.Net.IPAddress</ReturnType>
232       </ReturnValue>
233       <Parameters />
234       <Docs>
235         <summary>
236           <para> Indicates that the protocol will
237       select which address to use. </para>
238         </summary>
239         <remarks>
240           <para>This field is read-only.</para>
241           <para> This is equivalent to <see cref="!:System.Net.IPAddress.IPAddress" /> (0x0000000000000000) and represents the address
242    0.0.0.0.</para>
243         </remarks>
244       </Docs>
245       <Excluded>0</Excluded>
246       <AssemblyInfo>
247         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
248         <AssemblyVersion>2.0.0.0</AssemblyVersion>
249       </AssemblyInfo>
250     </Member>
251     <Member MemberName="Broadcast">
252       <MemberSignature Language="ILASM" Value=".field public static initOnly class System.Net.IPAddress Broadcast" />
253       <MemberSignature Language="C#" Value="public static readonly System.Net.IPAddress Broadcast;" />
254       <MemberType>Field</MemberType>
255       <ReturnValue>
256         <ReturnType>System.Net.IPAddress</ReturnType>
257       </ReturnValue>
258       <Parameters />
259       <Docs>
260         <summary>
261           <para> Provides the IP broadcast address.</para>
262         </summary>
263         <remarks>
264           <para>This field is read-only.</para>
265           <para> This is equivalent to <see cref="!:System.Net.IPAddress.IPAddress" /> (0x00000000FFFFFFFF) and represents the address 255.255.255.255.</para>
266           <para>This value is used to simultaneously address every host on the network.</para>
267           <block subset="none" type="note">
268             <para>Multiple fields are defined for this IP address based on prior
269       art. This field is identical to <see cref="F:System.Net.IPAddress.None" />.</para>
270           </block>
271         </remarks>
272       </Docs>
273       <Excluded>0</Excluded>
274       <AssemblyInfo>
275         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
276         <AssemblyVersion>2.0.0.0</AssemblyVersion>
277       </AssemblyInfo>
278     </Member>
279     <Member MemberName="Equals">
280       <MemberSignature Language="ILASM" Value=".method public hidebysig virtual bool Equals(object comparand)" />
281       <MemberSignature Language="C#" Value="public override bool Equals (object other);" />
282       <MemberType>Method</MemberType>
283       <ReturnValue>
284         <ReturnType>System.Boolean</ReturnType>
285       </ReturnValue>
286       <Parameters>
287         <Parameter Name="other" Type="System.Object" />
288       </Parameters>
289       <Docs>
290         <param name="other">A <see cref="T:System.Object" /> to compare to the current instance.</param>
291         <summary>
292           <para>Determines whether the current instance and the
293       specified <see cref="T:System.Object" />
294       represent the same IP address.</para>
295         </summary>
296         <returns>
297           <para>A <see cref="T:System.Boolean" qualify="true" /> where <see langword="true" /> indicates <paramref name="comparand" /> is an instance of the <see cref="T:System.Net.IPAddress" /> class
298    and has the same <see cref="P:System.Net.IPAddress.Address" /> property value
299    as the current instance; otherwise
300 <see langword="false" />.</para>
301         </returns>
302         <remarks>
303           <block subset="none" type="note">
304             <para>This method
305          overrides <see cref="M:System.Object.Equals(System.Object)" qualify="true" />.</para>
306           </block>
307         </remarks>
308       </Docs>
309       <Excluded>0</Excluded>
310       <AssemblyInfo>
311         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
312         <AssemblyVersion>2.0.0.0</AssemblyVersion>
313       </AssemblyInfo>
314     </Member>
315     <Member MemberName="GetAddressBytes">
316       <MemberSignature Language="C#" Value="public byte[] GetAddressBytes ();" />
317       <MemberType>Method</MemberType>
318       <ReturnValue>
319         <ReturnType>System.Byte[]</ReturnType>
320       </ReturnValue>
321       <Parameters />
322       <Docs>
323         <summary>To be added.</summary>
324         <returns>To be added.</returns>
325         <remarks>To be added.</remarks>
326       </Docs>
327       <AssemblyInfo>
328         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
329         <AssemblyVersion>2.0.0.0</AssemblyVersion>
330       </AssemblyInfo>
331     </Member>
332     <Member MemberName="GetHashCode">
333       <MemberSignature Language="ILASM" Value=".method public hidebysig virtual int32 GetHashCode()" />
334       <MemberSignature Language="C#" Value="public override int GetHashCode ();" />
335       <MemberType>Method</MemberType>
336       <ReturnValue>
337         <ReturnType>System.Int32</ReturnType>
338       </ReturnValue>
339       <Parameters />
340       <Docs>
341         <summary>
342           <para>Generates a hash code for the current instance.</para>
343         </summary>
344         <returns>
345           <para>A <see cref="T:System.Int32" />
346 containing the hash code for the current instance.</para>
347         </returns>
348         <remarks>
349           <para>The algorithm used to generate the hash code is
350          unspecified.</para>
351           <block subset="none" type="note">
352             <para>This method overrides <see cref="M:System.Object.GetHashCode" qualify="true" />.</para>
353           </block>
354         </remarks>
355       </Docs>
356       <Excluded>0</Excluded>
357       <AssemblyInfo>
358         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
359         <AssemblyVersion>2.0.0.0</AssemblyVersion>
360       </AssemblyInfo>
361     </Member>
362     <Member MemberName="HostToNetworkOrder">
363       <MemberSignature Language="ILASM" Value=".method public hidebysig static int16 HostToNetworkOrder(int16 host)" />
364       <MemberSignature Language="C#" Value="public static short HostToNetworkOrder (short host);" />
365       <MemberType>Method</MemberType>
366       <ReturnValue>
367         <ReturnType>System.Int16</ReturnType>
368       </ReturnValue>
369       <Parameters>
370         <Parameter Name="host" Type="System.Int16" />
371       </Parameters>
372       <Docs>
373         <param name="host">A <see cref="T:System.Int16" /> in host-byte-order.</param>
374         <summary>
375           <para>Converts a <see cref="T:System.Int16" /> from host-byte-order to network-byte-order.</para>
376         </summary>
377         <returns>
378           <para>A <see cref="T:System.Int16" />
379 in network-byte-order.</para>
380         </returns>
381         <remarks>
382           <para>This method performs conversions on systems where the host-byte-order differs 
383       from network-byte-order. On systems where this is not the case, this method does
384       nothing.</para>
385         </remarks>
386       </Docs>
387       <Excluded>0</Excluded>
388       <AssemblyInfo>
389         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
390         <AssemblyVersion>2.0.0.0</AssemblyVersion>
391       </AssemblyInfo>
392     </Member>
393     <Member MemberName="HostToNetworkOrder">
394       <MemberSignature Language="ILASM" Value=".method public hidebysig static int32 HostToNetworkOrder(int32 host)" />
395       <MemberSignature Language="C#" Value="public static int HostToNetworkOrder (int host);" />
396       <MemberType>Method</MemberType>
397       <ReturnValue>
398         <ReturnType>System.Int32</ReturnType>
399       </ReturnValue>
400       <Parameters>
401         <Parameter Name="host" Type="System.Int32" />
402       </Parameters>
403       <Docs>
404         <param name="host">A <see cref="T:System.Int32" /> in host-byte-order.</param>
405         <summary>
406           <para>Converts a <see cref="T:System.Int32" /> from host-byte-order to network-byte-order.</para>
407         </summary>
408         <returns>
409           <para>A <see cref="T:System.Int32" />
410 in network-byte-order.</para>
411         </returns>
412         <remarks>
413           <para>This method performs conversions on systems where the host-byte-order differs 
414       from network-byte-order. On systems where this is not the case, this method does
415       nothing.</para>
416         </remarks>
417       </Docs>
418       <Excluded>0</Excluded>
419       <AssemblyInfo>
420         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
421         <AssemblyVersion>2.0.0.0</AssemblyVersion>
422       </AssemblyInfo>
423     </Member>
424     <Member MemberName="HostToNetworkOrder">
425       <MemberSignature Language="ILASM" Value=".method public hidebysig static int64 HostToNetworkOrder(int64 host)" />
426       <MemberSignature Language="C#" Value="public static long HostToNetworkOrder (long host);" />
427       <MemberType>Method</MemberType>
428       <ReturnValue>
429         <ReturnType>System.Int64</ReturnType>
430       </ReturnValue>
431       <Parameters>
432         <Parameter Name="host" Type="System.Int64" />
433       </Parameters>
434       <Docs>
435         <param name="host">A <see cref="T:System.Int64" /> in host-byte-order.</param>
436         <summary>
437           <para> Converts a <see cref="T:System.Int64" /> from host-byte-order to network-byte-order.</para>
438         </summary>
439         <returns>
440           <para>A <see cref="T:System.Int64" /> in network-byte-order.</para>
441         </returns>
442         <remarks>
443           <para>This method performs conversions on systems where the host-byte-order differs 
444       from network-byte-order. On systems where this is not the case, this method does
445       nothing.</para>
446         </remarks>
447       </Docs>
448       <Excluded>0</Excluded>
449       <AssemblyInfo>
450         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
451         <AssemblyVersion>2.0.0.0</AssemblyVersion>
452       </AssemblyInfo>
453     </Member>
454     <Member MemberName="IPv6Any">
455       <MemberSignature Language="C#" Value="public static readonly System.Net.IPAddress IPv6Any;" />
456       <MemberType>Field</MemberType>
457       <ReturnValue>
458         <ReturnType>System.Net.IPAddress</ReturnType>
459       </ReturnValue>
460       <Docs>
461         <summary>To be added.</summary>
462         <remarks>To be added.</remarks>
463       </Docs>
464       <AssemblyInfo>
465         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
466         <AssemblyVersion>2.0.0.0</AssemblyVersion>
467       </AssemblyInfo>
468     </Member>
469     <Member MemberName="IPv6Loopback">
470       <MemberSignature Language="C#" Value="public static readonly System.Net.IPAddress IPv6Loopback;" />
471       <MemberType>Field</MemberType>
472       <ReturnValue>
473         <ReturnType>System.Net.IPAddress</ReturnType>
474       </ReturnValue>
475       <Docs>
476         <summary>To be added.</summary>
477         <remarks>To be added.</remarks>
478       </Docs>
479       <AssemblyInfo>
480         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
481         <AssemblyVersion>2.0.0.0</AssemblyVersion>
482       </AssemblyInfo>
483     </Member>
484     <Member MemberName="IPv6None">
485       <MemberSignature Language="C#" Value="public static readonly System.Net.IPAddress IPv6None;" />
486       <MemberType>Field</MemberType>
487       <ReturnValue>
488         <ReturnType>System.Net.IPAddress</ReturnType>
489       </ReturnValue>
490       <Docs>
491         <summary>To be added.</summary>
492         <remarks>To be added.</remarks>
493       </Docs>
494       <AssemblyInfo>
495         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
496         <AssemblyVersion>2.0.0.0</AssemblyVersion>
497       </AssemblyInfo>
498     </Member>
499     <Member MemberName="IsIPv6LinkLocal">
500       <MemberSignature Language="C#" Value="public bool IsIPv6LinkLocal { get; }" />
501       <MemberType>Property</MemberType>
502       <AssemblyInfo>
503         <AssemblyVersion>2.0.0.0</AssemblyVersion>
504       </AssemblyInfo>
505       <ReturnValue>
506         <ReturnType>System.Boolean</ReturnType>
507       </ReturnValue>
508       <Docs>
509         <summary>To be added.</summary>
510         <value>To be added.</value>
511         <remarks>To be added.</remarks>
512       </Docs>
513     </Member>
514     <Member MemberName="IsIPv6Multicast">
515       <MemberSignature Language="C#" Value="public bool IsIPv6Multicast { get; }" />
516       <MemberType>Property</MemberType>
517       <AssemblyInfo>
518         <AssemblyVersion>2.0.0.0</AssemblyVersion>
519       </AssemblyInfo>
520       <ReturnValue>
521         <ReturnType>System.Boolean</ReturnType>
522       </ReturnValue>
523       <Docs>
524         <summary>To be added.</summary>
525         <value>To be added.</value>
526         <remarks>To be added.</remarks>
527       </Docs>
528     </Member>
529     <Member MemberName="IsIPv6SiteLocal">
530       <MemberSignature Language="C#" Value="public bool IsIPv6SiteLocal { get; }" />
531       <MemberType>Property</MemberType>
532       <AssemblyInfo>
533         <AssemblyVersion>2.0.0.0</AssemblyVersion>
534       </AssemblyInfo>
535       <ReturnValue>
536         <ReturnType>System.Boolean</ReturnType>
537       </ReturnValue>
538       <Docs>
539         <summary>To be added.</summary>
540         <value>To be added.</value>
541         <remarks>To be added.</remarks>
542       </Docs>
543     </Member>
544     <Member MemberName="IsIPv6Teredo">
545       <MemberSignature Language="C#" Value="public bool IsIPv6Teredo { get; }" />
546       <MemberType>Property</MemberType>
547       <AssemblyInfo>
548         <AssemblyVersion>4.0.0.0</AssemblyVersion>
549       </AssemblyInfo>
550       <ReturnValue>
551         <ReturnType>System.Boolean</ReturnType>
552       </ReturnValue>
553       <Docs>
554         <summary>To be added.</summary>
555         <value>To be added.</value>
556         <remarks>To be added.</remarks>
557       </Docs>
558     </Member>
559     <Member MemberName="IsLoopback">
560       <MemberSignature Language="ILASM" Value=".method public hidebysig static bool IsLoopback(class System.Net.IPAddress address)" />
561       <MemberSignature Language="C#" Value="public static bool IsLoopback (System.Net.IPAddress addr);" />
562       <MemberType>Method</MemberType>
563       <ReturnValue>
564         <ReturnType>System.Boolean</ReturnType>
565       </ReturnValue>
566       <Parameters>
567         <Parameter Name="addr" Type="System.Net.IPAddress" />
568       </Parameters>
569       <Docs>
570         <param name="addr"> A <see cref="T:System.Net.IPAddress" /> containing the IP address to check.</param>
571         <summary>
572           <para> Returns a <see cref="T:System.Boolean" /> that indicates whether the specified IP address is a loopback address.</para>
573         </summary>
574         <returns>
575           <para>
576             <see langword="true " />if
577 <paramref name="address " /> is a loopback address; otherwise
578 <see langword="false" />.</para>
579         </returns>
580         <remarks>
581           <para> All IP addresses of the form 127.X.Y.Z, where X, Y, and Z are
582       in the range 0-255, are forwarded to the IP loopback address 127.0.0.1.
583       The <see cref="F:System.Net.IPAddress.Loopback" /> address is
584       used to specify the address of the local computer. </para>
585         </remarks>
586       </Docs>
587       <Excluded>0</Excluded>
588       <AssemblyInfo>
589         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
590         <AssemblyVersion>2.0.0.0</AssemblyVersion>
591       </AssemblyInfo>
592     </Member>
593     <Member MemberName="Loopback">
594       <MemberSignature Language="ILASM" Value=".field public static initOnly class System.Net.IPAddress Loopback" />
595       <MemberSignature Language="C#" Value="public static readonly System.Net.IPAddress Loopback;" />
596       <MemberType>Field</MemberType>
597       <ReturnValue>
598         <ReturnType>System.Net.IPAddress</ReturnType>
599       </ReturnValue>
600       <Parameters />
601       <Docs>
602         <summary>
603           <para> Provides the IP loopback
604       address.</para>
605         </summary>
606         <remarks>
607           <para>This field is read-only.</para>
608           <para> This is equivalent to <see cref="!:System.Net.IPAddress.IPAddress" /> (0x000000000100007F) and represents the address
609    127.0.0.1.</para>
610           <para> The loopback address is used to specify the address of the local computer.</para>
611         </remarks>
612       </Docs>
613       <Excluded>0</Excluded>
614       <AssemblyInfo>
615         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
616         <AssemblyVersion>2.0.0.0</AssemblyVersion>
617       </AssemblyInfo>
618     </Member>
619     <Member MemberName="NetworkToHostOrder">
620       <MemberSignature Language="ILASM" Value=".method public hidebysig static int16 NetworkToHostOrder(int16 network)" />
621       <MemberSignature Language="C#" Value="public static short NetworkToHostOrder (short network);" />
622       <MemberType>Method</MemberType>
623       <ReturnValue>
624         <ReturnType>System.Int16</ReturnType>
625       </ReturnValue>
626       <Parameters>
627         <Parameter Name="network" Type="System.Int16" />
628       </Parameters>
629       <Docs>
630         <param name="network">A <see cref="T:System.Int16" /> in network-byte-order.</param>
631         <summary>
632           <para>Converts a <see cref="T:System.Int16" qualify="true" /> from network-byte-order to host-byte-order.</para>
633         </summary>
634         <returns>
635           <para>A <see cref="T:System.Int16" />
636 in host-byte-order.</para>
637         </returns>
638         <remarks>
639           <para>This method performs conversions on systems where the host-byte-order differs 
640       from network-byte-order. On systems where this is not the case, this method does
641       nothing.</para>
642         </remarks>
643       </Docs>
644       <Excluded>0</Excluded>
645       <AssemblyInfo>
646         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
647         <AssemblyVersion>2.0.0.0</AssemblyVersion>
648       </AssemblyInfo>
649     </Member>
650     <Member MemberName="NetworkToHostOrder">
651       <MemberSignature Language="ILASM" Value=".method public hidebysig static int32 NetworkToHostOrder(int32 network)" />
652       <MemberSignature Language="C#" Value="public static int NetworkToHostOrder (int network);" />
653       <MemberType>Method</MemberType>
654       <ReturnValue>
655         <ReturnType>System.Int32</ReturnType>
656       </ReturnValue>
657       <Parameters>
658         <Parameter Name="network" Type="System.Int32" />
659       </Parameters>
660       <Docs>
661         <param name="network">A <see cref="T:System.Int32" /> in network-byte-order.</param>
662         <summary>
663           <para>Converts a <see cref="T:System.Int32" qualify="true" /> from network-byte-order to host-byte-order.</para>
664         </summary>
665         <returns>
666           <para>A <see cref="T:System.Int32" /> in host-byte-order.</para>
667         </returns>
668         <remarks>
669           <para>This method performs conversions on systems where the host-byte-order differs 
670       from network-byte-order. On systems where this is not the case, this method does
671       nothing.</para>
672         </remarks>
673       </Docs>
674       <Excluded>0</Excluded>
675       <AssemblyInfo>
676         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
677         <AssemblyVersion>2.0.0.0</AssemblyVersion>
678       </AssemblyInfo>
679     </Member>
680     <Member MemberName="NetworkToHostOrder">
681       <MemberSignature Language="ILASM" Value=".method public hidebysig static int64 NetworkToHostOrder(int64 network)" />
682       <MemberSignature Language="C#" Value="public static long NetworkToHostOrder (long network);" />
683       <MemberType>Method</MemberType>
684       <ReturnValue>
685         <ReturnType>System.Int64</ReturnType>
686       </ReturnValue>
687       <Parameters>
688         <Parameter Name="network" Type="System.Int64" />
689       </Parameters>
690       <Docs>
691         <param name="network">A <see cref="T:System.Int64" /> in network-byte-order.</param>
692         <summary>
693           <para>Converts a <see cref="T:System.Int64" qualify="true" /> from network-byte-order to host-byte-order.</para>
694         </summary>
695         <returns>
696           <para>A <see cref="T:System.Int64" /> in host-byte-order.</para>
697         </returns>
698         <remarks>
699           <para>This method performs conversions on systems where the host-byte-order differs 
700       from network-byte-order. On systems where this is not the case, this method does
701       nothing.</para>
702         </remarks>
703       </Docs>
704       <Excluded>0</Excluded>
705       <AssemblyInfo>
706         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
707         <AssemblyVersion>2.0.0.0</AssemblyVersion>
708       </AssemblyInfo>
709     </Member>
710     <Member MemberName="None">
711       <MemberSignature Language="ILASM" Value=".field public static initOnly class System.Net.IPAddress None" />
712       <MemberSignature Language="C#" Value="public static readonly System.Net.IPAddress None;" />
713       <MemberType>Field</MemberType>
714       <ReturnValue>
715         <ReturnType>System.Net.IPAddress</ReturnType>
716       </ReturnValue>
717       <Parameters />
718       <Docs>
719         <summary>
720           <para> Provides the IP address that indicates
721       that no network interface should be used.</para>
722         </summary>
723         <remarks>
724           <para>This field is read-only.</para>
725           <para> This is equivalent to <see cref="!:System.Net.IPAddress.IPAddress" /> (0x00000000FFFFFFFF) and represents the address 255.255.255.255.</para>
726           <block subset="none" type="note">
727             <para>Multiple fields are defined for this IP address based on prior
728       art. This field is identical to <see cref="F:System.Net.IPAddress.Broadcast" />.</para>
729           </block>
730         </remarks>
731       </Docs>
732       <Excluded>0</Excluded>
733       <AssemblyInfo>
734         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
735         <AssemblyVersion>2.0.0.0</AssemblyVersion>
736       </AssemblyInfo>
737     </Member>
738     <Member MemberName="Parse">
739       <MemberSignature Language="ILASM" Value=".method public hidebysig static class System.Net.IPAddress Parse(string ipString)" />
740       <MemberSignature Language="C#" Value="public static System.Net.IPAddress Parse (string ipString);" />
741       <MemberType>Method</MemberType>
742       <ReturnValue>
743         <ReturnType>System.Net.IPAddress</ReturnType>
744       </ReturnValue>
745       <Parameters>
746         <Parameter Name="ipString" Type="System.String" />
747       </Parameters>
748       <Docs>
749         <param name="ipString">A <see cref="T:System.String" /> in dotted-quad notation containing the IP address to convert.</param>
750         <summary>
751           <para> Converts a <see cref="T:System.String" /> representation of an IP address in dotted-quad notation, to a <see cref="T:System.Net.IPAddress" /> instance.</para>
752         </summary>
753         <returns>
754           <para>A new <see cref="T:System.Net.IPAddress" /> instance that represents the address specified in <paramref name="ipString" />.</para>
755         </returns>
756         <remarks>
757           <block subset="none" type="note">
758             <para>An example of a string in dotted-quad notation is "127.0.0.1".</para>
759           </block>
760         </remarks>
761         <exception cref="T:System.ArgumentNullException">
762           <paramref name="ipString " />is <see langword="null" />.</exception>
763         <exception cref="T:System.FormatException">
764           <paramref name="ipString " />is not a valid IP address.</exception>
765       </Docs>
766       <Excluded>0</Excluded>
767       <AssemblyInfo>
768         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
769         <AssemblyVersion>2.0.0.0</AssemblyVersion>
770       </AssemblyInfo>
771     </Member>
772     <Member MemberName="ScopeId">
773       <MemberSignature Language="C#" Value="public long ScopeId { set; get; }" />
774       <MemberType>Property</MemberType>
775       <ReturnValue>
776         <ReturnType>System.Int64</ReturnType>
777       </ReturnValue>
778       <Docs>
779         <summary>To be added.</summary>
780         <value>To be added.</value>
781         <remarks>To be added.</remarks>
782       </Docs>
783       <AssemblyInfo>
784         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
785         <AssemblyVersion>2.0.0.0</AssemblyVersion>
786       </AssemblyInfo>
787     </Member>
788     <Member MemberName="ToString">
789       <MemberSignature Language="ILASM" Value=".method public hidebysig virtual string ToString()" />
790       <MemberSignature Language="C#" Value="public override string ToString ();" />
791       <MemberType>Method</MemberType>
792       <ReturnValue>
793         <ReturnType>System.String</ReturnType>
794       </ReturnValue>
795       <Parameters />
796       <Docs>
797         <summary>
798           <para> Returns a <see cref="T:System.String" /> representation of the value of the current instance.</para>
799         </summary>
800         <returns>
801           <para>A <see cref="T:System.String" /> representation of 
802    the current instance. The returned string is an IP address expressed in dotted-quad notation (for example, "192.168.1.2").</para>
803         </returns>
804         <remarks>
805           <block subset="none" type="note">
806             <para>The <see cref="M:System.Net.IPAddress.ToString" /> method converts the IP address stored in the <see cref="P:System.Net.IPAddress.Address" /> property of the current instance to
807       a <see cref="T:System.String" qualify="true" />
808       containing
809       
810       the address in dotted-quad notation (for example, "192.168.1.2"). </para>
811             <para>This method overrides <see cref="M:System.Object.ToString" qualify="true" />.</para>
812           </block>
813         </remarks>
814       </Docs>
815       <Excluded>0</Excluded>
816       <AssemblyInfo>
817         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
818         <AssemblyVersion>2.0.0.0</AssemblyVersion>
819       </AssemblyInfo>
820     </Member>
821     <Member MemberName="TryParse">
822       <MemberSignature Language="C#" Value="public static bool TryParse (string ipString, out System.Net.IPAddress address);" />
823       <MemberType>Method</MemberType>
824       <AssemblyInfo>
825         <AssemblyVersion>2.0.0.0</AssemblyVersion>
826       </AssemblyInfo>
827       <ReturnValue>
828         <ReturnType>System.Boolean</ReturnType>
829       </ReturnValue>
830       <Parameters>
831         <Parameter Name="ipString" Type="System.String" />
832         <Parameter Name="address" Type="System.Net.IPAddress&amp;" RefType="out" />
833       </Parameters>
834       <Docs>
835         <param name="ipString">To be added.</param>
836         <param name="address">To be added.</param>
837         <summary>To be added.</summary>
838         <returns>To be added.</returns>
839         <remarks>To be added.</remarks>
840       </Docs>
841     </Member>
842   </Members>
843   <TypeExcluded>0</TypeExcluded>
844 </Type>