You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
<paramname="path">The path to retrieve the directory information from.</param>
714
714
<summary>Returns the directory information for the specified path represented by a character span.</summary>
715
715
<returns>Directory information for <paramrefname="path" />, or an empty span if <paramrefname="path" /> is <seelangword="null" />, an empty span, or a root (such as \, C:, or \\server\share).</returns>
716
-
<remarks>To be added.</remarks>
716
+
<remarks>
717
+
<formattype="text/markdown"><![CDATA[
718
+
719
+
## Remarks
720
+
721
+
Unlike the string overload, this method doesn't normalize directory separators.
722
+
723
+
]]></format>
724
+
</remarks>
717
725
<relatedtype="Article"href="~/docs/standard/io/file-path-formats.md">File path formats on Windows systems</related>
718
726
</Docs>
719
727
</Member>
@@ -1393,7 +1401,15 @@ The following example defines a variable, `basePath`, to represent an applicatio
1393
1401
<paramname="path">The path from which to obtain root directory information.</param>
1394
1402
<summary>Gets the root directory information from the path contained in the specified character span.</summary>
1395
1403
<returns>A character span containing the root directory of `path`.</returns>
1396
-
<remarks>To be added.</remarks>
1404
+
<remarks>
1405
+
<formattype="text/markdown"><![CDATA[
1406
+
1407
+
## Remarks
1408
+
1409
+
Unlike the string overload, this method doesn't normalize directory separators.
1410
+
1411
+
]]></format>
1412
+
</remarks>
1397
1413
<relatedtype="article"href="~/docs/standard/io/file-path-formats.md">File path formats on Windows systems</related>
1398
1414
</Docs>
1399
1415
</Member>
@@ -1983,7 +1999,15 @@ There is a difference between a fully qualified path (as indicated by the `IsPat
1983
1999
<summary>Returns a value that indicates whether the specified file path is fixed to a specific drive or UNC path.</summary>
1984
2000
<returns>
1985
2001
<seelangword="true" /> if the path is fixed to a specific drive or UNC path; <seelangword="false" /> if the path is relative to the current drive or working directory.</returns>
1986
-
<remarks>To be added.</remarks>
2002
+
<remarks>
2003
+
<formattype="text/markdown"><![CDATA[
2004
+
2005
+
## Remarks
2006
+
2007
+
This method handles paths that use the alternate directory separator. It's a frequent mistake to assume that rooted paths (<xref:System.IO.Path.IsPathRooted(System.String)>) aren't relative. For example, "C:a" is drive relative, that is, it's resolved against the current directory for C: (rooted, but relative). "C:\a" is rooted and not relative, that is, the current directory isn't used to modify the path.
2008
+
2009
+
]]></format>
2010
+
</remarks>
1987
2011
<exceptioncref="T:System.ArgumentNullException">
1988
2012
<paramrefname="path" /> is <seelangword="null" />.</exception>
1989
2013
<relatedtype="article"href="~/docs/standard/io/file-path-formats.md">File path formats on Windows systems</related>
@@ -2580,8 +2604,8 @@ Not all invalid characters for directory and file names are interpreted as unacc
2580
2604
</Parameters>
2581
2605
<Docs>
2582
2606
<paramname="path">To be added.</param>
2583
-
<summary>To be added.</summary>
2584
-
<returns>To be added.</returns>
2607
+
<summary>Trims one trailing directory separator beyond the root of the specified path.</summary>
2608
+
<returns>The <paramrefname="path" /> without any trailing directory separators.</returns>
2585
2609
<remarks>To be added.</remarks>
2586
2610
</Docs>
2587
2611
</Member>
@@ -2611,8 +2635,8 @@ Not all invalid characters for directory and file names are interpreted as unacc
2611
2635
</Parameters>
2612
2636
<Docs>
2613
2637
<paramname="path">To be added.</param>
2614
-
<summary>To be added.</summary>
2615
-
<returns>To be added.</returns>
2638
+
<summary>Trims one trailing directory separator beyond the root of the specified path.</summary>
2639
+
<returns>The <paramrefname="path" /> without any trailing directory separators.</returns>
2616
2640
<remarks>To be added.</remarks>
2617
2641
</Docs>
2618
2642
</Member>
@@ -2785,4 +2809,4 @@ The destination character span must be large enough to hold the concatenated pat
Copy file name to clipboardExpand all lines: xml/System.IO/TextWriter.xml
+9-1Lines changed: 9 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -2445,7 +2445,15 @@ This method is equivalent to `Write(stringBuilder.ToString())`, but it uses the
2445
2445
<paramname="cancellationToken">The token to monitor for cancellation requests. The default value is <seecref="P:System.Threading.CancellationToken.None" />.</param>
2446
2446
<summary>Asynchronously writes a string builder to the text stream.</summary>
2447
2447
<returns>A task that represents the asynchronous write operation.</returns>
2448
-
<remarks>To be added.</remarks>
2448
+
<remarks>
2449
+
<formattype="text/markdown"><![CDATA[
2450
+
2451
+
## Remarks
2452
+
2453
+
This method is equivalent to calling `WriteAsync(stringBuilder.ToString())`, however, it uses the <xref:System.Text.StringBuilder.GetChunks?displayProperty=nameWithType> method to avoid creating the intermediate string.
Copy file name to clipboardExpand all lines: xml/System.IO/UnmanagedMemoryStream.xml
+16-9Lines changed: 16 additions & 9 deletions
Original file line number
Diff line number
Diff line change
@@ -711,9 +711,7 @@
711
711
</Parameters>
712
712
<Docs>
713
713
<paramname="cancellationToken">The token to monitor for cancellation requests. The default value is <seecref="P:System.Threading.CancellationToken.None" />.</param>
714
-
<summary>Overrides the <seecref="M:System.IO.Stream.FlushAsync(System.Threading.CancellationToken)" /> method so that the operation is cancelled if specified, but no other action is performed.
715
-
716
-
Available starting in .NET Framework 4.6</summary>
714
+
<summary>Overrides the <seecref="M:System.IO.Stream.FlushAsync(System.Threading.CancellationToken)" /> method so that the operation is cancelled if specified, but no other action is performed.</summary>
717
715
<returns>A task that represents the asynchronous flush operation.</returns>
718
716
<remarks>
719
717
<formattype="text/markdown"><![CDATA[
@@ -786,12 +784,13 @@
786
784
<paramname="access">One of the <seecref="T:System.IO.FileAccess" /> values.</param>
787
785
<summary>Initializes a new instance of the <seecref="T:System.IO.UnmanagedMemoryStream" /> class by using a pointer to an unmanaged memory location.</summary>
788
786
<remarks>
789
-
<formattype="text/markdown"><![CDATA[
790
-
787
+
<formattype="text/markdown"><![CDATA[
788
+
791
789
## Remarks
792
-
This method is equivalent to the <xref:System.IO.UnmanagedMemoryStream.%23ctor%2A> constructor. It supports methods that need to initialize the pointer before setting stream variables and, therefore, cannot call the parameterized constructor. Such methods should use the parameterless constructor, <xref:System.IO.UnmanagedMemoryStream.%23ctor>, initialize the pointer, and then invoke the <xref:System.IO.UnmanagedMemoryStream.Initialize%2A> method.
793
-
794
-
]]></format>
790
+
791
+
This method is equivalent to the <xref:System.IO.UnmanagedMemoryStream.%23ctor%2A> constructor. It supports methods that need to initialize the pointer before setting stream variables and, therefore, cannot call the parameterized constructor. Such methods should use the parameterless constructor, <xref:System.IO.UnmanagedMemoryStream.%23ctor>, initialize the pointer, and then invoke the <xref:System.IO.UnmanagedMemoryStream.Initialize%2A> method.
792
+
793
+
]]></format>
795
794
</remarks>
796
795
<exceptioncref="T:System.Security.SecurityException">The user does not have the required permission.</exception>
797
796
<exceptioncref="T:System.ArgumentNullException">The <paramrefname="pointer" /> value is <seelangword="null" />.</exception>
@@ -1576,7 +1575,15 @@
1576
1575
<paramname="cancellationToken">The token to monitor for cancellation requests. The default value is <seecref="P:System.Threading.CancellationToken.None" />.</param>
1577
1576
<summary>Asynchronously writes a span of bytes to the current stream, advances the current position within this stream by the number of bytes written, and monitors cancellation requests.</summary>
1578
1577
<returns>A task that represents the asynchronous write operation.</returns>
1579
-
<remarks>To be added.</remarks>
1578
+
<remarks>
1579
+
<formattype="text/markdown"><![CDATA[
1580
+
1581
+
## Remarks
1582
+
1583
+
If an exception occurs during the write operation, it will be set as the <xref:System.Threading.Tasks.Task.Exception%2A?displayProperty=nameWithType> of the property of the returned task.
0 commit comments