IPAddress.xml 34 KB

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