|
196 | 196 | <Parameter Name="address" Type="System.ReadOnlySpan<System.Byte>" Index="0" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
|
197 | 197 | </Parameters>
|
198 | 198 | <Docs>
|
199 |
| - <param name="address">To be added.</param> |
200 |
| - <summary>To be added.</summary> |
201 |
| - <remarks>To be added.</remarks> |
| 199 | + <param name="address">The byte representation of the IP address, in network byte order, with the most significant byte first in index position 0.</param> |
| 200 | + <summary>Initializes a new instance of the <see cref="T:System.Net.IPAddress" /> class with the address specified as a byte span.</summary> |
| 201 | + <remarks> |
| 202 | + <format type="text/markdown"><![CDATA[ |
| 203 | + |
| 204 | +## Remarks |
| 205 | + The <xref:System.Net.IPAddress> is created with the <xref:System.Net.IPAddress.Address> property set to `address`. |
| 206 | + |
| 207 | + If the length of `address` is 4, this method constructs an IPv4 address; otherwise, an IPv6 address with a scope of 0 is constructed. |
| 208 | + |
| 209 | + ]]></format> |
| 210 | + </remarks> |
| 211 | + <exception cref="T:System.ArgumentException"> |
| 212 | + <paramref name="address" /> contains a bad IP address.</exception> |
202 | 213 | </Docs>
|
203 | 214 | </Member>
|
204 | 215 | <Member MemberName=".ctor">
|
|
285 | 296 | <Parameter Name="scopeid" Type="System.Int64" Index="1" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
|
286 | 297 | </Parameters>
|
287 | 298 | <Docs>
|
288 |
| - <param name="address">To be added.</param> |
289 |
| - <param name="scopeid">To be added.</param> |
290 |
| - <summary>To be added.</summary> |
291 |
| - <remarks>To be added.</remarks> |
| 299 | + <param name="address">The byte span value of the IP address.</param> |
| 300 | + <param name="scopeid">The long value of the scope identifier.</param> |
| 301 | + <summary>Initializes a new instance of the <see cref="T:System.Net.IPAddress" /> class with the address specified as a byte span and the specified scope identifier.</summary> |
| 302 | + <remarks> |
| 303 | + <format type="text/markdown"><![CDATA[ |
| 304 | + |
| 305 | +## Remarks |
| 306 | + This constructor instantiates an IPv6 address. The `scopeid` identifies a network interface in the case of a link-local address. The scope is valid only for link-local and site-local addresses. |
| 307 | + |
| 308 | + The byte span is assumed to be in network byte order with the most significant byte first in index position 0. |
| 309 | + |
| 310 | + ]]></format> |
| 311 | + </remarks> |
| 312 | + <exception cref="T:System.ArgumentException"> |
| 313 | + <paramref name="address" /> contains a bad IP address.</exception> |
| 314 | + <exception cref="T:System.ArgumentOutOfRangeException"> |
| 315 | + <paramref name="scopeid" /> < 0 |
| 316 | + |
| 317 | +-or- |
| 318 | + |
| 319 | +<paramref name="scopeid" /> > 0x00000000FFFFFFFF</exception> |
292 | 320 | </Docs>
|
293 | 321 | </Member>
|
294 | 322 | <Member MemberName="Address">
|
|
1686 | 1714 | <Parameter Name="ipString" Type="System.ReadOnlySpan<System.Char>" Index="0" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
|
1687 | 1715 | </Parameters>
|
1688 | 1716 | <Docs>
|
1689 |
| - <param name="ipString">To be added.</param> |
1690 |
| - <summary>To be added.</summary> |
1691 |
| - <returns>To be added.</returns> |
| 1717 | + <param name="ipString">A character span that contains an IP address in dotted-quad notation for IPv4 and in colon-hexadecimal notation for IPv6.</param> |
| 1718 | + <summary>Converts an IP address represented as a character span to an <see cref="T:System.Net.IPAddress" /> instance.</summary> |
| 1719 | + <returns>The converted IP address.</returns> |
1692 | 1720 | <remarks>To be added.</remarks>
|
| 1721 | + <exception cref="T:System.FormatException"> |
| 1722 | + <paramref name="ipString" /> is not a valid IP address.</exception> |
1693 | 1723 | </Docs>
|
1694 | 1724 | </Member>
|
1695 | 1725 | <Member MemberName="Parse">
|
|
1917 | 1947 | <Parameter Name="charsWritten" Type="System.Int32" RefType="out" Index="1" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
|
1918 | 1948 | </Parameters>
|
1919 | 1949 | <Docs>
|
1920 |
| - <param name="destination">To be added.</param> |
1921 |
| - <param name="charsWritten">To be added.</param> |
1922 |
| - <summary>To be added.</summary> |
1923 |
| - <returns>To be added.</returns> |
| 1950 | + <param name="destination">When this method returns, the IP address as a span of characters.</param> |
| 1951 | + <param name="charsWritten">When this method returns, the number of characters written into the span.</param> |
| 1952 | + <summary>Tries to format the current IP address into the provided span.</summary> |
| 1953 | + <returns><see langword="true" /> if the formatting was successful; otherwise, <see langword="false" />.</returns> |
1924 | 1954 | <remarks>To be added.</remarks>
|
1925 | 1955 | </Docs>
|
1926 | 1956 | </Member>
|
|
1954 | 1984 | <Parameter Name="address" Type="System.Net.IPAddress" RefType="out" Index="1" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
|
1955 | 1985 | </Parameters>
|
1956 | 1986 | <Docs>
|
1957 |
| - <param name="ipString">To be added.</param> |
1958 |
| - <param name="address">To be added.</param> |
1959 |
| - <summary>To be added.</summary> |
1960 |
| - <returns>To be added.</returns> |
| 1987 | + <param name="ipString">The byte span to validate.</param> |
| 1988 | + <param name="address">When this method returns, the <see cref="T:System.Net.IPAddress" /> version of the byte span.</param> |
| 1989 | + <summary>Determines whether the specified byte span represents a valid IP address.</summary> |
| 1990 | + <returns><see langword="true" /> if <paramref name="ipString" /> was able to be parsed as an IP address; otherwise, <see langword="false" />.</returns> |
1961 | 1991 | <remarks>To be added.</remarks>
|
1962 | 1992 | </Docs>
|
1963 | 1993 | </Member>
|
|
2044 | 2074 | <Parameter Name="bytesWritten" Type="System.Int32" RefType="out" Index="1" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
|
2045 | 2075 | </Parameters>
|
2046 | 2076 | <Docs>
|
2047 |
| - <param name="destination">To be added.</param> |
2048 |
| - <param name="bytesWritten">To be added.</param> |
2049 |
| - <summary>To be added.</summary> |
2050 |
| - <returns>To be added.</returns> |
| 2077 | + <param name="destination">When this method returns, the IP address as a span of bytes.</param> |
| 2078 | + <param name="bytesWritten">When this method returns, the number of bytes written into the span.</param> |
| 2079 | + <summary>Tries to write the current IP address into a span of bytes.</summary> |
| 2080 | + <returns> |
| 2081 | + <see langword="true" /> if the IP address is sucessfully written to the given span; otherwise, <see langword="false" />.</returns> |
2051 | 2082 | <remarks>To be added.</remarks>
|
2052 | 2083 | </Docs>
|
2053 | 2084 | </Member>
|
|
0 commit comments