From a8af08a323bb852406a85251aa423661f2d57247 Mon Sep 17 00:00:00 2001 From: Genevieve Warren <24882762+gewarren@users.noreply.github.com> Date: Fri, 28 Mar 2025 12:33:43 -0700 Subject: [PATCH 1/2] fix that/which grammar --- .../HybridDictionary.xml | 2 +- .../NameObjectCollectionBase.xml | 4 +- .../NameValueCollection.xml | 4 +- xml/System.Collections/ArrayList.xml | 4 +- xml/System.Collections/Hashtable.xml | 12 +- .../MeterListener.xml | 4 +- .../ActivityCreationOptions`1.xml | 2 +- xml/System.Diagnostics/DiagnosticSource.xml | 6 +- .../EventSchemaTraceListener.xml | 558 +++++++++--------- xml/System.Diagnostics/Process.xml | 2 +- xml/System.Diagnostics/Switch.xml | 264 ++++----- xml/System.Formats.Asn1/AsnDecoder.xml | 320 +++++----- xml/System.Formats.Asn1/AsnReader.xml | 316 +++++----- xml/System.Formats.Asn1/AsnWriter.xml | 82 +-- xml/System.IO.Packaging/Package.xml | 2 +- xml/System.IO.Packaging/ZipPackage.xml | 2 +- xml/System.IO/BufferedStream.xml | 2 +- xml/System.IO/DirectoryNotFoundException.xml | 2 +- xml/System.IO/EndOfStreamException.xml | 4 +- xml/System.IO/FileNotFoundException.xml | 2 +- xml/System.IO/IOException.xml | 8 +- xml/System.IO/UnmanagedMemoryStream.xml | 8 +- .../TensorPrimitives.xml | 6 +- xml/System.Numerics/BigInteger.xml | 6 +- xml/System.Numerics/BitOperations.xml | 2 +- xml/System.Numerics/Complex.xml | 8 +- xml/System.Numerics/IAdditionOperators`3.xml | 4 +- xml/System.Numerics/IBinaryInteger`1.xml | 8 +- xml/System.Numerics/IDivisionOperators`3.xml | 8 +- .../IFloatingPointIeee754`1.xml | 10 +- xml/System.Numerics/IModulusOperators`3.xml | 4 +- xml/System.Numerics/IMultiplyOperators`3.xml | 8 +- xml/System.Numerics/INumberBase`1.xml | 14 +- xml/System.Numerics/IPowerFunctions`1.xml | 2 +- xml/System.Numerics/ISignedNumber`1.xml | 2 +- .../ISubtractionOperators`3.xml | 4 +- xml/System.Numerics/Vector.xml | 4 +- xml/System/AggregateException.xml | 2 +- xml/System/Byte.xml | 8 +- xml/System/CharEnumerator.xml | 194 +++--- xml/System/ContextMarshalException.xml | 86 +-- xml/System/DateTime.xml | 8 +- xml/System/Double.xml | 12 +- xml/System/Guid.xml | 2 +- xml/System/Half.xml | 32 +- xml/System/Int128.xml | 40 +- xml/System/Int16.xml | 8 +- xml/System/Int32.xml | 8 +- xml/System/Int64.xml | 8 +- xml/System/IntPtr.xml | 12 +- xml/System/Math.xml | 2 +- xml/System/MathF.xml | 2 +- xml/System/SByte.xml | 8 +- xml/System/Single.xml | 12 +- xml/System/Type.xml | 2 +- xml/System/UInt128.xml | 40 +- xml/System/UInt16.xml | 8 +- xml/System/UInt32.xml | 8 +- xml/System/UInt64.xml | 8 +- xml/System/UIntPtr.xml | 12 +- 60 files changed, 1102 insertions(+), 1120 deletions(-) diff --git a/xml/System.Collections.Specialized/HybridDictionary.xml b/xml/System.Collections.Specialized/HybridDictionary.xml index edf4d65bc99..de9a4c7fcca 100644 --- a/xml/System.Collections.Specialized/HybridDictionary.xml +++ b/xml/System.Collections.Specialized/HybridDictionary.xml @@ -71,7 +71,7 @@ with small collections, and offers the flexibility of switching to a which handles larger collections better than . + This class is recommended for cases where the number of elements in a dictionary is unknown. It takes advantage of the improved performance of a with small collections, and offers the flexibility of switching to a , which handles larger collections better than . If the initial size of the collection is greater than the optimal size for a , the collection is stored in a to avoid the overhead of copying elements from the to a . diff --git a/xml/System.Collections.Specialized/NameObjectCollectionBase.xml b/xml/System.Collections.Specialized/NameObjectCollectionBase.xml index f5c7de10428..7fe655f7f92 100644 --- a/xml/System.Collections.Specialized/NameObjectCollectionBase.xml +++ b/xml/System.Collections.Specialized/NameObjectCollectionBase.xml @@ -94,9 +94,7 @@ `null` is allowed as a key or as a value. > [!CAUTION] -> The method does not distinguish between `null` which is returned because the specified key is not found and `null` which is returned because the value associated with the key is `null`. - - +> The method does not distinguish between `null` that's returned because the specified key is not found and `null` that's returned because the value associated with the key is `null`. ## Examples The following code example shows how to implement and use the class. diff --git a/xml/System.Collections.Specialized/NameValueCollection.xml b/xml/System.Collections.Specialized/NameValueCollection.xml index 440684fe5e9..17d631a0b99 100644 --- a/xml/System.Collections.Specialized/NameValueCollection.xml +++ b/xml/System.Collections.Specialized/NameValueCollection.xml @@ -76,9 +76,7 @@ `null` is allowed as a key or as a value. > [!CAUTION] -> The method does not distinguish between `null` which is returned because the specified key is not found and `null` which is returned because the value associated with the key is `null`. - - +> The method does not distinguish between `null` that's returned because the specified key is not found and `null` that's returned because the value associated with the key is `null`. ## Examples :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR_System/system.Collections.Specialized.NameValueCollection2/CPP/nvc.cpp" id="Snippet1"::: diff --git a/xml/System.Collections/ArrayList.xml b/xml/System.Collections/ArrayList.xml index 33f96f98abd..c30f843970f 100644 --- a/xml/System.Collections/ArrayList.xml +++ b/xml/System.Collections/ArrayList.xml @@ -1911,8 +1911,8 @@ This method is an `O(1)` operation. The zero-based index at which the range starts. The number of elements in the range. - Returns an which represents a subset of the elements in the source . - An which represents a subset of the elements in the source . + Returns an that represents a subset of the elements in the source . + An that represents a subset of the elements in the source . The object to copy to a new object. - A number in the range from 0.1 through 1.0 that is multiplied by the default value which provides the best performance. The result is the maximum ratio of elements to buckets. + A number in the range from 0.1 through 1.0 that is multiplied by the default value that provides the best performance. The result is the maximum ratio of elements to buckets. Initializes a new instance of the class by copying the elements from the specified dictionary to the new object. The new object has an initial capacity equal to the number of elements copied, and uses the specified load factor, and the default hash code provider and comparer. The approximate number of elements that the object can initially contain. - A number in the range from 0.1 through 1.0 that is multiplied by the default value which provides the best performance. The result is the maximum ratio of elements to buckets. + A number in the range from 0.1 through 1.0 that is multiplied by the default value that provides the best performance. The result is the maximum ratio of elements to buckets. Initializes a new, empty instance of the class using the specified initial capacity and load factor, and the default hash code provider and comparer. The object to copy to a new object. - A number in the range from 0.1 through 1.0 that is multiplied by the default value which provides the best performance. The result is the maximum ratio of elements to buckets. + A number in the range from 0.1 through 1.0 that is multiplied by the default value that provides the best performance. The result is the maximum ratio of elements to buckets. The object that defines the hash code provider and the comparer to use with the . -or- @@ -1435,7 +1435,7 @@ Each element is a key/value pair stored in a The approximate number of elements that the object can initially contain. - A number in the range from 0.1 through 1.0 that is multiplied by the default value which provides the best performance. The result is the maximum ratio of elements to buckets. + A number in the range from 0.1 through 1.0 that is multiplied by the default value that provides the best performance. The result is the maximum ratio of elements to buckets. The object that defines the hash code provider and the comparer to use with the . -or- @@ -1550,7 +1550,7 @@ Each element is a key/value pair stored in a The object to copy to a new object. - A number in the range from 0.1 through 1.0 that is multiplied by the default value which provides the best performance. The result is the maximum ratio of elements to buckets. + A number in the range from 0.1 through 1.0 that is multiplied by the default value that provides the best performance. The result is the maximum ratio of elements to buckets. The object that supplies the hash codes for all keys in the . -or- @@ -1660,7 +1660,7 @@ Each element is a key/value pair stored in a The approximate number of elements that the object can initially contain. - A number in the range from 0.1 through 1.0 that is multiplied by the default value which provides the best performance. The result is the maximum ratio of elements to buckets. + A number in the range from 0.1 through 1.0 that is multiplied by the default value that provides the best performance. The result is the maximum ratio of elements to buckets. The object that supplies the hash codes for all keys in the . -or- diff --git a/xml/System.Diagnostics.Metrics/MeterListener.xml b/xml/System.Diagnostics.Metrics/MeterListener.xml index d9fc498386e..cdb7a70569d 100644 --- a/xml/System.Diagnostics.Metrics/MeterListener.xml +++ b/xml/System.Diagnostics.Metrics/MeterListener.xml @@ -274,8 +274,8 @@ The type of the numeric measurement. - The callback which can be used to get measurement recording of numeric type T. - Sets a callback for a specific numeric type to get the measurement recording notification from all instruments which enabled listening and was created with the same specified numeric type. + The callback that can be used to get measurement recording of numeric type T. + Sets a callback for a specific numeric type to get the measurement recording notification from all instruments that enabled listening and were created with the same specified numeric type. If a measurement of type T is recorded and a callback of type T is registered, that callback will be used. To be added. diff --git a/xml/System.Diagnostics/ActivityCreationOptions`1.xml b/xml/System.Diagnostics/ActivityCreationOptions`1.xml index 9cb60790f22..3d7bb82b494 100644 --- a/xml/System.Diagnostics/ActivityCreationOptions`1.xml +++ b/xml/System.Diagnostics/ActivityCreationOptions`1.xml @@ -67,7 +67,7 @@ The possible generic type parameters are The name of the event being written. - An object that represents the additional context for IsEnabled. Consumers should expect to receive which may indicate that producer called pure IsEnabled(string) to check if consumer wants to get notifications for such events at all. Based on that, producer may call IsEnabled(string, object, object) again with non- context. - Optional. An object that represents the additional context for IsEnabled. by default. Consumers should expect to receive which may indicate that producer called pure IsEnabled(string) or producer passed all necessary context in . + An object that represents the additional context for IsEnabled. Consumers should expect to receive , which might indicate that producer called pure IsEnabled(string) to check if consumer wants to get notifications for such events at all. Based on that, producer may call IsEnabled(string, object, object) again with non- context. + Optional. An object that represents the additional context for IsEnabled. by default. Consumers should expect to receive , which might indicate that producer called pure IsEnabled(string) or producer passed all necessary context in . Verifies it the notification event is enabled. if the notification event is enabled, otherwise. @@ -546,7 +546,7 @@ Consumers can access The name of the event being written. - An object that represents the value being passed as a payload for the event. This is often an anonymous type which contains several sub-values. + An object that represents the value being passed as a payload for the event. This is often an anonymous type that contains several subvalues. Provides a generic way of logging complex payloads. diff --git a/xml/System.Diagnostics/EventSchemaTraceListener.xml b/xml/System.Diagnostics/EventSchemaTraceListener.xml index f747f96ee6c..d8956b56261 100644 --- a/xml/System.Diagnostics/EventSchemaTraceListener.xml +++ b/xml/System.Diagnostics/EventSchemaTraceListener.xml @@ -17,94 +17,94 @@ Directs tracing or debugging output of end-to-end events to an XML-encoded, schema-compliant log file. - class provides tracing of end-to-end schema-compliant events. You can use end-to-end tracing for a system that has heterogeneous components that cross thread, , process, and computer boundaries. A standardized event schema enables tracing across these boundaries. The schema enables the addition of custom, schema-compliant elements. You can use the [Service Trace Viewer Tool (SvcTraceViewer.exe)](/dotnet/framework/wcf/service-trace-viewer-tool-svctraceviewer-exe) to display the event data. - - is tuned for logging performance with implicit support for lock-free tracing. - - The class converts tracing and debugging information into an XML-encoded text stream. The description of the XML output is shown in the tables later in this section. - -You can create an object in your code. Alternatively, for .NET Framework apps, you can enable or disable an object through the application configuration file, and then use the configured object in your application. For information about the use of configuration files for tracing and debugging in .NET Framework apps, see [Trace and Debug Settings Schema](/dotnet/framework/configure-apps/file-schema/trace-debug/). - - To configure an object in a .NET Framework app, modify the configuration file that corresponds to the name of your application. In this file, you can add, remove, or set the properties for a listener. The configuration file should be formatted as follows: - -```xml - - - - - - - - - - - - - -``` - - The class inherits the property from the base class . The property allows for an additional level of trace output filtering at the listener. If a filter is present, the `Trace` methods of the trace listener call the method of the filter to determine whether to emit the trace. - - If an attempt is made to write to a file that is being used or is unavailable, a GUID suffix is automatically added to the file name. - + class provides tracing of end-to-end schema-compliant events. You can use end-to-end tracing for a system that has heterogeneous components that cross thread, , process, and computer boundaries. A standardized event schema enables tracing across these boundaries. The schema enables the addition of custom, schema-compliant elements. You can use the [Service Trace Viewer Tool (SvcTraceViewer.exe)](/dotnet/framework/wcf/service-trace-viewer-tool-svctraceviewer-exe) to display the event data. + + is tuned for logging performance with implicit support for lock-free tracing. + + The class converts tracing and debugging information into an XML-encoded text stream. The description of the XML output is shown in the tables later in this section. + +You can create an object in your code. Alternatively, for .NET Framework apps, you can enable or disable an object through the application configuration file, and then use the configured object in your application. For information about the use of configuration files for tracing and debugging in .NET Framework apps, see [Trace and Debug Settings Schema](/dotnet/framework/configure-apps/file-schema/trace-debug/). + + To configure an object in a .NET Framework app, modify the configuration file that corresponds to the name of your application. In this file, you can add, remove, or set the properties for a listener. The configuration file should be formatted as follows: + +```xml + + + + + + + + + + + + + +``` + + The class inherits the property from the base class . The property allows for an additional level of trace output filtering at the listener. If a filter is present, the `Trace` methods of the trace listener call the method of the filter to determine whether to emit the trace. + + If an attempt is made to write to a file that is being used or is unavailable, a GUID suffix is automatically added to the file name. + > [!NOTE] -> Listener methods are intended to be called by methods of the , , and classes. Do not call the listener methods directly from application code. The listener is primarily intended for use by the class. - - The following table describes the elements and attributes of the XML output. - -|Element|Attributes|Output|Notes| -|-------------|----------------|------------|-----------| -|`CallStack`|None|Depends on the presence of the flag in the property.|Special characters such as > or < are replaced with escape sequences. See the escaped character translation table in the next table.| -|`Computer`|None|Always present.|This element represents the value of the property.| -|`Correlation`|`ActivityID`|Always present.|If `ActivityID` is not specified, the default is an empty GUID.| -||`RelatedActivityID`|Depends on the presence of the `relatedActivityId` parameter in the `Trace` method call.|The `RelatedActivityID` attribute corresponds to the `relatedActivityId` parameter of the method.| -|`Data`|None|Always present.|This element represents parameter input (`data`). One element is provided for each data object. In the case of event logs, the `Data` element contains escaped XML data. In the case of data logs, the `Data` element contains unescaped data. The data log output uses the `ToString` method of the passed-in data objects.| -|`Event`|None|Always present.|This element contains a trace event.| -|`EventData`|None|Present for event logs.|This element represents parameter input (`message`, `args`). It contains `Data` elements with escaped XML data that is created by calling the method.| -|`EventID`|None|Always present.|This element represents parameter input (`id`).| -|`Execution`|`ProcessID`|Depends on the presence of the flag in the property.|The `ProcessID` attribute is specified in the .| -||`ThreadID`|Present when `ProcessID` is present.|The `ThreadID` attribute is specified in the .| -|`Level`|None|Always present.|This element represents parameter input (the numeric value of `eventType`). Parameter values that are larger than 255 are output as a level 8, which represents . Trace event types , , , , and are output as levels 1, 2, 4, 8, and 10, respectively.| -|`LogicalOperationStack`|None|Depends on the presence of the flag in the property.|Only one logical operation can exist. Therefore, the values are written as `LogicalOperation` nodes under the `LogicalOperationStack` element.| -|`OpCode`|None|Present when `Level` is greater than 255.|This element represents Trace event types that have numeric values greater than 255. , , , , or are output as levels 1, 2, 4, 8, and 10, respectively.| -|`Provider`|`GUID`|Always present.|Always empty.| -|`RenderingInfo`|`Culture`|Always present.|This attribute represents a resource string for the event type. It is always "en-EN\\".| -|`System`|`Name`|Always present.|| -|`TimeCreated`|`SystemTime`|Depends on the presence of the flag in the property.|The time is the value of the property. This property is expressed as Coordinated Universal Time| -|`TimeStamp`|None|Depends on the presence of the flag in the property.|This element is specified in the .| -|`UserData`|None|Present for data logs.|This element contains `Data` elements with unescaped, user-provided data from a method.| - - The following table shows the characters that are escaped in the XML output. Escaping occurs in all the elements and attributes except for the `UserData` element, which contains user-provided, unescaped data. The `UserData` element is a result of calls to the method. - -|Escaped character|Value| -|-----------------------|-----------| -|&|&| -|\<|<| -|>|>| -|"|"| -|\|'| -|0xD|&\#xD;| +> Listener methods are intended to be called by methods of the , , and classes. Do not call the listener methods directly from application code. The listener is primarily intended for use by the class. + + The following table describes the elements and attributes of the XML output. + +|Element|Attributes|Output|Notes| +|-------------|----------------|------------|-----------| +|`CallStack`|None|Depends on the presence of the flag in the property.|Special characters such as > or < are replaced with escape sequences. See the escaped character translation table in the next table.| +|`Computer`|None|Always present.|This element represents the value of the property.| +|`Correlation`|`ActivityID`|Always present.|If `ActivityID` is not specified, the default is an empty GUID.| +||`RelatedActivityID`|Depends on the presence of the `relatedActivityId` parameter in the `Trace` method call.|The `RelatedActivityID` attribute corresponds to the `relatedActivityId` parameter of the method.| +|`Data`|None|Always present.|This element represents parameter input (`data`). One element is provided for each data object. In the case of event logs, the `Data` element contains escaped XML data. In the case of data logs, the `Data` element contains unescaped data. The data log output uses the `ToString` method of the passed-in data objects.| +|`Event`|None|Always present.|This element contains a trace event.| +|`EventData`|None|Present for event logs.|This element represents parameter input (`message`, `args`). It contains `Data` elements with escaped XML data that is created by calling the method.| +|`EventID`|None|Always present.|This element represents parameter input (`id`).| +|`Execution`|`ProcessID`|Depends on the presence of the flag in the property.|The `ProcessID` attribute is specified in the .| +||`ThreadID`|Present when `ProcessID` is present.|The `ThreadID` attribute is specified in the .| +|`Level`|None|Always present.|This element represents parameter input (the numeric value of `eventType`). Parameter values that are larger than 255 are output as a level 8, which represents . Trace event types , , , , and are output as levels 1, 2, 4, 8, and 10, respectively.| +|`LogicalOperationStack`|None|Depends on the presence of the flag in the property.|Only one logical operation can exist. Therefore, the values are written as `LogicalOperation` nodes under the `LogicalOperationStack` element.| +|`OpCode`|None|Present when `Level` is greater than 255.|This element represents Trace event types that have numeric values greater than 255. , , , , or are output as levels 1, 2, 4, 8, and 10, respectively.| +|`Provider`|`GUID`|Always present.|Always empty.| +|`RenderingInfo`|`Culture`|Always present.|This attribute represents a resource string for the event type. It is always "en-EN\\".| +|`System`|`Name`|Always present.|| +|`TimeCreated`|`SystemTime`|Depends on the presence of the flag in the property.|The time is the value of the property. This property is expressed as Coordinated Universal Time| +|`TimeStamp`|None|Depends on the presence of the flag in the property.|This element is specified in the .| +|`UserData`|None|Present for data logs.|This element contains `Data` elements with unescaped, user-provided data from a method.| + + The following table shows the characters that are escaped in the XML output. Escaping occurs in all the elements and attributes except for the `UserData` element, which contains user-provided, unescaped data. The `UserData` element is a result of calls to the method. + +|Escaped character|Value| +|-----------------------|-----------| +|&|&| +|\<|<| +|>|>| +|"|"| +|\|'| +|0xD|&\#xD;| |0xA|&\#xA;| - -## Examples - The following code example demonstrates how to use the class. - + +## Examples + The following code example demonstrates how to use the class. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR_System/system.Diagnostics.EventSchemaTraceListener/CPP/eventschematracelistener.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Diagnostics/EventSchemaTraceListener/Overview/program.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Diagnostics.EventSchemaTraceListener/vb/program.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Diagnostics.EventSchemaTraceListener/vb/program.vb" id="Snippet1"::: + ]]> @@ -138,19 +138,19 @@ You can create an object in y The path for the log file. Initializes a new instance of the class, using the specified file as the recipient of debugging and tracing output. - constructor. - + constructor. + :::code language="csharp" source="~/snippets/csharp/System.Diagnostics/EventSchemaTraceListener/.ctor/program.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Diagnostics.EventSchemaTraceListener.Ctors/VB/program.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Diagnostics.EventSchemaTraceListener.Ctors/VB/program.vb" id="Snippet1"::: + ]]> @@ -183,14 +183,14 @@ You can create an object in y The name of the listener. Initializes a new instance of the class with the specified name, using the specified file as the recipient of debugging and tracing output. - constructor. - + constructor. + :::code language="csharp" source="~/snippets/csharp/System.Diagnostics/EventSchemaTraceListener/.ctor/program.cs" id="Snippet2"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Diagnostics.EventSchemaTraceListener.Ctors/VB/program.vb" id="Snippet2"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Diagnostics.EventSchemaTraceListener.Ctors/VB/program.vb" id="Snippet2"::: + ]]> @@ -225,19 +225,19 @@ You can create an object in y The size of the output buffer, in bytes. Initializes a new instance of the class with the specified name and specified buffer size, using the specified file as the recipient of debugging and tracing output. - constructor. - + constructor. + :::code language="csharp" source="~/snippets/csharp/System.Diagnostics/EventSchemaTraceListener/.ctor/program.cs" id="Snippet3"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Diagnostics.EventSchemaTraceListener.Ctors/VB/program.vb" id="Snippet3"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Diagnostics.EventSchemaTraceListener.Ctors/VB/program.vb" id="Snippet3"::: + ]]> @@ -268,19 +268,19 @@ You can create an object in y One of the values. Initializes a new instance of the class with the specified name and specified buffer size, using the specified file with the specified log retention policy as the recipient of the debugging and tracing output. - constructor. - + constructor. + :::code language="csharp" source="~/snippets/csharp/System.Diagnostics/EventSchemaTraceListener/.ctor/program.cs" id="Snippet4"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Diagnostics.EventSchemaTraceListener.Ctors/VB/program.vb" id="Snippet4"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Diagnostics.EventSchemaTraceListener.Ctors/VB/program.vb" id="Snippet4"::: + ]]> @@ -319,19 +319,17 @@ You can create an object in y The maximum file size, in bytes. Initializes a new instance of the class with the specified name and specified buffer size, using the specified file with the specified log retention policy and maximum size as the recipient of the debugging and tracing output. - constructor. - + constructor. + :::code language="csharp" source="~/snippets/csharp/System.Diagnostics/EventSchemaTraceListener/.ctor/program.cs" id="Snippet5"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Diagnostics.EventSchemaTraceListener.Ctors/VB/program.vb" id="Snippet5"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Diagnostics.EventSchemaTraceListener.Ctors/VB/program.vb" id="Snippet5"::: + ]]> @@ -373,19 +371,19 @@ You can create an object in y The maximum number of output log files. Initializes a new instance of the class with the specified name and specified buffer size, using the specified file with the specified log retention policy, maximum size, and file count as the recipient of the debugging and tracing output. - constructor. This code example is part of a larger example that is provided for the class. - + constructor. This code example is part of a larger example that is provided for the class. + :::code language="csharp" source="~/snippets/csharp/System.Diagnostics/EventSchemaTraceListener/Overview/program.cs" id="Snippet2"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Diagnostics.EventSchemaTraceListener/vb/program.vb" id="Snippet2"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Diagnostics.EventSchemaTraceListener/vb/program.vb" id="Snippet2"::: + ]]> @@ -425,19 +423,19 @@ You can create an object in y Gets the size of the output buffer. The size of the output buffer, in bytes. - property. This code example is part of a larger example that is provided for the class. - + property. This code example is part of a larger example that is provided for the class. + :::code language="csharp" source="~/snippets/csharp/System.Diagnostics/EventSchemaTraceListener/Overview/program.cs" id="Snippet5"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Diagnostics.EventSchemaTraceListener/vb/program.vb" id="Snippet5"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Diagnostics.EventSchemaTraceListener/vb/program.vb" id="Snippet5"::: + ]]> @@ -540,11 +538,11 @@ You can create an object in y Gets the custom XML configuration attributes that the trace listener supports. A array that contains the XML configuration attributes recognized by this listener. - class. Using any other attribute causes a configuration exception. The method for the returns the following string array values: "bufferSize", "logRetentionOption", "maximumFileSize", and "maximumNumberOfFiles". - + class. Using any other attribute causes a configuration exception. The method for the returns the following string array values: "bufferSize", "logRetentionOption", "maximumFileSize", and "maximumNumberOfFiles". + ]]> @@ -569,14 +567,14 @@ You can create an object in y Gets a value indicating whether the trace listener is thread safe. Always returns . - property. This code example is part of a larger example that is provided for the class. - + property. This code example is part of a larger example that is provided for the class. + :::code language="csharp" source="~/snippets/csharp/System.Diagnostics/EventSchemaTraceListener/Overview/program.cs" id="Snippet4"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Diagnostics.EventSchemaTraceListener/vb/program.vb" id="Snippet4"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Diagnostics.EventSchemaTraceListener/vb/program.vb" id="Snippet4"::: + ]]> @@ -601,29 +599,29 @@ You can create an object in y Gets the maximum size of the log file. The maximum file size, in bytes. - property value is not an absolute; it is a threshold that can be exceeded up to the size of the last message. - - The following table shows the possible and default values for file size that are associated with each trace log retention option. The values marked as N/A indicate that the property is not checked for that value. - -|TraceLogRetentionOption|Maximum file size|Default file size| -|-----------------------------|-----------------------|-----------------------| -||N/A|-1| -||>0|4 KB| -||>0|4 KB| -||>0|4 KB| -||>0|4 KB| - - - -## Examples - The following code example demonstrates how to display the value of the property. This code example is part of a larger example that is provided for the class. - + property value is not an absolute; it is a threshold that can be exceeded up to the size of the last message. + + The following table shows the possible and default values for file size that are associated with each trace log retention option. The values marked as N/A indicate that the property is not checked for that value. + +|TraceLogRetentionOption|Maximum file size|Default file size| +|-----------------------------|-----------------------|-----------------------| +||N/A|-1| +||>0|4 KB| +||>0|4 KB| +||>0|4 KB| +||>0|4 KB| + + + +## Examples + The following code example demonstrates how to display the value of the property. This code example is part of a larger example that is provided for the class. + :::code language="csharp" source="~/snippets/csharp/System.Diagnostics/EventSchemaTraceListener/Overview/program.cs" id="Snippet6"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Diagnostics.EventSchemaTraceListener/vb/program.vb" id="Snippet6"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Diagnostics.EventSchemaTraceListener/vb/program.vb" id="Snippet6"::: + ]]> @@ -648,29 +646,29 @@ You can create an object in y Gets the maximum number of log files. The maximum number of log files, determined by the value of the property for the file. - property is not checked for that value. - -|TraceLogRetentionOption|Maximum number of files|Default number of files| -|-----------------------------|-----------------------------|-----------------------------| -||N/A|1| -||N/A|1| -||N/A|-1| -||>0|1| -||>1|2| - - - -## Examples - The following code example demonstrates how to display the value of the property. This code example is part of a larger example that is provided for the class. - + property is not checked for that value. + +|TraceLogRetentionOption|Maximum number of files|Default number of files| +|-----------------------------|-----------------------------|-----------------------------| +||N/A|1| +||N/A|1| +||N/A|-1| +||>0|1| +||>1|2| + + + +## Examples + The following code example demonstrates how to display the value of the property. This code example is part of a larger example that is provided for the class. + :::code language="csharp" source="~/snippets/csharp/System.Diagnostics/EventSchemaTraceListener/Overview/program.cs" id="Snippet7"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Diagnostics.EventSchemaTraceListener/vb/program.vb" id="Snippet7"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Diagnostics.EventSchemaTraceListener/vb/program.vb" id="Snippet7"::: + ]]> @@ -721,14 +719,14 @@ You can create an object in y A data object to emit. Writes trace information, a single data object, and event information to the log file. - [!IMPORTANT] -> This method is not intended to be called directly by application code. It is called by methods of the , , and classes to write trace data. - +> This method is not intended to be called directly by application code. It is called by methods of the , , and classes to write trace data. + ]]> @@ -777,14 +775,14 @@ You can create an object in y An array of data objects to emit. Writes trace information, multiple data objects, and event information to the log file. - [!IMPORTANT] -> This method is not intended to be called directly by application code. It is called by methods of the , , and classes to write trace data. - +> This method is not intended to be called directly by application code. It is called by methods of the , , and classes to write trace data. + ]]> @@ -835,14 +833,14 @@ You can create an object in y The message to write. Writes trace information, a message, and event information to the log file. - [!IMPORTANT] -> This method is not intended to be called directly by application code. It is called by methods of the , , and classes to write trace data. - +> This method is not intended to be called directly by application code. It is called by methods of the , , and classes to write trace data. + ]]> @@ -893,14 +891,14 @@ You can create an object in y An object array that contains zero or more objects to format. Writes trace information, a formatted message, and event information to the log file. - method is called and the `format` string and `args` array are passed in as parameters. This method formats the `args` object array and writes the formatted array as the `Data` node in the `EventData` element. - + method is called and the `format` string and `args` array are passed in as parameters. This method formats the `args` object array and writes the formatted array as the `Data` node in the `EventData` element. + > [!IMPORTANT] -> This method is not intended to be called directly by application code. It is called by methods of the , , and classes to write trace data. - +> This method is not intended to be called directly by application code. It is called by methods of the , , and classes to write trace data. + ]]> @@ -925,14 +923,14 @@ You can create an object in y Gets the trace log retention option for the file. One of the values. The default is . - property. This code example is part of a larger example that is provided for the class. - + property. This code example is part of a larger example that is provided for the class. + :::code language="csharp" source="~/snippets/csharp/System.Diagnostics/EventSchemaTraceListener/Overview/program.cs" id="Snippet9"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Diagnostics.EventSchemaTraceListener/vb/program.vb" id="Snippet9"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Diagnostics.EventSchemaTraceListener/vb/program.vb" id="Snippet9"::: + ]]> @@ -974,14 +972,14 @@ You can create an object in y A structure that identifies a related activity. Writes trace information, including the identity of a related activity, a message, and event information, to the log file. - method is used to correlate related traces. The `eventCache`, `source`, `id`, and `relatedActivityId` parameters are used in the header and footer of the trace. The `id` parameter is converted to an unsigned integer before it is written. Therefore, a negative `id` value is written as a large positive integer. The `message` parameter is written as the `Data` element. The method is called to convert the `relatedActivityId` value to a "B" formatted string, which appears in the header. The `Opcode` element in the footer identifies the trace event type as a . - + method is used to correlate related traces. The `eventCache`, `source`, `id`, and `relatedActivityId` parameters are used in the header and footer of the trace. The `id` parameter is converted to an unsigned integer before it is written. Therefore, a negative `id` value is written as a large positive integer. The `message` parameter is written as the `Data` element. The method is called to convert the `relatedActivityId` value to a "B" formatted string, which appears in the header. The `Opcode` element in the footer identifies the trace event type as a . + > [!IMPORTANT] -> The method should not be called by application code. It is intended to be used by a object to emit the trace information for its method. - +> The method should not be called by application code. It is intended to be used by a object to emit the trace information for its method. + ]]> @@ -1009,14 +1007,14 @@ You can create an object in y The message to write. Writes a message to the log file without providing any additional context information. - method is called to log the message as an event. - + method is called to log the message as an event. + > [!IMPORTANT] -> This method is not intended to be called directly by application code. It is called by methods of the , , and classes to write trace data. - +> This method is not intended to be called directly by application code. It is called by methods of the , , and classes to write trace data. + ]]> @@ -1044,14 +1042,14 @@ You can create an object in y The message to write. Writes a message followed by the current line terminator to the log file without providing any additional context information. - method is called to log the message as an event. - + method is called to log the message as an event. + > [!IMPORTANT] -> This method is not intended to be called directly by application code. It is called by methods of the , , and classes to write trace data. - +> This method is not intended to be called directly by application code. It is called by methods of the , , and classes to write trace data. + ]]> @@ -1082,11 +1080,11 @@ You can create an object in y Gets or sets the underlying text writer that writes to the log file. A object. - property raises a . - + property raises a . + ]]> An attempt was made to assign a value to the property. diff --git a/xml/System.Diagnostics/Process.xml b/xml/System.Diagnostics/Process.xml index b89a7cacc09..b1cd1f97feb 100644 --- a/xml/System.Diagnostics/Process.xml +++ b/xml/System.Diagnostics/Process.xml @@ -2069,7 +2069,7 @@ There are problems accessing the performance counter APIs used to get process in ## Remarks An application can obtain a handle to a process that can be used as a parameter to many process-information and control functions. You can use this handle to initialize a or to call native methods with platform invoke. - This process handle is private to an application--in other words, process handles cannot be shared. A process also has a process which, unlike the , is unique and, therefore, valid throughout the system. + This process handle is private to an application. In other words, process handles cannot be shared. A process also has a process that, unlike the , is unique and, therefore, valid throughout the system. Only processes started through a call to set the property of the corresponding instances. diff --git a/xml/System.Diagnostics/Switch.xml b/xml/System.Diagnostics/Switch.xml index 711c04aae19..61f5845f186 100644 --- a/xml/System.Diagnostics/Switch.xml +++ b/xml/System.Diagnostics/Switch.xml @@ -51,57 +51,57 @@ Provides an abstract base class to create new debugging and tracing switches. - class implements default behavior for switches, allowing you to change the switch level at run time. - - This class is the base class for the , , and classes. These switches meet most debugging and tracing needs. For more information about trace switches, see [Trace Switches](/dotnet/framework/debug-trace-profile/trace-switches). - - You must enable tracing or debugging to use a switch. The following syntax is compiler specific. If you use compilers other than C# or Visual Basic, refer to the documentation for your compiler. - -- To enable debugging in C#, add the `/d:DEBUG` flag to the compiler command line when you compile your code, or you can add `#define DEBUG` to the top of your file. In Visual Basic, add the `/d:DEBUG=True` flag to the compiler command line. - -- To enable tracing using in C#, add the `/d:TRACE` flag to the compiler command line when you compile your code, or add `#define TRACE` to the top of your file. In Visual Basic, add the `/d:TRACE=True` flag to the compiler command line. - - To set the level of your switch in a .NET Framework app, edit the configuration file that corresponds to the name of your application. Within this file, you can add a switch and set its value, remove a switch, or clear all the switches previously set by the application. The configuration file should be formatted like the following example: - -```xml - - - - - - - -``` - - This example configuration section defines a with the property set to `mySwitch` and the value set to `true`. Within your application, you can use the configured switch value by creating a with the same name, as shown in the following code example. - + class implements default behavior for switches, allowing you to change the switch level at run time. + + This class is the base class for the , , and classes. These switches meet most debugging and tracing needs. For more information about trace switches, see [Trace Switches](/dotnet/framework/debug-trace-profile/trace-switches). + + You must enable tracing or debugging to use a switch. The following syntax is compiler specific. If you use compilers other than C# or Visual Basic, refer to the documentation for your compiler. + +- To enable debugging in C#, add the `/d:DEBUG` flag to the compiler command line when you compile your code, or you can add `#define DEBUG` to the top of your file. In Visual Basic, add the `/d:DEBUG=True` flag to the compiler command line. + +- To enable tracing using in C#, add the `/d:TRACE` flag to the compiler command line when you compile your code, or add `#define TRACE` to the top of your file. In Visual Basic, add the `/d:TRACE=True` flag to the compiler command line. + + To set the level of your switch in a .NET Framework app, edit the configuration file that corresponds to the name of your application. Within this file, you can add a switch and set its value, remove a switch, or clear all the switches previously set by the application. The configuration file should be formatted like the following example: + +```xml + + + + + + + +``` + + This example configuration section defines a with the property set to `mySwitch` and the value set to `true`. Within your application, you can use the configured switch value by creating a with the same name, as shown in the following code example. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR_Classic/classic Switch Example/CPP/remarks.cpp" id="Snippet4"::: :::code language="csharp" source="~/snippets/csharp/System.Diagnostics/Switch/Overview/remarks.cs" id="Snippet4"::: - -## Examples - The following example shows how to define a new class with four levels of tracing that can be used to trace a call stack. You can use the switch to instrument your application to log each time the method is entered or exited. - - The first example creates the enumeration used to set the level of the switch. - + +## Examples + The following example shows how to define a new class with four levels of tracing that can be used to trace a call stack. You can use the switch to instrument your application to log each time the method is entered or exited. + + The first example creates the enumeration used to set the level of the switch. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR_Classic/classic Switch Example/CPP/source.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Diagnostics/Switch/Overview/source.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_Classic/classic Switch Example/VB/source.vb" id="Snippet1"::: - - The following example creates the new switch. The code implements a `Level` property to set the value of the new switch. `Level` calls the protected property that assigns the value to the new switch. This example also implements two assessor properties to get the assigned value of the switch. - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_Classic/classic Switch Example/VB/source.vb" id="Snippet1"::: + + The following example creates the new switch. The code implements a `Level` property to set the value of the new switch. `Level` calls the protected property that assigns the value to the new switch. This example also implements two assessor properties to get the assigned value of the switch. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR_Classic/classic Switch Example/CPP/source.cpp" id="Snippet2"::: :::code language="csharp" source="~/snippets/csharp/System.Diagnostics/Switch/Overview/source.cs" id="Snippet2"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_Classic/classic Switch Example/VB/source.vb" id="Snippet2"::: - - The following example creates a new switch in `Main`. It creates a new switch and assigns it a value. Then, depending on the switch settings, it outputs debugging messages for entering and leaving the method. - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_Classic/classic Switch Example/VB/source.vb" id="Snippet2"::: + + The following example creates a new switch in `Main`. It creates a new switch and assigns it a value. Then, depending on the switch settings, it outputs debugging messages for entering and leaving the method. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR_Classic/classic Switch Example/CPP/source.cpp" id="Snippet3"::: :::code language="csharp" source="~/snippets/csharp/System.Diagnostics/Switch/Overview/source.cs" id="Snippet3"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_Classic/classic Switch Example/VB/source.vb" id="Snippet3"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_Classic/classic Switch Example/VB/source.vb" id="Snippet3"::: + ]]> @@ -180,26 +180,26 @@ The description for the switch. Initializes a new instance of the class. - object, the value of the `displayName` parameter is used to find initial switch settings. The default value is an empty string (""). - - Within the XML configuration file of a .NET Framework app, you can add a switch and set its value, remove a switch, or clear all the switches previously set by the application. Dynamic changes to the configuration file are not detected while the application is executing. You must stop and restart an application before changes to the configuration file take effect. The configuration file should be formatted like the following example: - -```xml - - - - - - - - - - -``` - + object, the value of the `displayName` parameter is used to find initial switch settings. The default value is an empty string (""). + + Within the XML configuration file of a .NET Framework app, you can add a switch and set its value, remove a switch, or clear all the switches previously set by the application. Dynamic changes to the configuration file are not detected while the application is executing. You must stop and restart an application before changes to the configuration file take effect. The configuration file should be formatted like the following example: + +```xml + + + + + + + + + + +``` + ]]> @@ -265,11 +265,11 @@ The default value for the switch. Initializes a new instance of the class, specifying the display name, description, and default value for the switch. - property, and the `description` parameter is use to set the value of the property. The `defaultSwitchValue` parameter is the value for the switch if the property is not set by code or by the configuration file attribute. See the overload for additional information. - + property, and the `description` parameter is use to set the value of the property. The `defaultSwitchValue` parameter is the value for the switch if the property is not set by code or by the configuration file attribute. See the overload for additional information. + ]]> @@ -318,19 +318,19 @@ Gets the custom switch attributes defined in the application configuration file. A containing the case-insensitive custom attributes for the trace switch. - property identifies the custom attributes referenced in the application's configuration file. Unreferenced custom attributes are not enumerated. Classes that inherit from the class can add custom attributes by overriding the method and returning a string array of custom attribute names. - - - -## Examples - The following code sample shows how to display the unrecognized attributes for a custom switch. - + property identifies the custom attributes referenced in the application's configuration file. Unreferenced custom attributes are not enumerated. Classes that inherit from the class can add custom attributes by overriding the method and returning a string array of custom attribute names. + + + +## Examples + The following code sample shows how to display the unrecognized attributes for a custom switch. + :::code language="csharp" source="~/snippets/csharp/System.Diagnostics/SourceFilter/.ctor/program.cs" id="Snippet15"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Diagnostics.TraceSource/VB/program.vb" id="Snippet15"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Diagnostics.TraceSource/VB/program.vb" id="Snippet15"::: + ]]> @@ -402,11 +402,11 @@ Gets a description of the switch. The description of the switch. The default value is an empty string (""). - constructor. - + constructor. + ]]> @@ -462,19 +462,19 @@ Gets a name used to identify the switch. The name used to identify the switch. The default value is an empty string (""). - object, the finds initial switch settings. For more information, see the constructor and [How to: Create, Initialize and Configure Trace Switches](/dotnet/framework/debug-trace-profile/how-to-create-initialize-and-configure-trace-switches) in the Visual Studio documentation. - - - -## Examples - The following code example displays the display name for the switch in use by a trace source. This code example is part of a larger example that can be found in the class summary. - + object, the finds initial switch settings. For more information, see the constructor and [How to: Create, Initialize and Configure Trace Switches](/dotnet/framework/debug-trace-profile/how-to-create-initialize-and-configure-trace-switches) in the Visual Studio documentation. + + + +## Examples + The following code example displays the display name for the switch in use by a trace source. This code example is part of a larger example that can be found in the class summary. + :::code language="csharp" source="~/snippets/csharp/System.Diagnostics/SourceFilter/.ctor/program.cs" id="Snippet10"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Diagnostics.TraceSource/VB/program.vb" id="Snippet10"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Diagnostics.TraceSource/VB/program.vb" id="Snippet10"::: + ]]> @@ -534,19 +534,19 @@ Gets the custom attributes supported by the switch. A string array that contains the names of the custom attributes supported by the switch, or if there no custom attributes are supported. - method returns `null`. If a switch is added in a configuration file and custom attributes are specified that are not included in the string array returned by , a is thrown when the switch is loaded. - - - -## Examples - The following code sample shows an override of the method for a custom switch. - + method returns `null`. If a switch is added in a configuration file and custom attributes are specified that are not included in the string array returned by , a is thrown when the switch is loaded. + + + +## Examples + The following code sample shows an override of the method for a custom switch. + :::code language="csharp" source="~/snippets/csharp/System.Diagnostics/SourceFilter/.ctor/program.cs" id="Snippet34"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Diagnostics.TraceSource/VB/program.vb" id="Snippet34"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Diagnostics.TraceSource/VB/program.vb" id="Snippet34"::: + ]]> @@ -626,11 +626,11 @@ Invoked when the property is changed. - is invoked the first time a switch reads the value from the configuration file and is invoked again each time the switch's value is changed. - + is invoked the first time a switch reads the value from the configuration file and is invoked again each time the switch's value is changed. + ]]> @@ -674,11 +674,11 @@ Invoked when the property is changed. - property to an integer value which it uses to set the property. - + property to an integer value that it uses to set the property. + ]]> @@ -802,21 +802,21 @@ Gets or sets the value of the switch. A string representing the value of the switch. - method is called when the value of the property is changed. The method parses the value of this property and converts it to an integer value, which is then used to set the property. - + method is called when the value of the property is changed. The method parses the value of this property and converts it to an integer value, which is then used to set the property. + ]]> - The value is . - - -or- - - The value does not consist solely of an optional negative sign followed by a sequence of digits ranging from 0 to 9. - - -or- - + The value is . + + -or- + + The value does not consist solely of an optional negative sign followed by a sequence of digits ranging from 0 to 9. + + -or- + The value represents a number less than Int32.MinValue or greater than Int32.MaxValue. You should override the method and provide a conversion operation that sets the appropriate value for your switch. diff --git a/xml/System.Formats.Asn1/AsnDecoder.xml b/xml/System.Formats.Asn1/AsnDecoder.xml index 793908549a5..81f13bb2abe 100644 --- a/xml/System.Formats.Asn1/AsnDecoder.xml +++ b/xml/System.Formats.Asn1/AsnDecoder.xml @@ -110,7 +110,7 @@ The buffer containing encoded data. The encoding constraints to use when interpreting the data. - On success, receives the number of bits in the last byte which were reported as + On success, receives the number of bits in the last byte that were reported as "unused" by the writer. This parameter is treated as uninitialized. @@ -139,13 +139,13 @@ The next value does not have the correct tag. - + -or- - + The length encoding is not valid under the current encoding rules. - + -or- - + The contents are not valid under the current encoding rules. @@ -205,13 +205,13 @@ The next value does not have the correct tag. - + -or- - + The length encoding is not valid under the current encoding rules. - + -or- - + The contents are not valid under the current encoding rules. @@ -280,24 +280,24 @@ is not defined. - + -or- - + is not a known character string type. The next value does not have the correct tag. - + -or- - + The length encoding is not valid under the current encoding rules. - + -or- - + The contents are not valid under the current encoding rules. - + -or- - + The string did not successfully decode. @@ -430,13 +430,13 @@ The next value does not have the correct tag. - + -or- - + The length encoding is not valid under the current encoding rules. - + -or- - + The contents are not valid under the current encoding rules. @@ -505,28 +505,28 @@ The next value does not have the correct tag. - + -or- - + The length encoding is not valid under the current encoding rules. - + -or- - + The contents are not valid under the current encoding rules. - + -or- - + The encoded value is too big to fit in a value. is not an enum type. - + -or- - + was declared with . - + -or- - + . is , but . is not correct for @@ -603,28 +603,28 @@ The next value does not have the correct tag. - + -or- - + The length encoding is not valid under the current encoding rules. - + -or- - + The contents are not valid under the current encoding rules. - + -or- - + The encoded value is too big to fit in a value. is not an enum type. - + -or- - + was declared with . - + -or- - + . is , but . is not correct for @@ -680,13 +680,13 @@ The next value does not have the correct tag. - + -or- - + The length encoding is not valid under the current encoding rules. - + -or- - + The contents are not valid under the current encoding rules. @@ -745,13 +745,13 @@ The next value does not have the correct tag. - + -or- - + The length encoding is not valid under the current encoding rules. - + -or- - + The contents are not valid under the current encoding rules. @@ -810,13 +810,13 @@ The next value does not have the correct tag. - + -or- - + The length encoding is not valid under the current encoding rules. - + -or- - + The contents are not valid under the current encoding rules. @@ -888,13 +888,13 @@ The next value does not have the correct tag. - + -or- - + The length encoding is not valid under the current encoding rules. - + -or- - + The contents are not valid under the current encoding rules. @@ -963,28 +963,28 @@ The next value does not have the correct tag. - + -or- - + The length encoding is not valid under the current encoding rules. - + -or- - + The contents are not valid under the current encoding rules. - + -or- - The encoded value is too big to fit in a value. is not an enum type. - + -or- - + was not declared with - + -or- - + . is , but . is not correct for @@ -1058,7 +1058,7 @@ with bits increasing in value until the least significant bit of the first byte, proceeding with the most significant bit of the second byte, and so on. Under this scheme, the following ASN.1 type declaration and C# enumeration can be used together: - + KeyUsage ::= BIT STRING { digitalSignature (0), @@ -1086,7 +1086,7 @@ DecipherOnly = 1 << (8), } - + While the example here uses the KeyUsage NamedBitList from RFC 3280 (4.2.1.3), the example enum uses values that are different from @@ -1097,28 +1097,28 @@ The next value does not have the correct tag. - + -or- - + The length encoding is not valid under the current encoding rules. - + -or- - + The contents are not valid under the current encoding rules. - + -or- - + The encoded value is too big to fit in a value. is not an enum type. - + -or- - + was not declared with - + -or- - + . is , but . is not correct for @@ -1171,13 +1171,13 @@ The next value does not have the correct tag. - + -or- - + The length encoding is not valid under the current encoding rules. - + -or- - + The contents are not valid under the current encoding rules. @@ -1242,13 +1242,13 @@ The next value does not have the correct tag. - + -or- - + The length encoding is not valid under the current encoding rules. - + -or- - + The contents are not valid under the current encoding rules. @@ -1314,13 +1314,13 @@ The next value does not have the correct tag. - + -or- - + The length encoding is not valid under the current encoding rules. - + -or- - + The contents are not valid under the current encoding rules. @@ -1392,13 +1392,13 @@ The next value does not have the correct tag. - + -or- - + The length encoding is not valid under the current encoding rules. - + -or- - + The contents are not valid under the current encoding rules. @@ -1476,13 +1476,13 @@ The next value does not have the correct tag. - + -or- - + The length encoding is not valid under the current encoding rules. - + -or- - + The contents are not valid under the current encoding rules. @@ -1543,20 +1543,20 @@ To be added. is not defined. - + -or- - + is not in the range [99, 9999]. The next value does not have the correct tag. - + -or- - + The length encoding is not valid under the current encoding rules. - + -or- - + The contents are not valid under the current encoding rules. @@ -1652,7 +1652,7 @@ The buffer in which to write. The encoding constraints to use when interpreting the data. - On success, receives the number of bits in the last byte which were reported as + On success, receives the number of bits in the last byte that were reported as "unused" by the writer. This parameter is treated as uninitialized. @@ -1687,13 +1687,13 @@ The next value does not have the correct tag. - + -or- - + The length encoding is not valid under the current encoding rules. - + -or- - + The contents are not valid under the current encoding rules. @@ -1701,9 +1701,9 @@ , but . is not correct for the method. - + -or- - + overlaps . @@ -1769,24 +1769,24 @@ is not defined. - + -or- - + is not a known character string type. The next value does not have the correct tag. - + -or- - + The length encoding is not valid under the current encoding rules. - + -or- - + The contents are not valid under the current encoding rules. - + -or- - + The string did not successfully decode. @@ -1858,13 +1858,13 @@ The next value does not have the correct tag. - + -or- - + The length encoding is not valid under the current encoding rules. - + -or- - + The contents are not valid under the current encoding rules. @@ -1872,9 +1872,9 @@ , but . is not a character string tag type. - + -or- - + overlaps . @@ -2009,13 +2009,13 @@ The next value does not have the correct tag. - + -or- - + The length encoding is not valid under the current encoding rules. - + -or- - + The contents are not valid under the current encoding rules. @@ -2081,13 +2081,13 @@ The next value does not have the correct tag. - + -or- - + The length encoding is not valid under the current encoding rules. - + -or- - + The contents are not valid under the current encoding rules. @@ -2156,13 +2156,13 @@ The next value does not have the correct tag. - + -or- - + The length encoding is not valid under the current encoding rules. - + -or- - + The contents are not valid under the current encoding rules. @@ -2170,9 +2170,9 @@ , but . is not correct for the method. - + -or- - + overlaps . @@ -2209,7 +2209,7 @@ The buffer containing encoded data. The encoding constraints to use when interpreting the data. - On success, receives the number of bits in the last byte which were reported as + On success, receives the number of bits in the last byte that were reported as "unused" by the writer. This parameter is treated as uninitialized. @@ -2240,13 +2240,13 @@ The next value does not have the correct tag. - + -or- - + The length encoding is not valid under the current encoding rules. - + -or- - + The contents are not valid under the current encoding rules. @@ -2317,13 +2317,13 @@ The next value does not have the correct tag. - + -or- - + The length encoding is not valid under the current encoding rules. - + -or- - + The contents are not valid under the current encoding rules. @@ -2390,13 +2390,13 @@ The next value does not have the correct tag. - + -or- - + The length encoding is not valid under the current encoding rules. - + -or- - + The contents are not valid under the current encoding rules. @@ -2469,13 +2469,13 @@ The next value does not have the correct tag. - + -or- - + The length encoding is not valid under the current encoding rules. - + -or- - + The contents are not valid under the current encoding rules. @@ -2547,13 +2547,13 @@ The next value does not have the correct tag. - + -or- - + The length encoding is not valid under the current encoding rules. - + -or- - + The contents are not valid under the current encoding rules. diff --git a/xml/System.Formats.Asn1/AsnReader.xml b/xml/System.Formats.Asn1/AsnReader.xml index 4c2b4923ae8..12d988ecd06 100644 --- a/xml/System.Formats.Asn1/AsnReader.xml +++ b/xml/System.Formats.Asn1/AsnReader.xml @@ -56,7 +56,7 @@ This constructor does not evaluate for correctness. Any correctness checks are done as part of member methods. - + This constructor does not copy . The caller is responsible for ensuring that the values do not change until the reader is finished. @@ -259,7 +259,7 @@ - On success, receives the number of bits in the last byte which were reported as + On success, receives the number of bits in the last byte that were reported as "unused" by the writer. @@ -276,13 +276,13 @@ The next value does not have the correct tag. - + -or- - + The length encoding is not valid under the current encoding rules. - + -or- - + The contents are not valid under the current encoding rules. @@ -329,13 +329,13 @@ To be added. The next value does not have the correct tag. - + -or- - + The length encoding is not valid under the current encoding rules. - + -or- - + The contents are not valid under the current encoding rules. @@ -392,17 +392,17 @@ The next value does not have the correct tag. - + -or- - + The length encoding is not valid under the current encoding rules. - + -or- - + The contents are not valid under the current encoding rules. - + -or- - + The string did not successfully decode. @@ -484,13 +484,13 @@ To be added. The next value does not have the correct tag. - + -or- - + The length encoding is not valid under the current encoding rules. - + -or- - + The contents are not valid under the current encoding rules. @@ -543,28 +543,28 @@ The next value does not have the correct tag. - + -or- - + The length encoding is not valid under the current encoding rules. - + -or- - + The contents are not valid under the current encoding rules. - + -or- - + The encoded value is too big to fit in a value. is not an enum type. - + -or- - + was declared with . - + -or- - + . is , but . is not correct for @@ -628,28 +628,28 @@ The next value does not have the correct tag. - + -or- - + The length encoding is not valid under the current encoding rules. - + -or- - + The contents are not valid under the current encoding rules. - + -or- - + The encoded value is too big to fit in a value. is not an enum type. - + -or- - + was declared with . - + -or- - + . is , but . is not correct for @@ -692,13 +692,13 @@ To be added. The next value does not have the correct tag. - + -or- - + The length encoding is not valid under the current encoding rules. - + -or- - + The contents are not valid under the current encoding rules. @@ -744,13 +744,13 @@ To be added. The next value does not have the correct tag. - + -or- - + The length encoding is not valid under the current encoding rules. - + -or- - + The contents are not valid under the current encoding rules. @@ -797,13 +797,13 @@ To be added. The next value does not have the correct tag. - + -or- - + The length encoding is not valid under the current encoding rules. - + -or- - + The contents are not valid under the current encoding rules. @@ -847,13 +847,13 @@ To be added. The next value does not have the correct tag. - + -or- - + The length encoding is not valid under the current encoding rules. - + -or- - + The contents are not valid under the current encoding rules. @@ -901,28 +901,28 @@ To be added. The next value does not have the correct tag. - + -or- - + The length encoding is not valid under the current encoding rules. - + -or- - + The contents are not valid under the current encoding rules. - + -or- - + The encoded value is too big to fit in a value. is not an enum type. - + -or- - + was not declared with - + -or- - + . is , but . is not correct for @@ -984,7 +984,7 @@ with bits increasing in value until the least significant bit of the first byte, proceeding with the most significant bit of the second byte, and so on. Under this scheme, the following ASN.1 type declaration and C# enumeration can be used together: - + KeyUsage ::= BIT STRING { digitalSignature (0), @@ -1012,7 +1012,7 @@ DecipherOnly = 1 << (8), } - + While the example here uses the KeyUsage NamedBitList from RFC 3280 (4.2.1.3), the example enum uses values that are different from @@ -1020,28 +1020,28 @@ The next value does not have the correct tag. - + -or- - + The length encoding is not valid under the current encoding rules. - + -or- - + The contents are not valid under the current encoding rules. - + -or- - + The encoded value is too big to fit in a value. is not an enum type. - + -or- - + was not declared with - + -or- - + . is , but . is not correct for @@ -1081,13 +1081,13 @@ To be added. The next value does not have the correct tag. - + -or- - + The length encoding is not valid under the current encoding rules. - + -or- - + The contents are not valid under the current encoding rules. @@ -1132,13 +1132,13 @@ To be added. The next value does not have the correct tag. - + -or- - + The length encoding is not valid under the current encoding rules. - + -or- - + The contents are not valid under the current encoding rules. @@ -1186,13 +1186,13 @@ The next value does not have the correct tag. - + -or- - + The length encoding is not valid under the current encoding rules. - + -or- - + The contents are not valid under the current encoding rules. @@ -1245,13 +1245,13 @@ The next value does not have the correct tag. - + -or- - + The length encoding is not valid under the current encoding rules. - + -or- - + The contents are not valid under the current encoding rules. @@ -1305,13 +1305,13 @@ The next value does not have the correct tag. - + -or- - + The length encoding is not valid under the current encoding rules. - + -or- - + The contents are not valid under the current encoding rules. @@ -1369,13 +1369,13 @@ The next value does not have the correct tag. - + -or- - + The length encoding is not valid under the current encoding rules. - + -or- - + The contents are not valid under the current encoding rules. @@ -1423,13 +1423,13 @@ To be added. The next value does not have the correct tag. - + -or- - + The length encoding is not valid under the current encoding rules. - + -or- - + The contents are not valid under the current encoding rules. @@ -1481,13 +1481,13 @@ The next value does not have the correct tag. - + -or- - + The length encoding is not valid under the current encoding rules. - + -or- - + The contents are not valid under the current encoding rules. @@ -1589,7 +1589,7 @@ The buffer in which to write. - On success, receives the number of bits in the last byte which were reported as + On success, receives the number of bits in the last byte that were reported as "unused" by the writer. @@ -1611,13 +1611,13 @@ The next value does not have the correct tag. - + -or- - + The length encoding is not valid under the current encoding rules. - + -or- - + The contents are not valid under the current encoding rules. @@ -1683,17 +1683,17 @@ The next value does not have the correct tag. - + -or- - + The length encoding is not valid under the current encoding rules. - + -or- - + The contents are not valid under the current encoding rules. - + -or- - + The string did not successfully decode. @@ -1752,13 +1752,13 @@ The next value does not have the correct tag. - + -or- - + The length encoding is not valid under the current encoding rules. - + -or- - + The contents are not valid under the current encoding rules. @@ -1812,13 +1812,13 @@ To be added. The next value does not have the correct tag. - + -or- - + The length encoding is not valid under the current encoding rules. - + -or- - + The contents are not valid under the current encoding rules. @@ -1871,13 +1871,13 @@ To be added. The next value does not have the correct tag. - + -or- - + The length encoding is not valid under the current encoding rules. - + -or- - + The contents are not valid under the current encoding rules. @@ -1933,13 +1933,13 @@ The next value does not have the correct tag. - + -or- - + The length encoding is not valid under the current encoding rules. - + -or- - + The contents are not valid under the current encoding rules. @@ -1977,7 +1977,7 @@ - On success, receives the number of bits in the last byte which were reported as + On success, receives the number of bits in the last byte that were reported as "unused" by the writer. @@ -1998,13 +1998,13 @@ To be added. The next value does not have the correct tag. - + -or- - + The length encoding is not valid under the current encoding rules. - + -or- - + The contents are not valid under the current encoding rules. @@ -2059,13 +2059,13 @@ The next value does not have the correct tag. - + -or- - + The length encoding is not valid under the current encoding rules. - + -or- - + The contents are not valid under the current encoding rules. @@ -2117,13 +2117,13 @@ To be added. The next value does not have the correct tag. - + -or- - + The length encoding is not valid under the current encoding rules. - + -or- - + The contents are not valid under the current encoding rules. @@ -2183,13 +2183,13 @@ To be added. The next value does not have the correct tag. - + -or- - + The length encoding is not valid under the current encoding rules. - + -or- - + The contents are not valid under the current encoding rules. @@ -2248,13 +2248,13 @@ To be added. The next value does not have the correct tag. - + -or- - + The length encoding is not valid under the current encoding rules. - + -or- - + The contents are not valid under the current encoding rules. diff --git a/xml/System.Formats.Asn1/AsnWriter.xml b/xml/System.Formats.Asn1/AsnWriter.xml index a0d4f2dea3b..b2cf15a6e1b 100644 --- a/xml/System.Formats.Asn1/AsnWriter.xml +++ b/xml/System.Formats.Asn1/AsnWriter.xml @@ -129,17 +129,17 @@ A or has not been closed via or . - + -or- - + This writer is empty. - + -or- - + This writer represents more than one top-level value. - + -or- - + This writer's value is encoded in a manner that is not compatible with the ruleset for the destination writer. @@ -626,7 +626,7 @@ Begin writing an Octet String value with a specified tag. - A disposable value which will automatically call . + A disposable value that will automatically call . This method is just an accelerator for writing an Octet String value where the @@ -668,7 +668,7 @@ Begin writing a Sequence with a specified tag. - A disposable value which will automatically call . + A disposable value that will automatically call . To be added. @@ -708,7 +708,7 @@ Begin writing a Set-Of with a specified tag. - A disposable value which will automatically call . + A disposable value that will automatically call . In and modes, @@ -863,13 +863,13 @@ , but . is not correct for the method. - + -or- - + has length 0 and is not 0 - + -or- - + is not empty and any of the bits identified by is set. @@ -956,9 +956,9 @@ To be added. is not a restricted character string encoding type. - + -or- - + is a restricted character string encoding type that is not currently supported by this method. @@ -1012,9 +1012,9 @@ is is not a restricted character string encoding type. - + -or- - + is a restricted character string encoding type that is not currently supported by this method. @@ -1061,9 +1061,9 @@ could not be read under the current encoding rules. - + -or- - + has data beyond the end of the first value. @@ -1108,13 +1108,13 @@ , but . is not correct for the method. - + -or- - + is not a boxed enum value. - + -or- - + the unboxed type of is declared []. @@ -1173,13 +1173,13 @@ , but . is not correct for the method. - + -or- - + is not an enum. - + -or- - + is declared []. @@ -1337,9 +1337,9 @@ To be added. The 9 most significant bits are all set. - + -or- - + The 9 most significant bits are all unset. @@ -1505,13 +1505,13 @@ , but . is not correct for the method. - + -or- - + is not a boxed enum value. - + -or- - + the unboxed type of is not declared []. @@ -1571,13 +1571,13 @@ , but . is not correct for the method. - + -or- - + is not an enum value. - + -or- - + is not declared []. @@ -1653,9 +1653,9 @@ , but . is not correct for the method. - + -or- - + is not a valid dotted decimal object identifier. @@ -1696,9 +1696,9 @@ , but . is not correct for the method. - + -or- - + is not a valid dotted decimal object identifier. diff --git a/xml/System.IO.Packaging/Package.xml b/xml/System.IO.Packaging/Package.xml index a218a197323..18c018732a6 100644 --- a/xml/System.IO.Packaging/Package.xml +++ b/xml/System.IO.Packaging/Package.xml @@ -80,7 +80,7 @@ A ("digital signature") is a composition of parts and relationships representing a digital signature included with a . The digital signature identifies the originator and validates that the signed parts and relationships contained in the have not been modified. - Packages also support Digital Rights Management (DRM) which allows content elements in a to be encrypted with specific access rights granted to authorized users. + Packages also support Digital Rights Management (DRM), which allows content elements in a to be encrypted with specific access rights granted to authorized users. Based on the architecture, an is a package type designed for storing documents based on the open [XML Paper Specification (XPS)](https://www.ecma-international.org/publications-and-standards/standards/ecma-388/). diff --git a/xml/System.IO.Packaging/ZipPackage.xml b/xml/System.IO.Packaging/ZipPackage.xml index 9e3e05a6451..ea7d4d473d0 100644 --- a/xml/System.IO.Packaging/ZipPackage.xml +++ b/xml/System.IO.Packaging/ZipPackage.xml @@ -57,7 +57,7 @@ The example creates a package that contains a single document part which is defined as the package's root element by a package-level . - The package also contains an image part and a second which defines an association between the source document part and the target image part. (The image is a resource that is used with the document). + The package also contains an image part and a second that defines an association between the source document part and the target image part. (The image is a resource that is used with the document). :::code language="csharp" source="~/snippets/csharp/System.IO.Packaging/Package/Overview/PackageWrite.cs" id="Snippetpackagewritecreatepackage"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/PackageWrite/visualbasic/packagewrite.vb" id="Snippetpackagewritecreatepackage"::: diff --git a/xml/System.IO/BufferedStream.xml b/xml/System.IO/BufferedStream.xml index 7fe99b5ea7a..c5388fdd3d0 100644 --- a/xml/System.IO/BufferedStream.xml +++ b/xml/System.IO/BufferedStream.xml @@ -424,7 +424,7 @@ The method to be called when the asynchronous write operation is completed. A user-provided object that distinguishes this particular asynchronous write request from other requests. Begins an asynchronous write operation. (Consider using instead.) - An object that references the asynchronous write which could still be pending. + An object that references the asynchronous write, which could still be pending. . diff --git a/xml/System.IO/EndOfStreamException.xml b/xml/System.IO/EndOfStreamException.xml index 248a3e2bbf9..21d2644f995 100644 --- a/xml/System.IO/EndOfStreamException.xml +++ b/xml/System.IO/EndOfStreamException.xml @@ -88,9 +88,7 @@ and classes on top of the class. diff --git a/xml/System.IO/FileNotFoundException.xml b/xml/System.IO/FileNotFoundException.xml index 2f8a46a63f9..887323800b5 100644 --- a/xml/System.IO/FileNotFoundException.xml +++ b/xml/System.IO/FileNotFoundException.xml @@ -82,7 +82,7 @@ diff --git a/xml/System.IO/IOException.xml b/xml/System.IO/IOException.xml index 86246feefde..199bd34919c 100644 --- a/xml/System.IO/IOException.xml +++ b/xml/System.IO/IOException.xml @@ -93,20 +93,14 @@ The Base Class Library includes the following types, each of which is a derived class of `IOException` : - - - - - - - - - Where appropriate, use these types instead of IOException. - uses the HRESULT COR_E_IO which has the value 0x80131620. - - + uses the HRESULT COR_E_IO, which has the value 0x80131620. ## Examples This code example is part of a larger example provided for the method. diff --git a/xml/System.IO/UnmanagedMemoryStream.xml b/xml/System.IO/UnmanagedMemoryStream.xml index a6c0bc5c715..62508619976 100644 --- a/xml/System.IO/UnmanagedMemoryStream.xml +++ b/xml/System.IO/UnmanagedMemoryStream.xml @@ -497,7 +497,7 @@ ## Examples - The following code example demonstrates how to read from and write to unmanaged memory using the class. A block of unmanaged memory is allocated and de-allocated using the class. In this example, an object is passed to a method which checks the property before attempting to display the contents to the console. + The following code example demonstrates how to read from and write to unmanaged memory using the class. A block of unmanaged memory is allocated and de-allocated using the class. In this example, an object is passed to a method that checks the property before attempting to display the contents to the console. :::code language="csharp" source="~/snippets/csharp/System.IO/UnmanagedMemoryStream/.ctor/program.cs" id="Snippet00"::: @@ -628,7 +628,7 @@ ## Examples - The following code example demonstrates how to read from and write to unmanaged memory using the class. A block of unmanaged memory is allocated and de-allocated using the class. In this example, an object is passed to a method which checks the property before attempting to write the data to the stream. + The following code example demonstrates how to read from and write to unmanaged memory using the class. A block of unmanaged memory is allocated and de-allocated using the class. In this example, an object is passed to a method that checks the property before attempting to write the data to the stream. :::code language="csharp" source="~/snippets/csharp/System.IO/UnmanagedMemoryStream/.ctor/program.cs" id="Snippet00"::: @@ -1579,7 +1579,7 @@ This method is equivalent to the class. A block of unmanaged memory is allocated and de-allocated using the class. In this example, an object is passed to a method which checks the property before attempting to read and display the contents to the console. + The following code example demonstrates how to read from and write to unmanaged memory using the class. A block of unmanaged memory is allocated and de-allocated using the class. In this example, an object is passed to a method that checks the property before attempting to read and display the contents to the console. :::code language="csharp" source="~/snippets/csharp/System.IO/UnmanagedMemoryStream/.ctor/program.cs" id="Snippet00"::: @@ -2067,7 +2067,7 @@ If an exception occurs during the write operation, it will be set as the class. A block of unmanaged memory is allocated and de-allocated using the class. In this example, an object is passed to a method which checks the property before attempting to write the data to the stream. + The following code example demonstrates how to read from and write to unmanaged memory using the class. A block of unmanaged memory is allocated and de-allocated using the class. In this example, an object is passed to a method that checks the property before attempting to write the data to the stream. :::code language="csharp" source="~/snippets/csharp/System.IO/UnmanagedMemoryStream/.ctor/program.cs" id="Snippet00"::: diff --git a/xml/System.Numerics.Tensors/TensorPrimitives.xml b/xml/System.Numerics.Tensors/TensorPrimitives.xml index e2f7c14604d..fad347dc4ce 100644 --- a/xml/System.Numerics.Tensors/TensorPrimitives.xml +++ b/xml/System.Numerics.Tensors/TensorPrimitives.xml @@ -3776,7 +3776,7 @@ This computes ( * ) as if to infinite precision, adds to that result as if to - infinite precision, and finally rounds to the nearest representable value. This differs from the non-fused sequence which would compute + infinite precision, and finally rounds to the nearest representable value. This differs from the non-fused sequence, which would compute ( * ) as if to infinite precision, round the result to the nearest representable value, add to the rounded result as if to infinite precision, and finally round to the nearest representable value. @@ -3857,7 +3857,7 @@ This computes ( * ) as if to infinite precision, adds to that result as if to - infinite precision, and finally rounds to the nearest representable value. This differs from the non-fused sequence which would compute + infinite precision, and finally rounds to the nearest representable value. This differs from the non-fused sequence, which would compute ( * ) as if to infinite precision, round the result to the nearest representable value, add to the rounded result as if to infinite precision, and finally round to the nearest representable value. @@ -3937,7 +3937,7 @@ This computes ( * ) as if to infinite precision, adds to that result as if to - infinite precision, and finally rounds to the nearest representable value. This differs from the non-fused sequence which would compute + infinite precision, and finally rounds to the nearest representable value. This differs from the non-fused sequence, which would compute ( * ) as if to infinite precision, round the result to the nearest representable value, add to the rounded result as if to infinite precision, and finally round to the nearest representable value. diff --git a/xml/System.Numerics/BigInteger.xml b/xml/System.Numerics/BigInteger.xml index 5b3e9622a8e..66342fdbb35 100644 --- a/xml/System.Numerics/BigInteger.xml +++ b/xml/System.Numerics/BigInteger.xml @@ -10846,7 +10846,7 @@ The following example calls the The type to which should be converted. - The value which is used to create the instance of . + The value that is used to create the instance of . When this method returns, contains an instance of converted from . Tries to convert an instance of the the current type to another type, throwing an overflow exception for any values that fall outside the representable range of the current type. @@ -10901,7 +10901,7 @@ The following example calls the The type to which should be converted. - The value which is used to create the instance of . + The value that is used to create the instance of . When this method returns, contains an instance of converted from . Tries to convert an instance of the the current type to another type, saturating any values that fall outside the representable range of the current type. @@ -10956,7 +10956,7 @@ The following example calls the The type to which should be converted. - The value which is used to create the instance of . + The value that is used to create the instance of . When this method returns, contains an instance of converted from . Tries to convert an instance of the the current type to another type, truncating any values that fall outside the representable range of the current type. diff --git a/xml/System.Numerics/BitOperations.xml b/xml/System.Numerics/BitOperations.xml index 6c5f3bde870..174aff938b3 100644 --- a/xml/System.Numerics/BitOperations.xml +++ b/xml/System.Numerics/BitOperations.xml @@ -1207,7 +1207,7 @@ If is 0 or the result overflows, returns 0. The value. Rounds the given integral value up to a power of 2. - The smallest power of 2 which is greater than or equal to . + The smallest power of 2 that is greater than or equal to . If is 0 or the result overflows, returns 0. To be added. diff --git a/xml/System.Numerics/Complex.xml b/xml/System.Numerics/Complex.xml index e307e7112f3..0161b179ee5 100644 --- a/xml/System.Numerics/Complex.xml +++ b/xml/System.Numerics/Complex.xml @@ -592,7 +592,7 @@ $(a + c) + bi$ A complex number. Returns the angle that is the arc sine of the specified complex number. - The angle which is the arc sine of . + The angle that is the arc sine of . The type to which should be converted. - The value which is used to create the instance of . + The value that is used to create the instance of . When this method returns, contains an instance of converted from . Tries to convert an instance of the the current type to another type, throwing an overflow exception for any values that fall outside the representable range of the current type. @@ -6426,7 +6426,7 @@ Languages that support custom operators can use the The type to which should be converted. - The value which is used to create the instance of . + The value that is used to create the instance of . When this method returns, contains an instance of converted from . Tries to convert an instance of the the current type to another type, saturating any values that fall outside the representable range of the current type. @@ -6481,7 +6481,7 @@ Languages that support custom operators can use the The type to which should be converted. - The value which is used to create the instance of . + The value that is used to create the instance of . When this method returns, contains an instance of converted from . Tries to convert an instance of the the current type to another type, truncating any values that fall outside the representable range of the current type. diff --git a/xml/System.Numerics/IAdditionOperators`3.xml b/xml/System.Numerics/IAdditionOperators`3.xml index 468f5f77ac6..12ca3cb36fe 100644 --- a/xml/System.Numerics/IAdditionOperators`3.xml +++ b/xml/System.Numerics/IAdditionOperators`3.xml @@ -75,7 +75,7 @@ The value to which is added. - The value which is added to . + The value that is added to . Adds two values together to compute their sum. The sum of and . To be added. @@ -105,7 +105,7 @@ The value to which is added. - The value which is added to . + The value that is added to . Adds two values together to compute their sum. The sum of and . To be added. diff --git a/xml/System.Numerics/IBinaryInteger`1.xml b/xml/System.Numerics/IBinaryInteger`1.xml index 10c2dc002e9..0ea06a7f3d6 100644 --- a/xml/System.Numerics/IBinaryInteger`1.xml +++ b/xml/System.Numerics/IBinaryInteger`1.xml @@ -156,8 +156,8 @@ - The value which divides. - The value which divides . + The value that divides. + The value that divides . Computes the quotient and remainder of two values. The quotient and remainder of divided by . To be added. @@ -506,7 +506,7 @@ - The value which is rotated left by . + The value that is rotated left by . The amount by which is rotated left. Rotates a value left by a given amount. The result of rotating left by . @@ -536,7 +536,7 @@ - The value which is rotated right by . + The value that is rotated right by . The amount by which is rotated right. Rotates a value right by a given amount. The result of rotating right by . diff --git a/xml/System.Numerics/IDivisionOperators`3.xml b/xml/System.Numerics/IDivisionOperators`3.xml index 209671a6eea..0a1cc5bc0f0 100644 --- a/xml/System.Numerics/IDivisionOperators`3.xml +++ b/xml/System.Numerics/IDivisionOperators`3.xml @@ -74,8 +74,8 @@ - The value which divides. - The value which divides . + The value that divides. + The value that divides . Divides two values together to compute their quotient. The quotient of divided by . To be added. @@ -105,8 +105,8 @@ - The value which divides. - The value which divides . + The value that divides. + The value that divides . Divides one value by another to compute their quotient. The quotient of divided by . To be added. diff --git a/xml/System.Numerics/IFloatingPointIeee754`1.xml b/xml/System.Numerics/IFloatingPointIeee754`1.xml index 28130766463..a4a5e415585 100644 --- a/xml/System.Numerics/IFloatingPointIeee754`1.xml +++ b/xml/System.Numerics/IFloatingPointIeee754`1.xml @@ -321,8 +321,8 @@ This computes `arctan(y / x) / π` in the interval `[-1, +1]`. - The value which multiplies. - The value which multiplies . + The value that multiplies. + The value that multiplies . The value that is added to the product of and . Computes the fused multiply-add of three values. The result of times plus computed as one ternary operation. @@ -352,8 +352,8 @@ This computes `arctan(y / x) / π` in the interval `[-1, +1]`. - The value which divides. - The value which divides . + The value that divides. + The value that divides . Computes the remainder of two values as specified by IEEE 754. The remainder of divided by as specified by IEEE 754. To be added. @@ -593,7 +593,7 @@ This computes `arctan(y / x) / π` in the interval `[-1, +1]`. - The value which base-radix raised to the power of multiplies. + The value that base-radix raised to the power of multiplies. The value to which base-radix is raised before multipliying . Computes the product of a value and its base-radix raised to the specified power. The product of and base-radix raised to the power of . diff --git a/xml/System.Numerics/IModulusOperators`3.xml b/xml/System.Numerics/IModulusOperators`3.xml index 5ce2095c705..b04873a15d1 100644 --- a/xml/System.Numerics/IModulusOperators`3.xml +++ b/xml/System.Numerics/IModulusOperators`3.xml @@ -68,8 +68,8 @@ This type represents the `%` operator in C#, which is often used to compute the - The value which divides. - The value which divides . + The value that divides. + The value that divides . Divides two values together to compute their modulus or remainder. The modulus or remainder of divided by . To be added. diff --git a/xml/System.Numerics/IMultiplyOperators`3.xml b/xml/System.Numerics/IMultiplyOperators`3.xml index 38f28383557..05eaaa123a7 100644 --- a/xml/System.Numerics/IMultiplyOperators`3.xml +++ b/xml/System.Numerics/IMultiplyOperators`3.xml @@ -74,8 +74,8 @@ - The value which multiplies. - The value which multiplies . + The value that multiplies. + The value that multiplies . Multiplies two values together to compute their product. The product of multiplied by . To be added. @@ -105,8 +105,8 @@ - The value which multiplies. - The value which multiplies . + The value that multiplies. + The value that multiplies . Multiplies two values together to compute their product. The product of multiplied by . To be added. diff --git a/xml/System.Numerics/INumberBase`1.xml b/xml/System.Numerics/INumberBase`1.xml index be4b62c40dc..705217c53a5 100644 --- a/xml/System.Numerics/INumberBase`1.xml +++ b/xml/System.Numerics/INumberBase`1.xml @@ -218,7 +218,7 @@ The type of . - The value which is used to create the instance of . + The value that is used to create the instance of . Creates an instance of the current type from a value, saturating any values that fall outside the representable range of the current type. An instance of created from , saturating if falls outside the representable range of . To be added. @@ -269,7 +269,7 @@ The type of . - The value which is used to create the instance of . + The value that is used to create the instance of . Creates an instance of the current type from a value, truncating any values that fall outside the representable range of the current type. An instance of created from , truncating if falls outside the representable range of . To be added. @@ -1472,7 +1472,7 @@ For this method matches the IEE The type of . - The value which is used to create the instance of . + The value that is used to create the instance of . When this method returns, contains an instance of converted from . Tries to convert a value to an instance of the the current type, saturating any values that fall outside the representable range of the current type. @@ -1529,7 +1529,7 @@ For this method matches the IEE The type of . - The value which is used to create the instance of . + The value that is used to create the instance of . When this method returns, contains an instance of converted from . Tries to convert a value to an instance of the the current type, truncating any values that fall outside the representable range of the current type. @@ -1586,7 +1586,7 @@ For this method matches the IEE The type to which should be converted. - The value which is used to create the instance of . + The value that is used to create the instance of . When this method returns, contains an instance of converted from . Tries to convert an instance of the the current type to another type, throwing an overflow exception for any values that fall outside the representable range of the current type. @@ -1645,7 +1645,7 @@ For this method matches the IEE The type to which should be converted. - The value which is used to create the instance of . + The value that is used to create the instance of . When this method returns, contains an instance of converted from . Tries to convert an instance of the the current type to another type, saturating any values that fall outside the representable range of the current type. @@ -1702,7 +1702,7 @@ For this method matches the IEE The type to which should be converted. - The value which is used to create the instance of . + The value that is used to create the instance of . When this method returns, contains an instance of converted from . Tries to convert an instance of the the current type to another type, truncating any values that fall outside the representable range of the current type. diff --git a/xml/System.Numerics/IPowerFunctions`1.xml b/xml/System.Numerics/IPowerFunctions`1.xml index 0c6fb04ca37..f6b52aff5dd 100644 --- a/xml/System.Numerics/IPowerFunctions`1.xml +++ b/xml/System.Numerics/IPowerFunctions`1.xml @@ -113,7 +113,7 @@ - The value which is raised to the power of . + The value that is raised to the power of . The power to which is raised. Computes a value raised to a given power. diff --git a/xml/System.Numerics/ISignedNumber`1.xml b/xml/System.Numerics/ISignedNumber`1.xml index 20b98d4873f..f488c9c2dad 100644 --- a/xml/System.Numerics/ISignedNumber`1.xml +++ b/xml/System.Numerics/ISignedNumber`1.xml @@ -86,7 +86,7 @@ The type that implements the interface. - Defines a number type which can represent both positive and negative values. + Defines a number type that can represent both positive and negative values. To be added. diff --git a/xml/System.Numerics/ISubtractionOperators`3.xml b/xml/System.Numerics/ISubtractionOperators`3.xml index 9dc93f1ca1a..ebf91c14321 100644 --- a/xml/System.Numerics/ISubtractionOperators`3.xml +++ b/xml/System.Numerics/ISubtractionOperators`3.xml @@ -75,7 +75,7 @@ The value from which is subtracted. - The value which is subtracted from . + The value that is subtracted from . Subtracts two values to compute their difference. The value of subtracted from . To be added. @@ -106,7 +106,7 @@ The value from which is subtracted. - The value which is subtracted from . + The value that is subtracted from . Subtracts two values to compute their difference. The value of subtracted from . To be added. diff --git a/xml/System.Numerics/Vector.xml b/xml/System.Numerics/Vector.xml index a14193d43e7..5c02ac9f7a9 100644 --- a/xml/System.Numerics/Vector.xml +++ b/xml/System.Numerics/Vector.xml @@ -3931,7 +3931,7 @@ Note that this method returns a instead of an integral type ( * ) + , rounded as one ternary operation. This computes ( * ) as if to infinite precision, adds to that result as if to infinite precision, and finally rounds to the nearest representable value. - This differs from the non-fused sequence which would compute ( * ) as if to infinite precision, round the result to the nearest representable value, add to the rounded result as if to infinite precision, and finally round to the nearest representable value. + This differs from the non-fused sequence, which would compute ( * ) as if to infinite precision, round the result to the nearest representable value, add to the rounded result as if to infinite precision, and finally round to the nearest representable value. @@ -3967,7 +3967,7 @@ Note that this method returns a instead of an integral type ( * ) + , rounded as one ternary operation. This computes ( * ) as if to infinite precision, adds to that result as if to infinite precision, and finally rounds to the nearest representable value. - This differs from the non-fused sequence which would compute ( * ) as if to infinite precision, round the result to the nearest representable value, add to the rounded result as if to infinite precision, and finally round to the nearest representable value. + This differs from the non-fused sequence, which would compute ( * ) as if to infinite precision, round the result to the nearest representable value, add to the rounded result as if to infinite precision, and finally round to the nearest representable value. diff --git a/xml/System/AggregateException.xml b/xml/System/AggregateException.xml index 7f3cda79a7e..c8ade762787 100644 --- a/xml/System/AggregateException.xml +++ b/xml/System/AggregateException.xml @@ -808,7 +808,7 @@ was handled. After all invocations, if any exceptions went unhandled, all unhandled exceptions will be put into a new which will be thrown. Otherwise, the method simply returns. If any invocations of the `predicate` throws an exception, it will halt the processing of any more exceptions and immediately propagate the thrown exception as-is. + Each invocation of the `predicate` returns true or false to indicate whether the was handled. After all invocations, any unhandled exceptions are put into a new that will be thrown. If there are no unhandled exceptions, the method simply returns. If any invocations of the `predicate` throws an exception, it will halt the processing of any more exceptions and immediately propagate the thrown exception as-is. ## Examples Ordinarily, an exception handler that catches an exception uses a `foreach` loop (in C#) or `For Each` loop (in Visual Basic) to handle each exception in its collection. Instead, the following example uses the method to handle each exception, and only rethrows exceptions that are not `CustomException` instances. diff --git a/xml/System/Byte.xml b/xml/System/Byte.xml index c9d9e4f2492..6ead0efb039 100644 --- a/xml/System/Byte.xml +++ b/xml/System/Byte.xml @@ -700,8 +700,8 @@ - The value which divides. - The value which divides . + The value that divides. + The value that divides . Computes the quotient and remainder of two values. The quotient and remainder of divided-by . To be added. @@ -2143,7 +2143,7 @@ For , this method matches the IEEE 754: - The value which is rotated left by . + The value that is rotated left by . The amount by which is rotated left. Rotates a value left by a given amount. The result of rotating left by . @@ -2183,7 +2183,7 @@ For , this method matches the IEEE 754: - The value which is rotated right by . + The value that is rotated right by . The amount by which is rotated right. Rotates a value right by a given amount. The result of rotating right by . diff --git a/xml/System/CharEnumerator.xml b/xml/System/CharEnumerator.xml index 4fb2339c1ee..1709d852659 100644 --- a/xml/System/CharEnumerator.xml +++ b/xml/System/CharEnumerator.xml @@ -76,40 +76,40 @@ Supports iterating over a object and reading its individual characters. This class cannot be inherited. - provides read-only access to the characters in a referenced object. For example, the `foreach` statement of the Microsoft Visual Basic and C# programming languages, which iterates through the elements of a collection, retrieves a from a object in order to iterate through the characters in that object. + provides read-only access to the characters in a referenced object. For example, the `foreach` statement of the Microsoft Visual Basic and C# programming languages, which iterates through the elements of a collection, retrieves a from a object in order to iterate through the characters in that object. > [!IMPORTANT] > The `CharEnumerator` class enumerates individual 16-bit instances. It does not consider graphemes (that is, a character followed by one or more combiding characters) or surrogate pairs (that is, characters outside the Unicode Basic Multilingual Plane) as single characters. For an enumerator that handles these types of characters as a single unit, use the class. - There is no public constructor for . Instead, call a object's method to obtain a that is initialized to reference the string. - - A maintains an internal index to the characters in the string the references. The state of the index is invalid when it references a character position logically before the first character or after the last character in the string, and valid when it references a character within the string. The index is initialized to a position logically before the first character, and is set to a position after the last character when the iteration is complete. An exception is thrown if you attempt to access a character while the index is invalid. - - The method increments the index by one, so the first and subsequent characters are accessed in turn. The method sets the index to a position logically before the first character. The property retrieves the character currently referenced by index. The method creates a copy of the . - + There is no public constructor for . Instead, call a object's method to obtain a that is initialized to reference the string. + + A maintains an internal index to the characters in the string the references. The state of the index is invalid when it references a character position logically before the first character or after the last character in the string, and valid when it references a character within the string. The index is initialized to a position logically before the first character, and is set to a position after the last character when the iteration is complete. An exception is thrown if you attempt to access a character while the index is invalid. + + The method increments the index by one, so the first and subsequent characters are accessed in turn. The method sets the index to a position logically before the first character. The property retrieves the character currently referenced by index. The method creates a copy of the . + > [!NOTE] -> Several independent instances of across one or more threads can have access to a single instance of . This class is implemented to support the interface. For more information regarding the use of an enumerator, see the topic. - - - -## Examples - The following example uses the class to enumerate the individual characters in a string. It instantiates a object by calling the method, moves from one character to the next by calling the method, and displays the current character by retrieving the value of the property. - +> Several independent instances of across one or more threads can have access to a single instance of . This class is implemented to support the interface. For more information regarding the use of an enumerator, see the topic. + + + +## Examples + The following example uses the class to enumerate the individual characters in a string. It instantiates a object by calling the method, moves from one character to the next by calling the method, and displays the current character by retrieving the value of the property. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR_System/system.CharEnumerator.Class/cpp/charenumerator1.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System/CharEnumerator/Overview/CharEnumerator1.cs" id="Snippet1"::: :::code language="fsharp" source="~/snippets/fsharp/VS_Snippets_CLR_System/system.CharEnumerator.Class/fs/CharEnumerator1.fs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.CharEnumerator.Class/vb/CharEnumerator1.vb" id="Snippet1"::: - - Note, however, that the same operation can be performed somewhat more intuitively by using `foreach` (in C#) or `For Each` (in Visual Basic), as the following example shows. - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.CharEnumerator.Class/vb/CharEnumerator1.vb" id="Snippet1"::: + + Note, however, that the same operation can be performed somewhat more intuitively by using `foreach` (in C#) or `For Each` (in Visual Basic), as the following example shows. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR_System/system.CharEnumerator.Class/cpp/charenumerator1.cpp" id="Snippet2"::: :::code language="csharp" source="~/snippets/csharp/System/CharEnumerator/Overview/CharEnumerator1.cs" id="Snippet2"::: :::code language="fsharp" source="~/snippets/fsharp/VS_Snippets_CLR_System/system.CharEnumerator.Class/fs/CharEnumerator1.fs" id="Snippet2"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.CharEnumerator.Class/vb/CharEnumerator1.vb" id="Snippet2"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.CharEnumerator.Class/vb/CharEnumerator1.vb" id="Snippet2"::: + ]]> @@ -167,18 +167,18 @@ Creates a copy of the current object. An that is a copy of the current object. - and its current state. This is useful for saving your state while iterating through a object. - - For example, suppose your application uses an original instance of to iterate through each character in a . When some unique character is encountered, your application pauses processing and invokes the method. In effect, this saves the object's index in the . - - Your application uses the clone to navigate to another part of the `String` to perform some auxiliary processing. The side-effect of this navigation is the clone loses track of the position where processing stopped. However, when the auxiliary processing is complete, your application discards the clone and uses the original instance to resume working on the where the original processing stopped. - + and its current state. This is useful for saving your state while iterating through a object. + + For example, suppose your application uses an original instance of to iterate through each character in a . When some unique character is encountered, your application pauses processing and invokes the method. In effect, this saves the object's index in the . + + Your application uses the clone to navigate to another part of the `String` to perform some auxiliary processing. The side-effect of this navigation is the clone loses track of the position where processing stopped. However, when the auxiliary processing is complete, your application discards the clone and uses the original instance to resume working on the where the original processing stopped. + > [!NOTE] -> This method is implemented to support the interface. - +> This method is implemented to support the interface. + ]]> @@ -225,32 +225,32 @@ Gets the currently referenced character in the string enumerated by this object. The Unicode character currently referenced by this object. - class maintains an internal index to the enumerated string, and the property returns the character that is currently referenced by the index. This property should be invoked only when the index is valid; otherwise, an exception is thrown. - - The index is always invalid for an empty string (""). The index is also invalid after the or method is called. After either of these methods is called, invoke the method to adjust the index to the first character in the enumerated string. The index is valid whenever the method returns `true`. - - does not move the index, and consecutive calls to return the same character until , , or is called. - - - -## Examples - The following example uses the class to enumerate the individual characters in a string. It instantiates a object by calling the method, moves from one character to the next by calling the method, and displays the current character by retrieving the value of the property. - + class maintains an internal index to the enumerated string, and the property returns the character that is currently referenced by the index. This property should be invoked only when the index is valid; otherwise, an exception is thrown. + + The index is always invalid for an empty string (""). The index is also invalid after the or method is called. After either of these methods is called, invoke the method to adjust the index to the first character in the enumerated string. The index is valid whenever the method returns `true`. + + does not move the index, and consecutive calls to return the same character until , , or is called. + + + +## Examples + The following example uses the class to enumerate the individual characters in a string. It instantiates a object by calling the method, moves from one character to the next by calling the method, and displays the current character by retrieving the value of the property. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR_System/system.CharEnumerator.Class/cpp/charenumerator1.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System/CharEnumerator/Overview/CharEnumerator1.cs" id="Snippet1"::: :::code language="fsharp" source="~/snippets/fsharp/VS_Snippets_CLR_System/system.CharEnumerator.Class/fs/CharEnumerator1.fs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.CharEnumerator.Class/vb/CharEnumerator1.vb" id="Snippet1"::: - - Note, however, that the same operation can be performed somewhat more intuitively by using `foreach` (in C#) or `For Each` (in Visual Basic), as the following example shows. - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.CharEnumerator.Class/vb/CharEnumerator1.vb" id="Snippet1"::: + + Note, however, that the same operation can be performed somewhat more intuitively by using `foreach` (in C#) or `For Each` (in Visual Basic), as the following example shows. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR_System/system.CharEnumerator.Class/cpp/charenumerator1.cpp" id="Snippet2"::: :::code language="csharp" source="~/snippets/csharp/System/CharEnumerator/Overview/CharEnumerator1.cs" id="Snippet2"::: :::code language="fsharp" source="~/snippets/fsharp/VS_Snippets_CLR_System/system.CharEnumerator.Class/fs/CharEnumerator1.fs" id="Snippet2"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.CharEnumerator.Class/vb/CharEnumerator1.vb" id="Snippet2"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.CharEnumerator.Class/vb/CharEnumerator1.vb" id="Snippet2"::: + ]]> The index is invalid; that is, it is before the first or after the last character of the enumerated string. @@ -296,16 +296,16 @@ Releases all resources used by the current instance of the class. - when you are finished using the . The method leaves the in an unusable state. After calling , you must release all references to the so the garbage collector can reclaim the memory that the was occupying. - - For more information, see [Cleaning Up Unmanaged Resources](/dotnet/standard/garbage-collection/unmanaged) and [Implementing a Dispose Method](/dotnet/standard/garbage-collection/implementing-dispose). - + when you are finished using the . The method leaves the in an unusable state. After calling , you must release all references to the so the garbage collector can reclaim the memory that the was occupying. + + For more information, see [Cleaning Up Unmanaged Resources](/dotnet/standard/garbage-collection/unmanaged) and [Implementing a Dispose Method](/dotnet/standard/garbage-collection/implementing-dispose). + > [!NOTE] -> Always call before you release your last reference to the . Otherwise, the resources it is using will not be freed until the garbage collector calls the object's `Finalize` method. - +> Always call before you release your last reference to the . Otherwise, the resources it is using will not be freed until the garbage collector calls the object's `Finalize` method. + ]]> @@ -354,32 +354,30 @@ if the index is successfully incremented and within the enumerated string; otherwise, . - class maintains an internal index to the enumerated string, and the method increments the index by one. Call after calling or to increment the current character position to the first character in the enumerated string. Check that the return value is `true` to determine that the current character position is valid. - - If the index is already beyond the last character of the enumerated string, the index is not changed and `false` is returned. - - Notice that if the enumerated string is empty (""), the state of the is always invalid. This is because the internal index for the is initially before the first character of the enumerated string and is therefore invalid. logically sets the index after the last (nonexistent) character of the enumerated string which is also invalid. - - - -## Examples - The following example uses the class to enumerate the individual characters in a string. It instantiates a object by calling the method, moves from one character to the next by calling the method, and displays the current character by retrieving the value of the property. - + class maintains an internal index to the enumerated string, and the method increments the index by one. Call after calling or to increment the current character position to the first character in the enumerated string. Check that the return value is `true` to determine that the current character position is valid. + + If the index is already beyond the last character of the enumerated string, the index is not changed and `false` is returned. + + Notice that if the enumerated string is empty (""), the state of the is always invalid. This is because the internal index for the is initially before the first character of the enumerated string and is therefore invalid. logically sets the index after the last (nonexistent) character of the enumerated string, which is also invalid. + +## Examples + The following example uses the class to enumerate the individual characters in a string. It instantiates a object by calling the method, moves from one character to the next by calling the method, and displays the current character by retrieving the value of the property. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR_System/system.CharEnumerator.Class/cpp/charenumerator1.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System/CharEnumerator/Overview/CharEnumerator1.cs" id="Snippet1"::: :::code language="fsharp" source="~/snippets/fsharp/VS_Snippets_CLR_System/system.CharEnumerator.Class/fs/CharEnumerator1.fs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.CharEnumerator.Class/vb/CharEnumerator1.vb" id="Snippet1"::: - - Note, however, that the same operation can be performed somewhat more intuitively by using `foreach` (in C#) or `For Each` (in Visual Basic), as the following example shows. - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.CharEnumerator.Class/vb/CharEnumerator1.vb" id="Snippet1"::: + + Note, however, that the same operation can be performed somewhat more intuitively by using `foreach` (in C#) or `For Each` (in Visual Basic), as the following example shows. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR_System/system.CharEnumerator.Class/cpp/charenumerator1.cpp" id="Snippet2"::: :::code language="csharp" source="~/snippets/csharp/System/CharEnumerator/Overview/CharEnumerator1.cs" id="Snippet2"::: :::code language="fsharp" source="~/snippets/fsharp/VS_Snippets_CLR_System/system.CharEnumerator.Class/fs/CharEnumerator1.fs" id="Snippet2"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.CharEnumerator.Class/vb/CharEnumerator1.vb" id="Snippet2"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.CharEnumerator.Class/vb/CharEnumerator1.vb" id="Snippet2"::: + ]]> @@ -426,11 +424,11 @@ Initializes the index to a position logically before the first character of the enumerated string. - class maintains an internal index to the enumerated string, and the method sets the index to the invalid state. - + class maintains an internal index to the enumerated string, and the method sets the index to the invalid state. + ]]> @@ -484,17 +482,17 @@ Gets the currently referenced character in the string enumerated by this object. For a description of this member, see . The boxed Unicode character currently referenced by this object. - instance is cast to an interface. - + instance is cast to an interface. + ]]> - Enumeration has not started. - - -or- - + Enumeration has not started. + + -or- + Enumeration has ended. @@ -528,7 +526,7 @@ class. The method leaves the class in an unusable state. After calling it, you must release all references to the class so the garbage collector can reclaim the memory that the class was occupying. For more information, see [Cleaning Up Unmanaged Resources](/dotnet/standard/garbage-collection/unmanaged) and [Implementing a Dispose Method](/dotnet/standard/garbage-collection/implementing-dispose). diff --git a/xml/System/ContextMarshalException.xml b/xml/System/ContextMarshalException.xml index 96375ac616d..4718ae68505 100644 --- a/xml/System/ContextMarshalException.xml +++ b/xml/System/ContextMarshalException.xml @@ -72,17 +72,17 @@ The exception that is thrown when an attempt to marshal an object across a context boundary fails. - . - - uses the HRESULT COR_E_CONTEXTMARSHAL which has the value 0x80131504L. - - uses the default implementation, which supports reference equality. - - For a list of initial property values for an instance of , see the constructors. - + . + + uses the HRESULT COR_E_CONTEXTMARSHAL, which has the value 0x80131504L. + + uses the default implementation, which supports reference equality. + + For a list of initial property values for an instance of , see the constructors. + ]]> @@ -137,16 +137,16 @@ Initializes a new instance of the class with default properties. - . - -|Property|Value| -|--------------|-----------| -||`null`.| -||The empty string ("").| - + . + +|Property|Value| +|--------------|-----------| +||`null`.| +||The empty string ("").| + ]]> @@ -194,16 +194,16 @@ The error message that explains the reason for the exception. Initializes a new instance of the class with a specified error message. - . - -|Property|Value| -|--------------|-----------| -||`null`.| -||The error message string.| - + . + +|Property|Value| +|--------------|-----------| +||`null`.| +||The error message string.| + ]]> @@ -313,18 +313,18 @@ The exception that is the cause of the current exception. If the parameter is not , the current exception is raised in a block that handles the inner exception. Initializes a new instance of the class with a specified error message and a reference to the inner exception that is the cause of this exception. - property. The property returns the same value that is passed into the constructor, or `null` if the property does not supply the inner exception value to the constructor. - - The following table shows the initial property values for an instance of . - -|Property|Value| -|--------------|-----------| -||The inner exception reference.| -||The error message string.| - + property. The property returns the same value that is passed into the constructor, or `null` if the property does not supply the inner exception value to the constructor. + + The following table shows the initial property values for an instance of . + +|Property|Value| +|--------------|-----------| +||The inner exception reference.| +||The error message string.| + ]]> diff --git a/xml/System/DateTime.xml b/xml/System/DateTime.xml index d7f38a56994..d32f7cd66f9 100644 --- a/xml/System/DateTime.xml +++ b/xml/System/DateTime.xml @@ -8087,7 +8087,7 @@ In general, the ticks represent the time according to the time zone specified by property. which returns a value that represents a date without its time component, the property returns a value that represents a value's time component. + Unlike the property, which returns a value that represents a date without its time component, the property returns a value that represents a value's time component. If you want to display the time of day or retrieve the string representation of the time of day of a value, you can instead call an overload of the method that has a `format` parameter or use the [composite formatting](/dotnet/standard/base-types/composite-formatting) feature with the "t" or "T" standard format string. @@ -8271,9 +8271,7 @@ In general, the ticks represent the time according to the time zone specified by ## Remarks A Windows file time is a 64-bit value that represents the number of 100-nanosecond intervals that have elapsed since 12:00 midnight, January 1, 1601 A.D. (C.E.) Coordinated Universal Time (UTC). Windows uses a file time to record when an application creates, accesses, or writes to a file. - The method uses the property to determine whether the current object is a local time, a UTC time, or an unspecified kind of time which is treated as a local time. - - + The method uses the property to determine whether the current object is a local time, a UTC time, or an unspecified kind of time, which is treated as a local time. ## Examples The following example demonstrates the method. @@ -8354,7 +8352,7 @@ In general, the ticks represent the time according to the time zone specified by ## Remarks A Windows file time is a 64-bit value that represents the number of 100-nanosecond intervals that have elapsed since 12:00 midnight, January 1, 1601 A.D. (C.E.) Coordinated Universal Time (UTC). Windows uses a file time to record when an application creates, accesses, or writes to a file. - The method uses the property to determine whether the current object is a local time, a UTC time, or an unspecified kind of time which is treated as a UTC time. If it is a local time, it converts the time to UTC before performing the conversion to a Windows file time. + The method uses the property to determine whether the current object is a local time, a UTC time, or an unspecified kind of time, which is treated as a UTC time. If it is a local time, it converts the time to UTC before performing the conversion to a Windows file time. ]]> diff --git a/xml/System/Double.xml b/xml/System/Double.xml index dbf37567645..293b2c4162a 100644 --- a/xml/System/Double.xml +++ b/xml/System/Double.xml @@ -2257,8 +2257,8 @@ Euler's number is approximately 2.7182818284590452354. - The value which multiplies. - The value which multiplies . + The value that multiplies. + The value that multiplies . The value that is added to the product of and . Computes the fused multiply-add of three values. The result of times plus computed as one ternary operation. @@ -2436,8 +2436,8 @@ Euler's number is approximately 2.7182818284590452354. - The value which divides. - The value which divides . + The value that divides. + The value that divides . Computes the remainder of two values as specified by IEEE 754. The remainder of divided-by as specified by IEEE 754. To be added. @@ -5643,7 +5643,7 @@ The following code example illustrates the use of - The value which is raised to the power of . + The value that is raised to the power of . The power to which is raised. Computes a value raised to a given power. @@ -5997,7 +5997,7 @@ The following code example illustrates the use of - The value which base-radix raised to the power of multiplies. + The value that base-radix raised to the power of multiplies. The value to which base-radix is raised before multipliying . Computes the product of a value and its base-radix raised to the specified power. The product of and base-radix raised to the power of . diff --git a/xml/System/Guid.xml b/xml/System/Guid.xml index f35e4914c8d..0a122a61ed4 100644 --- a/xml/System/Guid.xml +++ b/xml/System/Guid.xml @@ -1180,7 +1180,7 @@ On non-Windows platforms, starting with .NET 6, this function calls the OS's underlying cryptographically secure pseudo-random number generator (CSPRNG) to generate 122 bits of strong entropy. In previous versions of .NET, the entropy is not guaranteed to be generated by a CSPRNG. - It is recommended that applications __not__ use the _NewGuid_ method for cryptographic purposes. First, since a Version 4 UUID has a partially predictable bit pattern, the _NewGuid_ function cannot serve as a proper cryptographic pseudo-random function (PRF). If the output of _NewGuid_ is given to a cryptographic component which requires its input to be generated by a proper PRF, the cryptographic component may not be able to maintain its security properties. Second, _NewGuid_ utilizes at most 122 bits of entropy, regardless of platform. Some cryptographic components set a minimum entropy level on their inputs as a matter of policy. Such policies often set the minimum entropy level at 128 bits or higher. Passing the output of _NewGuid_ to such a routine may violate its policy. + It is recommended that applications __not__ use the _NewGuid_ method for cryptographic purposes. First, since a Version 4 UUID has a partially predictable bit pattern, the _NewGuid_ function cannot serve as a proper cryptographic pseudo-random function (PRF). If the output of _NewGuid_ is given to a cryptographic component that requires its input to be generated by a proper PRF, the cryptographic component may not be able to maintain its security properties. Second, _NewGuid_ utilizes at most 122 bits of entropy, regardless of platform. Some cryptographic components set a minimum entropy level on their inputs as a matter of policy. Such policies often set the minimum entropy level at 128 bits or higher. Passing the output of _NewGuid_ to such a routine may violate its policy. If an application requires random data for cryptographic purposes, consider using a static method on the class. That class provides a random number generator suitable for cryptographic use. diff --git a/xml/System/Half.xml b/xml/System/Half.xml index 30c7694f61e..67f2c3d18a4 100644 --- a/xml/System/Half.xml +++ b/xml/System/Half.xml @@ -1315,7 +1315,7 @@ This computes `cos(x * π)`. The type of . - The value which is used to create the instance of . + The value that is used to create the instance of . Creates an instance of the current type from a value, saturating any values that fall outside the representable range of the current type. An instance of created from , saturating if falls outside the representable range of . To be added. @@ -1361,7 +1361,7 @@ This computes `cos(x * π)`. The type of . - The value which is used to create the instance of . + The value that is used to create the instance of . Creates an instance of the current type from a value, truncating any values that fall outside the representable range of the current type. An instance of created from , truncating if falls outside the representable range of . To be added. @@ -1791,8 +1791,8 @@ This computes `cos(x * π)`. - The value which multiplies. - The value which multiplies . + The value that multiplies. + The value that multiplies . The value that is added to the product of and . Computes the fused multiply-add of three values. The result of times plus computed as one ternary operation. @@ -1887,8 +1887,8 @@ This computes `cos(x * π)`. - The value which divides. - The value which divides . + The value that divides. + The value that divides . Computes the remainder of two values as specified by IEEE 754. The remainder of divided-by as specified by IEEE 754. To be added. @@ -3417,7 +3417,7 @@ For this method matches the IEEE 754:2 The value to which is added. - The value which is added to . + The value that is added to . Adds two values together to compute their sum. The sum of and . To be added. @@ -3510,8 +3510,8 @@ For this method matches the IEEE 754:2 - The value which divides. - The value which divides . + The value that divides. + The value that divides . Divides two values together to compute their quotient. The quotient of divided-by . To be added. @@ -4744,8 +4744,8 @@ For this method matches the IEEE 754:2 - The value which divides. - The value which divides . + The value that divides. + The value that divides . Divides two values together to compute their modulus or remainder. The modulus or remainder of divided-by . To be added. @@ -4778,8 +4778,8 @@ For this method matches the IEEE 754:2 - The value which multiplies. - The value which multiplies . + The value that multiplies. + The value that multiplies . Multiplies two values together to compute their product. The product of multiplied-by . To be added. @@ -4813,7 +4813,7 @@ For this method matches the IEEE 754:2 The value from which is subtracted. - The value which is subtracted from . + The value that is subtracted from . Subtracts two values to compute their difference. The difference of subtracted from . To be added. @@ -5328,7 +5328,7 @@ For this method matches the IEEE 754:2 - The value which is raised to the power of . + The value that is raised to the power of . The power to which is raised. Computes a value raised to a given power. @@ -5628,7 +5628,7 @@ For this method matches the IEEE 754:2 - The value which base-radix raised to the power of multiplies. + The value that base-radix raised to the power of multiplies. The value to which base-radix is raised before multipliying . Computes the product of a value and its base-radix raised to the specified power. The product of and base-radix raised to the power of . diff --git a/xml/System/Int128.xml b/xml/System/Int128.xml index 2991d58b598..f0b6f4ba8b7 100644 --- a/xml/System/Int128.xml +++ b/xml/System/Int128.xml @@ -519,7 +519,7 @@ The type of . - The value which is used to create the instance of . + The value that is used to create the instance of . Creates an instance of the current type from a value, saturating any values that fall outside the representable range of the current type. An instance of created from , saturating if falls outside the representable range of . To be added. @@ -565,7 +565,7 @@ The type of . - The value which is used to create the instance of . + The value that is used to create the instance of . Creates an instance of the current type from a value, truncating any values that fall outside the representable range of the current type. An instance of created from , truncating if falls outside the representable range of . To be added. @@ -604,8 +604,8 @@ - The value which divides. - The value which divides . + The value that divides. + The value that divides . Computes the quotient and remainder of two values. The quotient and remainder of divided-by . To be added. @@ -1284,7 +1284,7 @@ For this method matches the IEE The value to which is added. - The value which is added to . + The value that is added to . Adds two values together to compute their sum. The sum of and . To be added. @@ -1386,7 +1386,7 @@ For this method matches the IEE The value to which is added. - The value which is added to . + The value that is added to . Adds two values together to compute their sum. The sum of and . To be added. @@ -1451,8 +1451,8 @@ For this method matches the IEE - The value which divides. - The value which divides . + The value that divides. + The value that divides . Divides two values together to compute their quotient. The quotient of divided-by . To be added. @@ -1601,8 +1601,8 @@ For this method matches the IEE - The value which multiplies. - The value which multiplies . + The value that multiplies. + The value that multiplies . Multiplies two values together to compute their product. The product of multiplied-by . To be added. @@ -1636,7 +1636,7 @@ For this method matches the IEE The value from which is subtracted. - The value which is subtracted from . + The value that is subtracted from . Subtracts two values to compute their difference. The difference of subtracted from . To be added. @@ -1733,8 +1733,8 @@ For this method matches the IEE - The value which divides. - The value which divides . + The value that divides. + The value that divides . Divides two values together to compute their quotient. The quotient of divided-by . To be added. @@ -3013,8 +3013,8 @@ For this method matches the IEE - The value which divides. - The value which divides . + The value that divides. + The value that divides . Divides two values together to compute their modulus or remainder. The modulus or remainder of divided-by . To be added. @@ -3047,8 +3047,8 @@ For this method matches the IEE - The value which multiplies. - The value which multiplies . + The value that multiplies. + The value that multiplies . Multiplies two values together to compute their product. The product of multiplied-by . To be added. @@ -3156,7 +3156,7 @@ This operation is meant to perform a signed (otherwise known as an arithmetic) r The value from which is subtracted. - The value which is subtracted from . + The value that is subtracted from . Subtracts two values to compute their difference. The difference of subtracted from . To be added. @@ -3630,7 +3630,7 @@ This operation is meant to perform n unsigned (otherwise known as a logical) rig - The value which is rotated left by . + The value that is rotated left by . The amount by which is rotated left. Rotates a value left by a given amount. The result of rotating left by . @@ -3664,7 +3664,7 @@ This operation is meant to perform n unsigned (otherwise known as a logical) rig - The value which is rotated right by . + The value that is rotated right by . The amount by which is rotated right. Rotates a value right by a given amount. The result of rotating right by . diff --git a/xml/System/Int16.xml b/xml/System/Int16.xml index 9df301eb024..2cb4ead33e1 100644 --- a/xml/System/Int16.xml +++ b/xml/System/Int16.xml @@ -776,8 +776,8 @@ - The value which divides. - The value which divides . + The value that divides. + The value that divides . Computes the quotient and remainder of two values. The quotient and remainder of divided-by . To be added. @@ -2408,7 +2408,7 @@ For this method matches the IEE - The value which is rotated left by . + The value that is rotated left by . The amount by which is rotated left. Rotates a value left by a given amount. The result of rotating left by . @@ -2448,7 +2448,7 @@ For this method matches the IEE - The value which is rotated right by . + The value that is rotated right by . The amount by which is rotated right. Rotates a value right by a given amount. The result of rotating right by . diff --git a/xml/System/Int32.xml b/xml/System/Int32.xml index dbe8345f4d7..940abb3035a 100644 --- a/xml/System/Int32.xml +++ b/xml/System/Int32.xml @@ -804,8 +804,8 @@ - The value which divides. - The value which divides . + The value that divides. + The value that divides . Computes the quotient and remainder of two values. The quotient and remainder of divided-by . To be added. @@ -2471,7 +2471,7 @@ For this method matches the IEE - The value which is rotated left by . + The value that is rotated left by . The amount by which is rotated left. Rotates a value left by a given amount. The result of rotating left by . @@ -2511,7 +2511,7 @@ For this method matches the IEE - The value which is rotated right by . + The value that is rotated right by . The amount by which is rotated right. Rotates a value right by a given amount. The result of rotating right by . diff --git a/xml/System/Int64.xml b/xml/System/Int64.xml index 547fa606502..302bdc15cd7 100644 --- a/xml/System/Int64.xml +++ b/xml/System/Int64.xml @@ -798,8 +798,8 @@ - The value which divides. - The value which divides . + The value that divides. + The value that divides . Computes the quotient and remainder of two values. The quotient and remainder of divided-by . To be added. @@ -2405,7 +2405,7 @@ For this method matches the IEE - The value which is rotated left by . + The value that is rotated left by . The amount by which is rotated left. Rotates a value left by a given amount. The result of rotating left by . @@ -2445,7 +2445,7 @@ For this method matches the IEE - The value which is rotated right by . + The value that is rotated right by . The amount by which is rotated right. Rotates a value right by a given amount. The result of rotating right by . diff --git a/xml/System/IntPtr.xml b/xml/System/IntPtr.xml index 49597e2da6d..1c2a467ba5d 100644 --- a/xml/System/IntPtr.xml +++ b/xml/System/IntPtr.xml @@ -905,7 +905,7 @@ The type of . - The value which is used to create the instance of . + The value that is used to create the instance of . Creates an instance of the current type from a value, saturating any values that fall outside the representable range of the current type. An instance of created from , saturating if falls outside the representable range of . To be added. @@ -957,7 +957,7 @@ The type of . - The value which is used to create the instance of . + The value that is used to create the instance of . Creates an instance of the current type from a value, truncating any values that fall outside the representable range of the current type. An instance of created from , truncating if falls outside the representable range of . To be added. @@ -1002,8 +1002,8 @@ - The value which divides. - The value which divides . + The value that divides. + The value that divides . Computes the quotient and remainder of two values. The quotient and remainder of divided-by . To be added. @@ -2911,7 +2911,7 @@ For this method matches the IEE - The value which is rotated left by . + The value that is rotated left by . The amount by which is rotated left. Rotates a value left by a given amount. The result of rotating left by . @@ -2951,7 +2951,7 @@ For this method matches the IEE - The value which is rotated right by . + The value that is rotated right by . The amount by which is rotated right. Rotates a value right by a given amount. The result of rotating right by . diff --git a/xml/System/Math.xml b/xml/System/Math.xml index dd4d2addc04..027d3c2362d 100644 --- a/xml/System/Math.xml +++ b/xml/System/Math.xml @@ -3809,7 +3809,7 @@ Dim i2 As Integer = CInt(Math.Floor(d2)) ' Result: 7968 ## Remarks This computes `(x * y)` as if to infinite precision, adds `z` to that result as if to infinite precision, and finally rounds to the nearest representable value. - This differs from the non-fused sequence which would compute `(x * y)` as if to infinite precision, round the result to the nearest representable value, add `z` to the rounded result as if to infinite precision, and finally round to the nearest representable value. + This differs from the non-fused sequence, which would compute `(x * y)` as if to infinite precision, round the result to the nearest representable value, add `z` to the rounded result as if to infinite precision, and finally round to the nearest representable value. ]]> diff --git a/xml/System/MathF.xml b/xml/System/MathF.xml index 391b974c3ff..d79c2726eb9 100644 --- a/xml/System/MathF.xml +++ b/xml/System/MathF.xml @@ -1115,7 +1115,7 @@ The value of this constant is 2.71828175. ## Remarks This computes `(x * y)` as if to infinite precision, adds `z` to that result as if to infinite precision, and finally rounds to the nearest representable value. - This differs from the non-fused sequence which would compute `(x * y)` as if to infinite preicision, round the result to the nearest representable value, add 'z' to the rounded result as if to infinite precision, and finally round to the nearest representable value. + This differs from the non-fused sequenc, would compute `(x * y)` as if to infinite preicision, round the result to the nearest representable value, add 'z' to the rounded result as if to infinite precision, and finally round to the nearest representable value. ]]> diff --git a/xml/System/SByte.xml b/xml/System/SByte.xml index 6dd56884143..c4957fc90e5 100644 --- a/xml/System/SByte.xml +++ b/xml/System/SByte.xml @@ -781,8 +781,8 @@ - The value which divides. - The value which divides . + The value that divides. + The value that divides . Computes the quotient and remainder of two values. The quotient and remainder of divided-by . To be added. @@ -2437,7 +2437,7 @@ For this method matches the IEE - The value which is rotated left by . + The value that is rotated left by . The amount by which is rotated left. Rotates a value left by a given amount. The result of rotating left by . @@ -2477,7 +2477,7 @@ For this method matches the IEE - The value which is rotated right by . + The value that is rotated right by . The amount by which is rotated right. Rotates a value right by a given amount. The result of rotating right by . diff --git a/xml/System/Single.xml b/xml/System/Single.xml index 009c6a22ce0..389a3b125ba 100644 --- a/xml/System/Single.xml +++ b/xml/System/Single.xml @@ -2270,8 +2270,8 @@ This is known as Euler's number and is approximately 2.7182818284590452354. - The value which multiplies. - The value which multiplies . + The value that multiplies. + The value that multiplies . The value that is added to the product of and . Computes the fused multiply-add of three values. The result of times plus computed as one ternary operation. @@ -2449,8 +2449,8 @@ This is known as Euler's number and is approximately 2.7182818284590452354. - The value which divides. - The value which divides . + The value that divides. + The value that divides . Computes the remainder of two values as specified by IEEE 754. The remainder of divided-by as specified by IEEE 754. To be added. @@ -5672,7 +5672,7 @@ Pi is approximately 3.1415926535897932385. - The value which is raised to the power of . + The value that is raised to the power of . The power to which is raised. Computes a value raised to a given power. @@ -6026,7 +6026,7 @@ Pi is approximately 3.1415926535897932385. - The value which base-radix raised to the power of multiplies. + The value that base-radix raised to the power of multiplies. The value to which base-radix is raised before multipliying . Computes the product of a value and its base-radix raised to the specified power. The product of and base-radix raised to the power of . diff --git a/xml/System/Type.xml b/xml/System/Type.xml index 6eb2fd35bc7..63043b2bc19 100644 --- a/xml/System/Type.xml +++ b/xml/System/Type.xml @@ -3424,7 +3424,7 @@ If the current represents a generic type parameter, the - The string containing the name of an event which is declared or inherited by the current . + The name of an event that is declared or inherited by the current . A bitwise combination of the enumeration values that specify how the search is conducted. -or- diff --git a/xml/System/UInt128.xml b/xml/System/UInt128.xml index d5867ae5626..ee70d100ae2 100644 --- a/xml/System/UInt128.xml +++ b/xml/System/UInt128.xml @@ -457,7 +457,7 @@ The type of . - The value which is used to create the instance of . + The value that is used to create the instance of . Creates an instance of the current type from a value, saturating any values that fall outside the representable range of the current type. An instance of created from , saturating if falls outside the representable range of . To be added. @@ -503,7 +503,7 @@ The type of . - The value which is used to create the instance of . + The value that is used to create the instance of . Creates an instance of the current type from a value, truncating any values that fall outside the representable range of the current type. An instance of created from , truncating if falls outside the representable range of . To be added. @@ -542,8 +542,8 @@ - The value which divides. - The value which divides . + The value that divides. + The value that divides . Computes the quotient and remainder of two values. The quotient and remainder of divided-by . To be added. @@ -1026,7 +1026,7 @@ For this method matches the IEEE 754:2 The value to which is added. - The value which is added to . + The value that is added to . Adds two values together to compute their sum. The sum of and . To be added. @@ -1128,7 +1128,7 @@ For this method matches the IEEE 754:2 The value to which is added. - The value which is added to . + The value that is added to . Adds two values together to compute their sum. The sum of and . To be added. @@ -1193,8 +1193,8 @@ For this method matches the IEEE 754:2 - The value which divides. - The value which divides . + The value that divides. + The value that divides . Divides two values together to compute their quotient. The quotient of divided-by . To be added. @@ -1489,8 +1489,8 @@ For this method matches the IEEE 754:2 - The value which multiplies. - The value which multiplies . + The value that multiplies. + The value that multiplies . Multiplies two values together to compute their product. The product of multiplied-by . To be added. @@ -1524,7 +1524,7 @@ For this method matches the IEEE 754:2 The value from which is subtracted. - The value which is subtracted from . + The value that is subtracted from . Subtracts two values to compute their difference. The difference of subtracted from . To be added. @@ -1621,8 +1621,8 @@ For this method matches the IEEE 754:2 - The value which divides. - The value which divides . + The value that divides. + The value that divides . Divides two values together to compute their quotient. The quotient of divided-by . To be added. @@ -2901,8 +2901,8 @@ For this method matches the IEEE 754:2 - The value which divides. - The value which divides . + The value that divides. + The value that divides . Divides two values together to compute their modulus or remainder. The modulus or remainder of divided-by . To be added. @@ -2935,8 +2935,8 @@ For this method matches the IEEE 754:2 - The value which multiplies. - The value which multiplies . + The value that multiplies. + The value that multiplies . Multiplies two values together to compute their product. The product of multiplied-by . To be added. @@ -3044,7 +3044,7 @@ This operation is meant to perform a signed (otherwise known as an arithmetic) r The value from which is subtracted. - The value which is subtracted from . + The value that is subtracted from . Subtracts two values to compute their difference. The difference of subtracted from . To be added. @@ -3518,7 +3518,7 @@ This operation is meant to perform n unsigned (otherwise known as a logical) rig - The value which is rotated left by . + The value that is rotated left by . The amount by which is rotated left. Rotates a value left by a given amount. The result of rotating left by . @@ -3552,7 +3552,7 @@ This operation is meant to perform n unsigned (otherwise known as a logical) rig - The value which is rotated right by . + The value that is rotated right by . The amount by which is rotated right. Rotates a value right by a given amount. The result of rotating right by . diff --git a/xml/System/UInt16.xml b/xml/System/UInt16.xml index 21c81187551..53dba2a54ea 100644 --- a/xml/System/UInt16.xml +++ b/xml/System/UInt16.xml @@ -710,8 +710,8 @@ - The value which divides. - The value which divides . + The value that divides. + The value that divides . Computes the quotient and remainder of two values. The quotient and remainder of divided-by . To be added. @@ -2203,7 +2203,7 @@ For this method matches the IEEE 754:2 - The value which is rotated left by . + The value that is rotated left by . The amount by which is rotated left. Rotates a value left by a given amount. The result of rotating left by . @@ -2243,7 +2243,7 @@ For this method matches the IEEE 754:2 - The value which is rotated right by . + The value that is rotated right by . The amount by which is rotated right. Rotates a value right by a given amount. The result of rotating right by . diff --git a/xml/System/UInt32.xml b/xml/System/UInt32.xml index 3d1041eb51b..be3dab730fc 100644 --- a/xml/System/UInt32.xml +++ b/xml/System/UInt32.xml @@ -744,8 +744,8 @@ - The value which divides. - The value which divides . + The value that divides. + The value that divides . Computes the quotient and remainder of two values. The quotient and remainder of divided-by . To be added. @@ -2252,7 +2252,7 @@ For this method matches the IEEE 754:2 - The value which is rotated left by . + The value that is rotated left by . The amount by which is rotated left. Rotates a value left by a given amount. The result of rotating left by . @@ -2292,7 +2292,7 @@ For this method matches the IEEE 754:2 - The value which is rotated right by . + The value that is rotated right by . The amount by which is rotated right. Rotates a value right by a given amount. The result of rotating right by . diff --git a/xml/System/UInt64.xml b/xml/System/UInt64.xml index 68a8c74168d..f31dfe411f5 100644 --- a/xml/System/UInt64.xml +++ b/xml/System/UInt64.xml @@ -742,8 +742,8 @@ - The value which divides. - The value which divides . + The value that divides. + The value that divides . Computes the quotient and remainder of two values. The quotient and remainder of divided-by . To be added. @@ -2231,7 +2231,7 @@ For this method matches the IEEE 754:2 - The value which is rotated left by . + The value that is rotated left by . The amount by which is rotated left. Rotates a value left by a given amount. The result of rotating left by . @@ -2271,7 +2271,7 @@ For this method matches the IEEE 754:2 - The value which is rotated right by . + The value that is rotated right by . The amount by which is rotated right. Rotates a value right by a given amount. The result of rotating right by . diff --git a/xml/System/UIntPtr.xml b/xml/System/UIntPtr.xml index 2acb196eb3c..ec9e455c8d6 100644 --- a/xml/System/UIntPtr.xml +++ b/xml/System/UIntPtr.xml @@ -774,7 +774,7 @@ The type of . - The value which is used to create the instance of . + The value that is used to create the instance of . Creates an instance of the current type from a value, saturating any values that fall outside the representable range of the current type. An instance of created from , saturating if falls outside the representable range of . To be added. @@ -826,7 +826,7 @@ The type of . - The value which is used to create the instance of . + The value that is used to create the instance of . Creates an instance of the current type from a value, truncating any values that fall outside the representable range of the current type. An instance of created from , truncating if falls outside the representable range of . To be added. @@ -871,8 +871,8 @@ - The value which divides. - The value which divides . + The value that divides. + The value that divides . Computes the quotient and remainder of two values. The quotient and remainder of divided-by . To be added. @@ -2499,7 +2499,7 @@ For this method matches the IEEE 754:2 - The value which is rotated left by . + The value that is rotated left by . The amount by which is rotated left. Rotates a value left by a given amount. The result of rotating left by . @@ -2539,7 +2539,7 @@ For this method matches the IEEE 754:2 - The value which is rotated right by . + The value that is rotated right by . The amount by which is rotated right. Rotates a value right by a given amount. The result of rotating right by . From c179f7108a6ec9351a3a87610bf463c5f30196e5 Mon Sep 17 00:00:00 2001 From: Genevieve Warren <24882762+gewarren@users.noreply.github.com> Date: Fri, 28 Mar 2025 12:39:55 -0700 Subject: [PATCH 2/2] oops --- xml/System/MathF.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/xml/System/MathF.xml b/xml/System/MathF.xml index d79c2726eb9..26c61d41316 100644 --- a/xml/System/MathF.xml +++ b/xml/System/MathF.xml @@ -1115,7 +1115,7 @@ The value of this constant is 2.71828175. ## Remarks This computes `(x * y)` as if to infinite precision, adds `z` to that result as if to infinite precision, and finally rounds to the nearest representable value. - This differs from the non-fused sequenc, would compute `(x * y)` as if to infinite preicision, round the result to the nearest representable value, add 'z' to the rounded result as if to infinite precision, and finally round to the nearest representable value. + This differs from the non-fused sequence, which would compute `(x * y)` as if to infinite preicision, round the result to the nearest representable value, add 'z' to the rounded result as if to infinite precision, and finally round to the nearest representable value. ]]>