Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 14 additions & 14 deletions xml/System.Buffers.Text/Base64.xml
Original file line number Diff line number Diff line change
Expand Up @@ -281,16 +281,16 @@
<summary>Decodes the span of UTF-8 encoded text represented as base 64 into binary data. If the input is not a multiple of 4, it will decode as much as it can, to the closest multiple of 4.</summary>
<returns>One of the enumeration values that indicates the status of the decoding operation.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
<format type="text/markdown"><![CDATA[

## Remarks

The return value can be as follows:

- <xref:System.Buffers.OperationStatus.Done?displayProperty=nameWithType>: Processing of the entire input span succeeded.
- <xref:System.Buffers.OperationStatus.DestinationTooSmall?displayProperty=nameWithType>: There is not enough space in the output span to write the decoded input.
- <xref:System.Buffers.OperationStatus.NeedMoreData?displayProperty=nameWithType>: `isFinalBlock` is `false` and the input is not a multiple of 4. Otherwise, the partial input is considered <xref:System.Buffers.OperationStatus.InvalidData>.
- <xref:System.Buffers.OperationStatus.InvalidData?displayProperty=nameWithType>: The input contains bytes outside of the expected base 64 range, or is incomplete (that is, not a multiple of 4) and `isFinalBlock` is `true`. In .NET 7 and earlier versions, this value can also indicate that the input has invalid or more than two padding characters.
- <xref:System.Buffers.OperationStatus.InvalidData?displayProperty=nameWithType>: The input contains bytes outside of the expected base 64 range, or is incomplete (that is, not a multiple of 4) and `isFinalBlock` is `true`.

]]></format>
</remarks>
Expand Down Expand Up @@ -340,14 +340,14 @@ The return value can be as follows:
<summary>Decodes the span of UTF-8 encoded text in base 64 (in-place) into binary data. The decoded binary output is smaller than the text data contained in the input (the operation deflates the data). If the input is not a multiple of 4, the method will not decode any data.</summary>
<returns>One of the enumeration values that indicates the status of the decoding operation.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
<format type="text/markdown"><![CDATA[

## Remarks

The return value can be as follows:

- <xref:System.Buffers.OperationStatus.Done?displayProperty=nameWithType>: Processing of the entire input span succeeded.
- <xref:System.Buffers.OperationStatus.InvalidData?displayProperty=nameWithType>: The input contains bytes outside of the expected base 64 range or is incomplete (that is, not a multiple of 4). In .NET 7 and earlier versions, this value can also indicate that the input has invalid or more than two padding characters.
- <xref:System.Buffers.OperationStatus.InvalidData?displayProperty=nameWithType>: The input contains bytes outside of the expected base 64 range or is incomplete (that is, not a multiple of 4).

This method cannot return the <xref:System.Buffers.OperationStatus.DestinationTooSmall?displayProperty=nameWithType> and <xref:System.Buffers.OperationStatus.NeedMoreData?displayProperty=nameWithType> values.

Expand Down Expand Up @@ -620,9 +620,9 @@ This method cannot return the <xref:System.Buffers.OperationStatus.DestinationTo
<summary>Encodes the span of binary data into UTF-8 encoded text represented as base 64.</summary>
<returns>One of the enumeration values that indicates the status of the encoding operation.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
<format type="text/markdown"><![CDATA[

## Remarks

The return value can be as follows:

Expand Down Expand Up @@ -682,9 +682,9 @@ This method cannot return <xref:System.Buffers.OperationStatus.InvalidData?displ
<summary>Encodes the span of binary data (in-place) into UTF-8 encoded text represented as base 64. The encoded text output is larger than the binary data contained in the input (the operation inflates the data).</summary>
<returns>One of the enumeration values that indicates the status of the encoding operation.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
<format type="text/markdown"><![CDATA[

## Remarks

The return value can be as follows:

Expand Down
4 changes: 2 additions & 2 deletions xml/System.Collections.Generic/Dictionary`2.xml
Original file line number Diff line number Diff line change
Expand Up @@ -1004,7 +1004,7 @@

This method is an O(`n`) operation, where `n` is the capacity of the dictionary.

.NET Core 3.0+ only: this mutating method may be safely called without invalidating active enumerators on the <xref:System.Collections.Generic.Dictionary%602> instance. This does not imply thread safety.
.NET Core 3.0+ only: This mutating method can be safely called without invalidating active enumerators on the <xref:System.Collections.Generic.Dictionary%602> instance. This does not imply thread safety.

]]></format>
</remarks>
Expand Down Expand Up @@ -1782,7 +1782,7 @@

This method approaches an O(1) operation.

.NET Core 3.0+ only: this mutating method may be safely called without invalidating active enumerators on the <xref:System.Collections.Generic.Dictionary%602> instance. This does not imply thread safety.
.NET Core 3.0+ only: This mutating method can be safely called without invalidating active enumerators on the <xref:System.Collections.Generic.Dictionary%602> instance. This does not imply thread safety.

## Examples
The following code example shows how to remove a key/value pair from a dictionary using the <xref:System.Collections.Generic.Dictionary%602.Remove%2A> method.
Expand Down
4 changes: 2 additions & 2 deletions xml/System.Diagnostics/Activity.xml
Original file line number Diff line number Diff line change
Expand Up @@ -590,7 +590,7 @@ This key/value pair is included in the collection returned by the <xref:System.D

The `Activity` instance tries to use the same format for IDs as its parent. If the activity has no parent, this property determines the default format to use.

In .NET 5 and later versions, the default format is <xref:System.Diagnostics.ActivityIdFormat.W3C?displayProperty=nameWithType>. In previous versions, the default format is <xref:System.Diagnostics.ActivityIdFormat.Hierarchical?displayProperty=nameWithType>.
The default format is <xref:System.Diagnostics.ActivityIdFormat.W3C?displayProperty=nameWithType>.

]]></format>
</remarks>
Expand Down Expand Up @@ -2170,7 +2170,7 @@ Call <xref:System.Diagnostics.DiagnosticSource.StopActivity%2A?displayProperty=n
<Docs>
<summary>Gets a collection of key/value pairs that represent information that will be logged along with the <see cref="T:System.Diagnostics.Activity" /> to the logging system.</summary>
<value>Information that will be logged along with the <see cref="T:System.Diagnostics.Activity" /> to the logging system.</value>
<remarks>In .NET 5 and later versions, the order of the tags in the list matches the order in which they're added to the list. In previous versions, the order is reversed, that is, the first item added is last in the list.</remarks>
<remarks>The order of the tags in the list matches the order in which they're added to the list.</remarks>
<seealso cref="P:System.Diagnostics.Activity.Baggage" />
</Docs>
</Member>
Expand Down
2 changes: 1 addition & 1 deletion xml/System.Diagnostics/Process.xml
Original file line number Diff line number Diff line change
Expand Up @@ -2493,7 +2493,7 @@ You cannot cause processes on remote computers to exit. You can only view inform

The process is terminating.</exception>
<exception cref="T:System.NotSupportedException">You are attempting to call <see cref="M:System.Diagnostics.Process.Kill" /> for a process that is running on a remote computer. The method is available only for processes running on the local computer.</exception>
<exception cref="T:System.InvalidOperationException">.NET Framework and .NET Core 3.0 and earlier versions only: The process has already exited.
<exception cref="T:System.InvalidOperationException">.NET Framework only: The process has already exited.

-or-

Expand Down
2 changes: 1 addition & 1 deletion xml/System.Diagnostics/ProcessStartInfo.xml
Original file line number Diff line number Diff line change
Expand Up @@ -448,7 +448,7 @@ The length of the string assigned to the `Arguments` property must be less than
Arguments are parsed and interpreted by the target application, so must align with the expectations of that application. For .NET applications as demonstrated in the Examples below, spaces are interpreted as a separator between multiple arguments. A single argument that includes spaces must be surrounded by quotation marks, but those quotation marks are not carried through to the target application. To include quotation marks in the final parsed argument, triple-escape each mark.
If you use this property to set command-line arguments, <xref:System.Diagnostics.ProcessStartInfo.ArgumentList> must not contain any elements.

`Arguments` and <xref:System.Diagnostics.ProcessStartInfo.ArgumentList>, which is supported starting with .NET Core 2.1 and .NET Standard 2.1, are independent of one another. That is, the string assigned to the `Arguments` property does not populate the <xref:System.Diagnostics.ProcessStartInfo.ArgumentList> collection, and the members of the <xref:System.Diagnostics.ProcessStartInfo.ArgumentList> collection are not assigned to the `Arguments` property.
`Arguments` and <xref:System.Diagnostics.ProcessStartInfo.ArgumentList> are independent of one another. That is, the string assigned to the `Arguments` property does not populate the <xref:System.Diagnostics.ProcessStartInfo.ArgumentList> collection, and the members of the <xref:System.Diagnostics.ProcessStartInfo.ArgumentList> collection are not assigned to the `Arguments` property.

[!INCLUDE [untrusted-data-instance-note](~/includes/untrusted-data-instance-note.md)]

Expand Down
2 changes: 1 addition & 1 deletion xml/System.Globalization/NumberFormatInfo.xml
Original file line number Diff line number Diff line change
Expand Up @@ -612,7 +612,7 @@ On Windows, the initial value of this property is derived from the settings in t

]]></format>
</remarks>
<exception cref="T:System.ArgumentOutOfRangeException">The property is set to a value that's less than 0 or greater than 16. On .NET Core 3.1 and earlier versions, this exception is thrown if the value is greater than 15.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The property is set to a value that's less than 0 or greater than 16. On .NET Framework, this exception is thrown if the value is greater than 15.</exception>
<exception cref="T:System.InvalidOperationException">The property is being set and the <see cref="T:System.Globalization.NumberFormatInfo" /> object is read-only.</exception>
<altmember cref="P:System.Globalization.NumberFormatInfo.CurrencyDecimalDigits" />
<altmember cref="P:System.Globalization.NumberFormatInfo.CurrencyDecimalSeparator" />
Expand Down
2 changes: 1 addition & 1 deletion xml/System.IO/Directory.xml
Original file line number Diff line number Diff line change
Expand Up @@ -4314,7 +4314,7 @@ Trailing spaces are removed from the end of the path parameters before moving th
For a list of common I/O tasks, see [Common I/O Tasks](/dotnet/standard/io/common-i-o-tasks).

> [!NOTE]
> Starting with .NET Core 3.0, the `Move` method throws an <xref:System.IO.IOException> in all platforms when the `destDirName` already exists. In .NET Core 2.2 and previous versions, the exception was only thrown on Windows, and other platforms could either fail or overwrite the `destDirName`. See [C++ rename](https://linux.die.net/man/2/rename).
> Starting with .NET Core 3.0, the `Move` method throws an <xref:System.IO.IOException> in all platforms when the `destDirName` already exists. See [C++ rename](https://linux.die.net/man/2/rename).

## Examples

Expand Down
2 changes: 1 addition & 1 deletion xml/System.IO/File.xml
Original file line number Diff line number Diff line change
Expand Up @@ -3735,7 +3735,7 @@ This method works across disk volumes, and it does not throw an exception if the

Note that if you attempt to replace a file by moving a file of the same name into that directory, an <xref:System.IO.IOException> is thrown. To avoid this problem:

- In .NET Core 3.0 and later versions, you can call <xref:System.IO.File.Move(System.String,System.String,System.Boolean)> setting the parameter `overwrite` to `true`, which will replace the file if it exists.
- In .NET Core 3.0 and later versions, you can call <xref:System.IO.File.Move(System.String,System.String,System.Boolean)> setting the parameter `overwrite` to `true`, which replaces the file if it exists.

- In all .NET versions, you can call <xref:System.IO.File.Copy(System.String,System.String,System.Boolean)> to copy with overwrite, then call `Delete` to remove the excess source file. This strategy isn't atomic, because a system or program crash during the `Copy` may leave a partially-written destination file, but it will ensure a (possibly incomplete) file always exists at the destination.

Expand Down
2 changes: 1 addition & 1 deletion xml/System.IO/FileStream.xml
Original file line number Diff line number Diff line change
Expand Up @@ -1710,7 +1710,7 @@ The file was too large (when <see cref="P:System.IO.FileStreamOptions.Preallocat
For a list of common file and directory operations, see [Common I/O Tasks](/dotnet/standard/io/common-i-o-tasks).

> [!IMPORTANT]
> This constructor does not exist in .NET Core. Instead, starting in .NET Core 3.1, you can use the following extension method of the `FileSystemAclExtensions` class inside the `System.Security.AccessControl` assembly: <xref:System.IO.FileSystemAclExtensions.Create(System.IO.FileInfo,System.IO.FileMode,System.Security.AccessControl.FileSystemRights,System.IO.FileShare,System.Int32,System.IO.FileOptions,System.Security.AccessControl.FileSecurity)>.
> This constructor only exists in .NET Framework. In .NET, you can use the <xref:System.IO.FileSystemAclExtensions.Create(System.IO.FileInfo,System.IO.FileMode,System.Security.AccessControl.FileSystemRights,System.IO.FileShare,System.Int32,System.IO.FileOptions,System.Security.AccessControl.FileSecurity)> extension method instead.

## Examples
The following example writes data to a file and then reads the data using the <xref:System.IO.FileStream> object.
Expand Down
14 changes: 7 additions & 7 deletions xml/System.IO/Path.xml
Original file line number Diff line number Diff line change
Expand Up @@ -82,17 +82,17 @@

A path can contain absolute or relative location information. Absolute paths fully specify a location: the file or directory can be uniquely identified regardless of the current location. Relative paths specify a partial location: the current location is used as the starting point when locating a file specified with a relative path. To determine the current directory, call <xref:System.IO.Directory.GetCurrentDirectory%2A?displayProperty=nameWithType>.

.NET Core 1.1 and later versions and .NET Framework 4.6.2 and later versions also support access to file system objects that are device names, such as "\\\\?\\C:\\".
This type also supports access to file system objects that are device names, such as "\\\\?\\C:\\". Device name support was added in .NET Framework 4.6.2.

For more information on file path formats on Windows, see [File path formats on Windows systems](/dotnet/standard/io/file-path-formats).

Most members of the `Path` class do not interact with the file system and do not verify the existence of the file specified by a path string. `Path` class members that modify a path string, such as <xref:System.IO.Path.ChangeExtension%2A>, have no effect on names of files in the file system.

Some `Path` members do validate the contents of a specified path string, and throw an <xref:System.ArgumentException> if the string contains characters that are not valid in path strings, as defined in the characters returned from the <xref:System.IO.Path.GetInvalidPathChars%2A> method. For example, on Windows-based desktop platforms, invalid path characters might include quote ("), less than (\<), greater than (>), pipe (&#124;), backspace (\\b), null (\\0), and Unicode characters 16 through 18 and 20 through 25. This validation behavior varies between .NET versions:

- On .NET Framework and .NET Core versions older than 2.1: All `Path` members that take a path as an argument throw an <xref:System.ArgumentException> if they detect invalid path characters.
- On .NET Framework: All `Path` members that take a path as an argument throw an <xref:System.ArgumentException> if they detect invalid path characters.

- On .NET Core 2.1 and later versions: <xref:System.IO.Path.GetFullPath%2A> is the only member that throws an <xref:System.ArgumentException> if the string contains invalid path characters.
- On .NET: <xref:System.IO.Path.GetFullPath%2A> is the only member that throws an <xref:System.ArgumentException> if the string contains invalid path characters.

The members of the `Path` class enable you to quickly and easily perform common operations such as determining whether a file name extension is part of a path, and combining two strings into one path name.

Expand Down Expand Up @@ -1815,7 +1815,7 @@ Possible patterns for the read-only character span returned by this method are a

- "\\\\ComputerName\\SharedFolder" (Windows: a UNC path).

- "\\\\?\\C:" (Windows: a DOS device path, supported in .NET Core 1.1 and later versions, and in .NET Framework 4.6.2 and later versions).
- "\\\\?\\C:" (Windows: a DOS device path, supported in .NET versions and in .NET Framework 4.6.2 and later versions).

For more information on file paths on Windows, see [File path formats on Windows systems](/dotnet/standard/io/file-path-formats). For a list of common I/O tasks, see [Common I/O Tasks](/dotnet/standard/io/common-i-o-tasks).

Expand Down Expand Up @@ -1917,7 +1917,7 @@ Possible patterns for the string returned by this method are as follows:

- "\\\\ComputerName\\SharedFolder" (Windows: a UNC path).

- "\\\\?\\C:" (Windows: a DOS device path, supported in .NET Core 1.1 and later versions, and in .NET Framework 4.6.2 and later versions).
- "\\\\?\\C:" (Windows: a DOS device path, supported in .NET versions and in .NET Framework 4.6.2 and later versions).

For more information on file paths on Windows, see [File path formats on Windows systems](/dotnet/standard/io/file-path-formats). For a list of common I/O tasks, see [Common I/O Tasks](/dotnet/standard/io/common-i-o-tasks).

Expand Down Expand Up @@ -2124,7 +2124,7 @@ Paths are resolved by calling the <xref:System.IO.Path.GetFullPath%2A> method be

This method creates a temporary file with a *.tmp* file extension and returns the path to it. The temporary file is created within the user's temporary folder, which is the path returned by the <xref:System.IO.Path.GetTempPath%2A> method.

On .NET 7 and earlier versions, when using this method on Windows, the <xref:System.IO.Path.GetTempFileName%2A> method raises an <xref:System.IO.IOException> if it's used to create more than 65535 files without deleting previous temporary files. This limitation does not exist on operating systems other than Windows. Starting in .NET 8, the limitation does not exist on *any* operating system.
On .NET Framework, the <xref:System.IO.Path.GetTempFileName*> method raises an <xref:System.IO.IOException> if it's used to create more than 65535 files without deleting previous temporary files. This limitation does not exist on operating systems other than Windows. Starting in .NET 8, the limitation does not exist on *any* operating system.

The <xref:System.IO.Path.GetTempFileName%2A> method will raise an <xref:System.IO.IOException> if no unique temporary file name is available. To resolve this error, delete all unneeded temporary files.

Expand Down Expand Up @@ -2218,7 +2218,7 @@ If the `TMPDIR` environment variable has been set, this method returns the value

Otherwise, this method returns `/tmp/`.
The `/tmp/` directory on Linux is commonly shared among all users (`1777` permissions); ensure this meets your application's security needs.

---

## Examples
Expand Down
2 changes: 1 addition & 1 deletion xml/System.Net.Http/HttpClientHandler.xml
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@
</Attribute>
</Attributes>
<Docs>
<summary>The default message handler used by <see cref="T:System.Net.Http.HttpClient" /> in .NET Framework and .NET Core 2.0 and earlier.</summary>
<summary>The default message handler used by <see cref="T:System.Net.Http.HttpClient" /> in .NET Framework.</summary>
<remarks>For more information about this API, see <see href="/dotnet/fundamentals/runtime-libraries/system-net-http-httpclienthandler">Supplemental API remarks for HttpClientHandler</see>.</remarks>
<example>
<format type="text/markdown"><![CDATA[
Expand Down
Loading
Loading