From 0c349597ee458daf703c3c77f8cc0122f40540f4 Mon Sep 17 00:00:00 2001 From: Kevin Jones Date: Thu, 26 Dec 2024 16:29:32 -0500 Subject: [PATCH 1/5] Remove outdated information from SKI docs --- .../X509SubjectKeyIdentifierHashAlgorithm.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/xml/System.Security.Cryptography.X509Certificates/X509SubjectKeyIdentifierHashAlgorithm.xml b/xml/System.Security.Cryptography.X509Certificates/X509SubjectKeyIdentifierHashAlgorithm.xml index 3e3ad2e8604..194af081702 100644 --- a/xml/System.Security.Cryptography.X509Certificates/X509SubjectKeyIdentifierHashAlgorithm.xml +++ b/xml/System.Security.Cryptography.X509Certificates/X509SubjectKeyIdentifierHashAlgorithm.xml @@ -52,7 +52,7 @@ enumeration to define the type of hash algorithm to use with the class when creating an SKI. From c4ec88b7a96a4cc4489d72dbc57187a17ce241be Mon Sep 17 00:00:00 2001 From: Genevieve Warren <24882762+gewarren@users.noreply.github.com> Date: Tue, 7 Jan 2025 10:15:45 -0800 Subject: [PATCH 2/5] fix paramrefs (#10793) --- xml/System.Device.Location/GeoCoordinate.xml | 264 ++-- xml/System.Diagnostics/ActivityContext.xml | 2 +- xml/System.Diagnostics/ActivityLink.xml | 2 +- xml/System.Diagnostics/EventLog.xml | 18 +- .../PerformanceCounterCategory.xml | 1064 ++++++++--------- xml/System.Diagnostics/ProcessStartInfo.xml | 4 +- xml/System.Diagnostics/TagList.xml | 2 +- .../TraceListenerCollection.xml | 194 +-- .../XmlWriterTraceListener.xml | 348 +++--- .../PrincipalContext.xml | 230 ++-- .../ActiveDirectorySchedule.xml | 194 +-- .../ActiveDirectorySchema.xml | 14 +- ...ctiveDirectorySchemaPropertyCollection.xml | 2 +- .../ActiveDirectorySiteLink.xml | 46 +- .../Domain.xml | 6 +- .../Forest.xml | 142 +-- .../ForestTrustDomainInformation.xml | 2 +- .../ReadOnlyStringCollection.xml | 2 +- .../DirectoryAttribute.xml | 38 +- .../DirectoryRequest.xml | 4 +- .../DsmlRequestDocument.xml | 24 +- .../LdapConnection.xml | 26 +- .../LdapDirectoryIdentifier.xml | 8 +- .../SearchResultEntryCollection.xml | 8 +- .../SearchResultReferenceCollection.xml | 8 +- .../DirectoryServicesPermission.xml | 2 +- .../PropertyCollection.xml | 440 +++---- 27 files changed, 1533 insertions(+), 1561 deletions(-) diff --git a/xml/System.Device.Location/GeoCoordinate.xml b/xml/System.Device.Location/GeoCoordinate.xml index 1bec6ecbf93..f8a27388450 100644 --- a/xml/System.Device.Location/GeoCoordinate.xml +++ b/xml/System.Device.Location/GeoCoordinate.xml @@ -46,13 +46,13 @@ Initializes a new instance of that has no data fields set. - . The new instance of is equivalent to . - - This constructor should be used for serialization. - + . The new instance of is equivalent to . + + This constructor should be used for serialization. + ]]> @@ -84,11 +84,11 @@ The longitude of the location. May range from -180.0 to 180.0. Initializes a new instance of the class from latitude and longitude data. - Latitude or longitude is out of range. @@ -123,11 +123,11 @@ The altitude in meters. May be negative, 0, positive, or , if unknown. Initializes a new instance of the class from latitude, longitude, and altitude data. - @@ -166,7 +166,7 @@ Initializes a new instance of the class from latitude, longitude, altitude, horizontal accuracy, vertical accuracy, speed, and course. To be added. - , , , or is out of range. + , , , , or is out of range. @@ -198,11 +198,11 @@ Gets the altitude of the , in meters. The altitude, in meters. - @@ -232,19 +232,19 @@ Gets or sets the heading in degrees, relative to true north. The heading in degrees, relative to true north. - and properties of the current location's . - + and properties of the current location's . + :::code language="csharp" source="~/snippets/csharp/System.Device.Location/GeoCoordinate/Course/courseandspeed.cs" id="Snippet2"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Misc/system.device.location.courseandspeed/vb/courseandspeed.vb" id="Snippet2"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Misc/system.device.location.courseandspeed/vb/courseandspeed.vb" id="Snippet2"::: + ]]> @@ -287,11 +287,11 @@ if the objects are equal; otherwise, . - objects have the same and properties. The , , and properties are not used to determine equivalency. - + objects have the same and properties. The , , and properties are not used to determine equivalency. + ]]> @@ -320,11 +320,11 @@ , if the objects are equal; otherwise, . - objects have the same and properties. The , , and properties are not used to determine equivalency. - + objects have the same and properties. The , , and properties are not used to determine equivalency. + ]]> @@ -352,13 +352,13 @@ Returns the distance between the latitude and longitude coordinates that are specified by this and another specified . The distance between the two coordinates, in meters. - @@ -383,11 +383,11 @@ Serves as a hash function for the . A hash code for the current . - objects that are equivalent have the same hash code. Equivalent objects have the same and properties. The , , and properties are not used to determine equivalency. - + objects that are equivalent have the same hash code. Equivalent objects have the same and properties. The , , and properties are not used to determine equivalency. + ]]> @@ -417,11 +417,11 @@ Gets or sets the accuracy of the latitude and longitude that is given by the , in meters. The accuracy of the latitude and longitude, in meters. - @@ -448,19 +448,19 @@ if the does not contain latitude or longitude data; otherwise, . - that does not contain latitude or longitude data is equal to . - - - -## Examples - The following code example verifies whether the that corresponds to a location is before printing out its latitude and longitude. - + that does not contain latitude or longitude data is equal to . + + + +## Examples + The following code example verifies whether the that corresponds to a location is before printing out its latitude and longitude. + :::code language="csharp" source="~/snippets/csharp/System.Device.Location/GeoCoordinate/IsUnknown/getlocationdatasynchandleunknown.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Misc/system.device.location.getlocationdatasynchandleunknown/vb/GetLocationDataSyncHandleUnknown.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Misc/system.device.location.getlocationdatasynchandleunknown/vb/GetLocationDataSyncHandleUnknown.vb" id="Snippet1"::: + ]]> @@ -490,19 +490,19 @@ Gets or sets the latitude of the . Latitude of the location. - . - + . + :::code language="csharp" source="~/snippets/csharp/System.Device.Location/GeoCoordinate/Latitude/locationevent.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Misc/system.device.location.locationevent1/vb/locationevent.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Misc/system.device.location.locationevent1/vb/locationevent.vb" id="Snippet1"::: + ]]> @@ -534,19 +534,19 @@ Gets or sets the longitude of the . The longitude. - . - + . + :::code language="csharp" source="~/snippets/csharp/System.Device.Location/GeoCoordinate/Latitude/locationevent.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Misc/system.device.location.locationevent1/vb/locationevent.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Misc/system.device.location.locationevent1/vb/locationevent.vb" id="Snippet1"::: + ]]> @@ -579,11 +579,11 @@ , if the objects are determined to be equivalent; otherwise, . - objects have the same and properties. The , , and properties are not used to determine equivalency. - + objects have the same and properties. The , , and properties are not used to determine equivalency. + ]]> @@ -614,11 +614,11 @@ , if the objects are determined to be different; otherwise, . - objects have the same and properties. The , , and properties are not used to determine equivalency. - + objects have the same and properties. The , , and properties are not used to determine equivalency. + ]]> @@ -648,14 +648,14 @@ Gets or sets the speed in meters per second. The speed in meters per second. The speed must be greater than or equal to zero, or . - and properties of the current location's . - + and properties of the current location's . + :::code language="csharp" source="~/snippets/csharp/System.Device.Location/GeoCoordinate/Course/courseandspeed.cs" id="Snippet2"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Misc/system.device.location.courseandspeed/vb/courseandspeed.vb" id="Snippet2"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Misc/system.device.location.courseandspeed/vb/courseandspeed.vb" id="Snippet2"::: + ]]> @@ -682,11 +682,11 @@ Returns a string that contains the latitude and longitude. A string that contains the latitude and longitude, separated by a comma. - @@ -709,19 +709,19 @@ Represents a object that has unknown latitude and longitude fields. - property can be used to verify whether a contains no data. - - - -## Examples - The following code example verifies whether the that corresponds to a location is before printing out its latitude and longitude. - + property can be used to verify whether a contains no data. + + + +## Examples + The following code example verifies whether the that corresponds to a location is before printing out its latitude and longitude. + :::code language="csharp" source="~/snippets/csharp/System.Device.Location/GeoCoordinate/IsUnknown/getlocationdatasynchandleunknown.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Misc/system.device.location.getlocationdatasynchandleunknown/vb/GetLocationDataSyncHandleUnknown.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Misc/system.device.location.getlocationdatasynchandleunknown/vb/GetLocationDataSyncHandleUnknown.vb" id="Snippet1"::: + ]]> diff --git a/xml/System.Diagnostics/ActivityContext.xml b/xml/System.Diagnostics/ActivityContext.xml index 7aa0fbc4f4d..6329e77da15 100644 --- a/xml/System.Diagnostics/ActivityContext.xml +++ b/xml/System.Diagnostics/ActivityContext.xml @@ -113,7 +113,7 @@ ActivityContext contains the property `IsRemote`, which is not part of W3C. `IsR The object to compare to this instance. Indicates whether the current object is equal to another object of the same type. - if the current object is equal to the parameter; otherwise, . + if the current object is equal to the parameter; otherwise, . To be added. diff --git a/xml/System.Diagnostics/ActivityLink.xml b/xml/System.Diagnostics/ActivityLink.xml index 4358d79ec04..cce746fc2a7 100644 --- a/xml/System.Diagnostics/ActivityLink.xml +++ b/xml/System.Diagnostics/ActivityLink.xml @@ -141,7 +141,7 @@ Activity links can be used to represent batched operations where an activity was The activity link to compare. Indicates whether the current activity link is equal to another activity link. - if the current activity link is equal to ; otherwise, . + if the current activity link is equal to ; otherwise, . to the event log. The `type` is indicated by an icon and text in the Type column in the Event Viewer for a log. > [!NOTE] -> The `message` string cannot contain %*n*, where *n* is an integer value (for example, %1), because the event viewer treats it as an insertion string. Because an Internet Protocol, version 6 (IPv6) address can contain this character sequence, you cannot log an event message that contains an IPv6 address. +> The `message` string cannot contain %*n*, where *n* is an integer value (for example, %1), because the event viewer treats it as an insertion string. Because an Internet Protocol, version 6 (IPv6) address can contain this character sequence, you cannot log an event message that contains an IPv6 address. You must set the property on your component before you can write entries to the log. You must create and configure the event source before writing the first entry with the source. @@ -3377,9 +3377,7 @@ SVC_UPDATE.EXE > If you write an entry to a remote computer, the value of the message (the text string) might not be what you expect if the remote computer is not running the .NET Framework. > [!NOTE] -> If the `message` parameter contains a NUL character, the message in the event log is terminated at the NUL character. - - +> If the `message` parameter contains a NUL character, the message in the event log is terminated at the NUL character. ## Examples The following example writes a warning entry to an event log, "MyNewLog", on the local computer. @@ -3464,6 +3462,7 @@ SVC_UPDATE.EXE , use a different overload of . You must create and configure the event source before writing the first entry with the source. Create the new event source during the installation of your application. This allows time for the operating system to refresh its list of registered event sources and their configuration. If the operating system has not refreshed its list of event sources, and you attempt to write an event with the new source, the write operation will fail. You can configure a new source using an , or using the method. You must have administrative rights on the computer to create a new event source. @@ -3473,11 +3472,9 @@ SVC_UPDATE.EXE If your application writes entries using both resource identifiers and string values, you must register two separate sources. For example, configure one source with resource files, and then use that source in the method to write entries using resource identifiers to the event log. Then create a different source without resource files, and use that source in the method to write strings directly to the event log using that source. > [!NOTE] -> If the `message` parameter contains a NUL character, the message in the event log is terminated at the NUL character. +> If the `message` parameter contains a NUL character, the message in the event log is terminated at the NUL character. > -> The `message` string cannot contain %*n*, where *n* is an integer value (for example, %1), because the event viewer treats it as an insertion string. Because an Internet Protocol, version 6 (IPv6) address can contain this character sequence, you cannot log an event message that contains an IPv6 address. - - +> The `message` string cannot contain %*n*, where *n* is an integer value (for example, %1), because the event viewer treats it as an insertion string. Because an Internet Protocol, version 6 (IPv6) address can contain this character sequence, you cannot log an event message that contains an IPv6 address. ## Examples The following example creates the source `MySource` if it does not already exist, and writes an entry to the event log `MyNewLog`. @@ -4370,6 +4367,7 @@ SVC_UPDATE.EXE . You must register the source with the corresponding resource file before you write events using resource identifiers. The input `instance` instance specifies the event message and properties. Set the of the `instance` input for the defined message in the source message resource file. You can optionally set the and of the `instance` input to define the category and event type of your event entry. You can also specify an array of language-independent strings to insert into the localized message text. Set `values` to `null` if the event message does not contain formatting placeholders for replacement strings. @@ -4383,9 +4381,7 @@ SVC_UPDATE.EXE If your application writes entries using both resource identifiers and string values, you must register two separate sources. For example, configure one source with resource files, and then use that source in the method to write entries using resource identifiers to the event log. Then create a different source without resource files, and use that source in the method to write strings directly to the event log using that source. > [!NOTE] -> If you write an entry to a remote computer, the value of the `message` string might not be what you expect if the remote computer is not running the .NET Framework. Also, the `message` string cannot contain %*n*, where *n* is an integer value (for example, %1), because the event viewer treats it as an insertion string. Because an Internet Protocol, version 6 (IPv6) address can contain this character sequence, you cannot log an event message that contains an IPv6 address. - - +> If you write an entry to a remote computer, the value of the `message` string might not be what you expect if the remote computer is not running .NET. Also, the `message` string cannot contain %*n*, where *n* is an integer value (for example, %1), because the event viewer treats it as an insertion string. Because an Internet Protocol, version 6 (IPv6) address can contain this character sequence, you cannot log an event message that contains an IPv6 address. ## Examples The following example writes two audit entries to the event log `myNewLog`. The example creates a new event source and a new event log if they do not exist on the local computer. The event message text is specified using a resource identifier in a resource file. diff --git a/xml/System.Diagnostics/PerformanceCounterCategory.xml b/xml/System.Diagnostics/PerformanceCounterCategory.xml index 0ea286a0757..5fca2af8f23 100644 --- a/xml/System.Diagnostics/PerformanceCounterCategory.xml +++ b/xml/System.Diagnostics/PerformanceCounterCategory.xml @@ -29,44 +29,44 @@ Represents a performance object, which defines a category of performance counters. - [!IMPORTANT] -> Creating or deleting a performance counter requires synchronization of the underlying code by using a named mutex. If a highly privileged application locks the named mutex, attempts to create or delete a performance counter causes the application to stop responding until the lock is released. To help avoid this problem, never grant permission to untrusted code. In addition, permission potentially allows other permissions to be bypassed and should only be granted to highly trusted code. - - The instance's property is displayed in the Performance Object field of the Performance Viewer application's Add Counter dialog box. - - The class provides several methods for interacting with counters and categories on the computer. The methods enable you to define custom categories. The method provides a way to remove categories from the computer. The method enables you to view the list of categories, while retrieves all the counter and instance data associated with a single category. - - A performance counter publishes performance data about an application. Categories include physical components (such as processors, disks, and memory) and system objects (such as processes and threads). System counters that are related to the same performance object are grouped into a category that indicates their common focus. When you create an instance of the class, you first indicate the category with which the component will interact, and then you choose a counter from that category. - - For example, one Windows counter category is the Memory category. System counters within this category track memory data such as the number of bytes available and the number of bytes cached. If you wanted to work with the bytes cached in your application, you would create an instance of the component, connect it to the Memory category, and then pick the appropriate counter (in this case, Cached Bytes) from that category. - - Although your system makes many more counter categories available, the categories that you will probably interact with most frequently are the Cache, Memory, Objects, PhysicalDisk, Process, Processor, Server, System, and Thread categories. - +> Creating or deleting a performance counter requires synchronization of the underlying code by using a named mutex. If a highly privileged application locks the named mutex, attempts to create or delete a performance counter causes the application to stop responding until the lock is released. To help avoid this problem, never grant permission to untrusted code. In addition, permission potentially allows other permissions to be bypassed and should only be granted to highly trusted code. + + The instance's property is displayed in the Performance Object field of the Performance Viewer application's Add Counter dialog box. + + The class provides several methods for interacting with counters and categories on the computer. The methods enable you to define custom categories. The method provides a way to remove categories from the computer. The method enables you to view the list of categories, while retrieves all the counter and instance data associated with a single category. + + A performance counter publishes performance data about an application. Categories include physical components (such as processors, disks, and memory) and system objects (such as processes and threads). System counters that are related to the same performance object are grouped into a category that indicates their common focus. When you create an instance of the class, you first indicate the category with which the component will interact, and then you choose a counter from that category. + + For example, one Windows counter category is the Memory category. System counters within this category track memory data such as the number of bytes available and the number of bytes cached. If you wanted to work with the bytes cached in your application, you would create an instance of the component, connect it to the Memory category, and then pick the appropriate counter (in this case, Cached Bytes) from that category. + + Although your system makes many more counter categories available, the categories that you will probably interact with most frequently are the Cache, Memory, Objects, PhysicalDisk, Process, Processor, Server, System, and Thread categories. + > [!IMPORTANT] -> The method in the class will release the counter and, if the reuse option is selected for that category, the instance of the counter will be reused. This could cause a race condition if another process or even another part of the code is trying to write to the counter instance. - +> The method in the class will release the counter and, if the reuse option is selected for that category, the instance of the counter will be reused. This could cause a race condition if another process or even another part of the code is trying to write to the counter instance. + > [!NOTE] -> It is strongly recommended that new performance counter categories be created during the installation of the application, not during the execution of the application. This allows time for the operating system to refresh its list of registered performance counter categories. If the list has not been refreshed, the attempt to use the category will fail. - +> It is strongly recommended that new performance counter categories be created during the installation of the application, not during the execution of the application. This allows time for the operating system to refresh its list of registered performance counter categories. If the list has not been refreshed, the attempt to use the category will fail. + > [!NOTE] -> Performance counter categories installed with the .NET Framework 2.0 use separate shared memory, with each performance counter category having its own memory. You can specify the size of separate shared memory by creating a DWORD named FileMappingSize in the registry key HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\\*\*\Performance. The FileMappingSize value is set to the shared memory size of the category. The default size is 131072 decimal. If the FileMappingSize value is not present, the `fileMappingSize` attribute value for the `performanceCounters` element specified in the Machine.config file is used, causing additional overhead for configuration file processing. You can realize a performance improvement for application startup by setting the file mapping size in the registry. For more information about the file mapping size, see [<performanceCounters>](/dotnet/framework/configure-apps/file-schema/trace-debug/performancecounters-element). - - - -## Examples - The following code example determines whether a and its exist on the local computer or on another computer. If these objects do not exist on the local computer, the example optionally creates them. It uses the method to determine whether the exists. If the does not exist and no counter name is specified, or if the computer is a remote machine, the example exits. - - If a name is provided, the example uses the method and displays the result to the user. If the does not exist, the user can delete and re-create the with the new . If the user does so, the category is deleted using the method. - - If requested, the example now creates the new and using the method. If an instance name is specified, the example uses the method and displays the result. - +> Performance counter categories installed with the .NET Framework 2.0 use separate shared memory, with each performance counter category having its own memory. You can specify the size of separate shared memory by creating a DWORD named FileMappingSize in the registry key HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\\*\*\Performance. The FileMappingSize value is set to the shared memory size of the category. The default size is 131072 decimal. If the FileMappingSize value is not present, the `fileMappingSize` attribute value for the `performanceCounters` element specified in the Machine.config file is used, causing additional overhead for configuration file processing. You can realize a performance improvement for application startup by setting the file mapping size in the registry. For more information about the file mapping size, see [<performanceCounters>](/dotnet/framework/configure-apps/file-schema/trace-debug/performancecounters-element). + + + +## Examples + The following code example determines whether a and its exist on the local computer or on another computer. If these objects do not exist on the local computer, the example optionally creates them. It uses the method to determine whether the exists. If the does not exist and no counter name is specified, or if the computer is a remote machine, the example exits. + + If a name is provided, the example uses the method and displays the result to the user. If the does not exist, the user can delete and re-create the with the new . If the user does so, the category is deleted using the method. + + If requested, the example now creates the new and using the method. If an instance name is specified, the example uses the method and displays the result. + :::code language="csharp" source="~/snippets/csharp/System.Diagnostics/PerformanceCounterCategory/Overview/perfcountercatcreateexist.cs" id="Snippet27"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Diagnostics.PerformanceCounterCategory.Class/VB/perfcountercatcreateexist.vb" id="Snippet27"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Diagnostics.PerformanceCounterCategory.Class/VB/perfcountercatcreateexist.vb" id="Snippet27"::: + ]]> @@ -110,19 +110,19 @@ Initializes a new instance of the class, leaves the property empty, and sets the property to the local computer. - property must be set before associating this instance with a performance object on the server. Otherwise, an exception is thrown. - - - -## Examples - The following code example accepts a name and a computer name from the command line. It creates a using the constructor overload appropriate for the number of parameters provided, then displays its properties. - + property must be set before associating this instance with a performance object on the server. Otherwise, an exception is thrown. + + + +## Examples + The following code example accepts a name and a computer name from the command line. It creates a using the constructor overload appropriate for the number of parameters provided, then displays its properties. + :::code language="csharp" source="~/snippets/csharp/System.Diagnostics/PerformanceCounterCategory/.ctor/perfcountercatctor.cs" id="Snippet4"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Diagnostics.PerformanceCounterCategory.OtherMembers/VB/perfcountercatctor.vb" id="Snippet4"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Diagnostics.PerformanceCounterCategory.OtherMembers/VB/perfcountercatctor.vb" id="Snippet4"::: + ]]> @@ -167,14 +167,14 @@ The name of the performance counter category, or performance object, with which to associate this instance. Initializes a new instance of the class, sets the property to the specified value, and sets the property to the local computer. - name and a computer name from the command line. It creates a using the constructor overload that is appropriate for the number of parameters provided, then displays its properties. - + name and a computer name from the command line. It creates a using the constructor overload that is appropriate for the number of parameters provided, then displays its properties. + :::code language="csharp" source="~/snippets/csharp/System.Diagnostics/PerformanceCounterCategory/.ctor/perfcountercatctor.cs" id="Snippet4"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Diagnostics.PerformanceCounterCategory.OtherMembers/VB/perfcountercatctor.vb" id="Snippet4"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Diagnostics.PerformanceCounterCategory.OtherMembers/VB/perfcountercatctor.vb" id="Snippet4"::: + ]]> The is an empty string (""). @@ -217,20 +217,20 @@ The computer on which the performance counter category and its associated counters exist. Initializes a new instance of the class and sets the and properties to the specified values. - name and a computer name from the command line. It creates a using the constructor overload that is appropriate for the number of parameters provided, then displays its properties. - + name and a computer name from the command line. It creates a using the constructor overload that is appropriate for the number of parameters provided, then displays its properties. + :::code language="csharp" source="~/snippets/csharp/System.Diagnostics/PerformanceCounterCategory/.ctor/perfcountercatctor.cs" id="Snippet4"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Diagnostics.PerformanceCounterCategory.OtherMembers/VB/perfcountercatctor.vb" id="Snippet4"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Diagnostics.PerformanceCounterCategory.OtherMembers/VB/perfcountercatctor.vb" id="Snippet4"::: + ]]> - The is an empty string (""). - - -or- - + The is an empty string (""). + + -or- + The syntax is invalid. The is . @@ -269,14 +269,14 @@ Gets the category's help text. A description of the performance object that this category measures. - with the . It prompts the user for the and computer names, then sets the and properties from the entered values. It then displays the values of the , , and properties, or it displays an error message if the cannot be accessed. - + with the . It prompts the user for the and computer names, then sets the and properties from the entered values. It then displays the values of the , , and properties, or it displays an error message if the cannot be accessed. + :::code language="csharp" source="~/snippets/csharp/System.Diagnostics/PerformanceCounterCategory/.ctor/perfCounterCatProps.cs" id="Snippet8"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Diagnostics.PerformanceCounterCategory.OtherMembers/VB/perfcountercatprops.vb" id="Snippet8"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Diagnostics.PerformanceCounterCategory.OtherMembers/VB/perfcountercatprops.vb" id="Snippet8"::: + ]]> The property is . The category name must be set before getting the category help. @@ -324,14 +324,14 @@ Gets or sets the name of the performance object that defines this category. The name of the performance counter category, or performance object, with which to associate this instance. - with the . It prompts the user for the and computer names, then sets the and properties from the entered values. It then displays the values of the , , and properties, or it displays an error message if the cannot be accessed. - + with the . It prompts the user for the and computer names, then sets the and properties from the entered values. It then displays the values of the , , and properties, or it displays an error message if the cannot be accessed. + :::code language="csharp" source="~/snippets/csharp/System.Diagnostics/PerformanceCounterCategory/.ctor/perfCounterCatProps.cs" id="Snippet8"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Diagnostics.PerformanceCounterCategory.OtherMembers/VB/perfcountercatprops.vb" id="Snippet8"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Diagnostics.PerformanceCounterCategory.OtherMembers/VB/perfcountercatprops.vb" id="Snippet8"::: + ]]> The is an empty string (""). @@ -370,13 +370,13 @@ Gets the performance counter category type. One of the values. - property indicates whether the object can have multiple instances. The possible values are , , or . - - There are two types of performance counter categories: single-instance and multi-instance. By default, a category is single-instance when it is created and becomes multi-instance when another instance is added. Categories are created when an application is set up, and instances are added at run time. In the .NET Framework versions 1.0 and 1.1, it is not necessary to know if a performance counter category is multi-instance or single-instance. In the .NET Framework 2.0, the enumeration is used to indicate whether a performance counter can have multiple instances. - + property indicates whether the object can have multiple instances. The possible values are , , or . + + There are two types of performance counter categories: single-instance and multi-instance. By default, a category is single-instance when it is created and becomes multi-instance when another instance is added. Categories are created when an application is set up, and instances are added at run time. In the .NET Framework versions 1.0 and 1.1, it is not necessary to know if a performance counter category is multi-instance or single-instance. In the .NET Framework 2.0, the enumeration is used to indicate whether a performance counter can have multiple instances. + ]]> @@ -426,28 +426,26 @@ if the counter is registered to the category that is specified by the and properties; otherwise, . - property before calling this method. Otherwise, an exception is thrown. - - If you have not set the property, this method uses the local computer ("."). - + property before calling this method. Otherwise, an exception is thrown. + + If you have not set the property, this method uses the local computer ("."). + > [!NOTE] -> To read performance counters from a non-interactive logon session in Windows Vista and later, Windows XP Professional x64 Edition, or Windows Server 2003, you must either be a member of the Performance Monitor Users group or have administrative privileges. -> -> To avoid having to elevate your privileges to access performance counters in Windows Vista and later, add yourself to the Performance Monitor Users group. -> -> In Windows Vista and later, User Account Control (UAC) determines the privileges of a user. If you are a member of the Built-in Administrators group, you are assigned two run-time access tokens: a standard user access token and an administrator access token. By default, you are in the standard user role. To execute the code that accesses performance counters, you must first elevate your privileges from standard user to administrator. You can do this when you start an application by right-clicking the application icon and indicating that you want to run as an administrator. - - - -## Examples - The following code example determines whether a exists. It gets a category name, counter name, and computer name from the command line, if they are given. It creates a object using the appropriate . It then uses the method to determine whether the specified exists, and informs the user. - +> To read performance counters from a non-interactive logon session in Windows Vista and later, Windows XP Professional x64 Edition, or Windows Server 2003, you must either be a member of the Performance Monitor Users group or have administrative privileges. +> +> To avoid having to elevate your privileges to access performance counters in Windows Vista and later, add yourself to the Performance Monitor Users group. +> +> In Windows Vista and later, User Account Control (UAC) determines the privileges of a user. If you are a member of the Built-in Administrators group, you are assigned two run-time access tokens: a standard user access token and an administrator access token. By default, you are in the standard user role. To execute the code that accesses performance counters, you must first elevate your privileges from standard user to administrator. You can do this when you start an application by right-clicking the application icon and indicating that you want to run as an administrator. + +## Examples + The following code example determines whether a exists. It gets a category name, counter name, and computer name from the command line, if they are given. It creates a object using the appropriate . It then uses the method to determine whether the specified exists, and informs the user. + :::code language="csharp" source="~/snippets/csharp/System.Diagnostics/PerformanceCounterCategory/CounterExists/perfcountercatobjexists.cs" id="Snippet4"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Diagnostics.PerformanceCounterCategory.ExistMembers/VB/perfcountercatobjcountexists.vb" id="Snippet4"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Diagnostics.PerformanceCounterCategory.ExistMembers/VB/perfcountercatobjcountexists.vb" id="Snippet4"::: + ]]> The is . @@ -504,31 +502,29 @@ , if the counter is registered to the specified category on the local computer; otherwise, . - [!NOTE] -> To read performance counters from a non-interactive logon session in Windows Vista and later, Windows XP Professional x64 Edition, or Windows Server 2003, you must either be a member of the Performance Monitor Users group or have administrative privileges. -> -> To avoid having to elevate your privileges to access performance counters in Windows Vista and later, add yourself to the Performance Monitor Users group. -> -> In Windows Vista and later, User Account Control (UAC) determines the privileges of a user. If you are a member of the Built-in Administrators group, you are assigned two run-time access tokens: a standard user access token and an administrator access token. By default, you are in the standard user role. To execute the code that accesses performance counters, you must first elevate your privileges from standard user to administrator. You can do this when you start an application by right-clicking the application icon and indicating that you want to run as an administrator. - - - -## Examples - The following code example determines whether a exists. It gets a category name, counter name, and computer name from the command line, if they are given. It uses the static overloads of the method to determine whether the specified name exists in the . The overload is selected based on whether a computer name is provided. - +> To read performance counters from a non-interactive logon session in Windows Vista and later, Windows XP Professional x64 Edition, or Windows Server 2003, you must either be a member of the Performance Monitor Users group or have administrative privileges. +> +> To avoid having to elevate your privileges to access performance counters in Windows Vista and later, add yourself to the Performance Monitor Users group. +> +> In Windows Vista and later, User Account Control (UAC) determines the privileges of a user. If you are a member of the Built-in Administrators group, you are assigned two run-time access tokens: a standard user access token and an administrator access token. By default, you are in the standard user role. To execute the code that accesses performance counters, you must first elevate your privileges from standard user to administrator. You can do this when you start an application by right-clicking the application icon and indicating that you want to run as an administrator. + +## Examples + The following code example determines whether a exists. It gets a category name, counter name, and computer name from the command line, if they are given. It uses the static overloads of the method to determine whether the specified name exists in the . The overload is selected based on whether a computer name is provided. + :::code language="csharp" source="~/snippets/csharp/System.Diagnostics/PerformanceCounterCategory/CounterExists/perfcountercatstatcounterexists.cs" id="Snippet8"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Diagnostics.PerformanceCounterCategory.ExistMembers/VB/perfcountercatstatcountexists.vb" id="Snippet8"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Diagnostics.PerformanceCounterCategory.ExistMembers/VB/perfcountercatstatcountexists.vb" id="Snippet8"::: + ]]> - The is . - - -or- - + The is . + + -or- + The is . The is an empty string (""). The category name does not exist. @@ -579,36 +575,34 @@ , if the counter is registered to the specified category on the specified computer; otherwise, . - [!NOTE] -> To read performance counters from a non-interactive logon session in Windows Vista and later, Windows XP Professional x64 Edition, or Windows Server 2003, you must either be a member of the Performance Monitor Users group or have administrative privileges. -> -> To avoid having to elevate your privileges to access performance counters in Windows Vista and later, add yourself to the Performance Monitor Users group. -> -> In Windows Vista and later, User Account Control (UAC) determines the privileges of a user. If you are a member of the Built-in Administrators group, you are assigned two run-time access tokens: a standard user access token and an administrator access token. By default, you are in the standard user role. To execute the code that accesses performance counters, you must first elevate your privileges from standard user to administrator. You can do this when you start an application by right-clicking the application icon and indicating that you want to run as an administrator. - - - -## Examples - The following code example determines whether a exists. It gets a category name, counter name, and computer name from the command line, if they are given. It uses the static overloads of the method to determine whether the specified name exists in the . The overload is selected based on whether a computer name is provided. - +> To read performance counters from a non-interactive logon session in Windows Vista and later, Windows XP Professional x64 Edition, or Windows Server 2003, you must either be a member of the Performance Monitor Users group or have administrative privileges. +> +> To avoid having to elevate your privileges to access performance counters in Windows Vista and later, add yourself to the Performance Monitor Users group. +> +> In Windows Vista and later, User Account Control (UAC) determines the privileges of a user. If you are a member of the Built-in Administrators group, you are assigned two run-time access tokens: a standard user access token and an administrator access token. By default, you are in the standard user role. To execute the code that accesses performance counters, you must first elevate your privileges from standard user to administrator. You can do this when you start an application by right-clicking the application icon and indicating that you want to run as an administrator. + +## Examples + The following code example determines whether a exists. It gets a category name, counter name, and computer name from the command line, if they are given. It uses the static overloads of the method to determine whether the specified name exists in the . The overload is selected based on whether a computer name is provided. + :::code language="csharp" source="~/snippets/csharp/System.Diagnostics/PerformanceCounterCategory/CounterExists/perfcountercatstatcounterexists.cs" id="Snippet8"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Diagnostics.PerformanceCounterCategory.ExistMembers/VB/perfcountercatstatcountexists.vb" id="Snippet8"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Diagnostics.PerformanceCounterCategory.ExistMembers/VB/perfcountercatstatcountexists.vb" id="Snippet8"::: + ]]> - The is . - - -or- - + The is . + + -or- + The is . - The is an empty string (""). - - -or- - + The is an empty string (""). + + -or- + The is invalid. The category name does not exist. A call to an underlying system API failed. @@ -684,42 +678,36 @@ Registers the custom performance counter category containing the specified counters on the local computer. A that is associated with the new custom category, or performance object. - [!NOTE] -> To read performance counters from a non-interactive logon session in Windows Vista and later, Windows XP Professional x64 Edition, or Windows Server 2003, you must either be a member of the Performance Monitor Users group or have administrative privileges. -> -> To avoid having to elevate your privileges to access performance counters in Windows Vista and later, add yourself to the Performance Monitor Users group. -> -> In Windows Vista and later, User Account Control (UAC) determines the privileges of a user. If you are a member of the Built-in Administrators group, you are assigned two run-time access tokens: a standard user access token and an administrator access token. By default, you are in the standard user role. To execute the code that accesses performance counters, you must first elevate your privileges from standard user to administrator. You can do this when you start an application by right-clicking the application icon and indicating that you want to run as an administrator. - - - -## Examples - The following code example determines whether a object named "orders" exists. If not, it creates the object by using a object that contains two performance counters. - +> To read performance counters from a non-interactive logon session in Windows Vista and later, Windows XP Professional x64 Edition, or Windows Server 2003, you must either be a member of the Performance Monitor Users group or have administrative privileges. +> +> To avoid having to elevate your privileges to access performance counters in Windows Vista and later, add yourself to the Performance Monitor Users group. +> +> In Windows Vista and later, User Account Control (UAC) determines the privileges of a user. If you are a member of the Built-in Administrators group, you are assigned two run-time access tokens: a standard user access token and an administrator access token. By default, you are in the standard user role. To execute the code that accesses performance counters, you must first elevate your privileges from standard user to administrator. You can do this when you start an application by right-clicking the application icon and indicating that you want to run as an administrator. + +## Examples + The following code example determines whether a object named "orders" exists. If not, it creates the object by using a object that contains two performance counters. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/PerfCounter_ccd/CPP/ccd.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Diagnostics/PerformanceCounterCategory/Create/ccd.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/PerfCounter_ccd/VB/ccd.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/PerfCounter_ccd/VB/ccd.vb" id="Snippet1"::: + ]]> - A counter name that is specified within the collection is or an empty string (""). - - -or- - - A counter that is specified within the collection already exists. - - -or- - - The parameter has invalid syntax. It might contain backslash characters ("\\") or have length greater than 80 characters. + A counter name that is specified within the collection is or an empty string (""). + + -or- + + A counter that is specified within the collection already exists. The parameter is . - The category already exists on the local computer. - - -or- - + The category already exists on the local computer. + + -or- + The layout of the collection is incorrect for base counters. A counter of type , , , , , , , or has to be immediately followed by one of the base counter types (, , , or ). A call to an underlying system API failed. Code that is executing without administrative privileges attempted to read a performance counter. @@ -769,54 +757,48 @@ Registers the custom performance counter category containing the specified counters on the local computer. A that is associated with the new custom category, or performance object. - enumeration is used to indicate whether a performance counter can have multiple instances. - - Performance counter categories installed with the .NET Framework 2.0 use separate shared memory, with each performance counter category having its own memory. You can specify the size of separate shared memory by creating a DWORD named FileMappingSize in the registry key HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\\*\*\Performance. The FileMappingSize value is set to the shared memory size of the category. The default size is 131072 decimal. If the FileMappingSize value is not present, the `fileMappingSize` attribute value for the `performanceCounters` element specified in the Machine.config file is used, causing additional overhead for configuration file processing. You can realize a performance improvement for application startup by setting the file mapping size in the registry. - + enumeration is used to indicate whether a performance counter can have multiple instances. + + Performance counter categories installed with the .NET Framework 2.0 use separate shared memory, with each performance counter category having its own memory. You can specify the size of separate shared memory by creating a DWORD named FileMappingSize in the registry key HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\\*\*\Performance. The FileMappingSize value is set to the shared memory size of the category. The default size is 131072 decimal. If the FileMappingSize value is not present, the `fileMappingSize` attribute value for the `performanceCounters` element specified in the Machine.config file is used, causing additional overhead for configuration file processing. You can realize a performance improvement for application startup by setting the file mapping size in the registry. + > [!NOTE] -> It is strongly recommended that new performance counter categories be created during the installation of the application, not during the execution of the application. This allows time for the operating system to refresh its list of registered performance counter categories. If the list has not been refreshed, the attempt to use the category will fail. - +> It is strongly recommended that new performance counter categories be created during the installation of the application, not during the execution of the application. This allows time for the operating system to refresh its list of registered performance counter categories. If the list has not been refreshed, the attempt to use the category will fail. + > [!NOTE] -> To read performance counters from a non-interactive logon session in Windows Vista and later, Windows XP Professional x64 Edition, or Windows Server 2003, you must either be a member of the Performance Monitor Users group or have administrative privileges. -> -> To avoid having to elevate your privileges to access performance counters in Windows Vista and later, add yourself to the Performance Monitor Users group. -> -> In Windows Vista and later, User Account Control (UAC) determines the privileges of a user. If you are a member of the Built-in Administrators group, you are assigned two run-time access tokens: a standard user access token and an administrator access token. By default, you are in the standard user role. To execute the code that accesses performance counters, you must first elevate your privileges from standard user to administrator. You can do this when you start an application by right-clicking the application icon and indicating that you want to run as an administrator. - - - -## Examples - The following code example shows the use of the method. The example shows how to create a custom, multi-instance performance counter category for the number of orders per second. - +> To read performance counters from a non-interactive logon session in Windows Vista and later, Windows XP Professional x64 Edition, or Windows Server 2003, you must either be a member of the Performance Monitor Users group or have administrative privileges. +> +> To avoid having to elevate your privileges to access performance counters in Windows Vista and later, add yourself to the Performance Monitor Users group. +> +> In Windows Vista and later, User Account Control (UAC) determines the privileges of a user. If you are a member of the Built-in Administrators group, you are assigned two run-time access tokens: a standard user access token and an administrator access token. By default, you are in the standard user role. To execute the code that accesses performance counters, you must first elevate your privileges from standard user to administrator. You can do this when you start an application by right-clicking the application icon and indicating that you want to run as an administrator. + +## Examples + The following code example shows the use of the method. The example shows how to create a custom, multi-instance performance counter category for the number of orders per second. + :::code language="csharp" source="~/snippets/csharp/System.Diagnostics/PerformanceCounterCategory/Create/program.cs" id="Snippet2"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Diagnostics.PerformanceCounterCategoryType/VB/program.vb" id="Snippet2"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Diagnostics.PerformanceCounterCategoryType/VB/program.vb" id="Snippet2"::: + ]]> - A counter name that is specified within the collection is or an empty string (""). - - -or- - - A counter that is specified within the collection already exists. - - -or- - - has invalid syntax. It might contain backslash characters ("\\") or have length greater than 80 characters. + A counter name that is specified within the collection is or an empty string (""). + + -or- + + A counter that is specified within the collection already exists. - is . - - -or- - + is . + + -or- + is . value is outside of the range of the following values: , , or . - The category already exists on the local computer. - - -or- - + The category already exists on the local computer. + + -or- + The layout of the collection is incorrect for base counters. A counter of type , , , , , , , , or must be immediately followed by one of the base counter types (, , , or ). A call to an underlying system API failed. Code that is executing without administrative privileges attempted to read a performance counter. @@ -881,43 +863,43 @@ Registers a custom performance counter category containing a single counter of type on the local computer. A that is associated with the new system category, or performance object. - [!NOTE] -> To read performance counters from a non-interactive logon session in Windows Vista and later, Windows XP Professional x64 Edition, or Windows Server 2003, you must either be a member of the Performance Monitor Users group or have administrative privileges. -> -> To avoid having to elevate your privileges to access performance counters in Windows Vista and later, add yourself to the Performance Monitor Users group. -> -> In Windows Vista and later, User Account Control (UAC) determines the privileges of a user. If you are a member of the Built-in Administrators group, you are assigned two run-time access tokens: a standard user access token and an administrator access token. By default, you are in the standard user role. To execute the code that accesses performance counters, you must first elevate your privileges from standard user to administrator. You can do this when you start an application by right-clicking the application icon and indicating that you want to run as an administrator. - - - -## Examples - The following code example creates a and single with help text for each, using the method. - +> To read performance counters from a non-interactive logon session in Windows Vista and later, Windows XP Professional x64 Edition, or Windows Server 2003, you must either be a member of the Performance Monitor Users group or have administrative privileges. +> +> To avoid having to elevate your privileges to access performance counters in Windows Vista and later, add yourself to the Performance Monitor Users group. +> +> In Windows Vista and later, User Account Control (UAC) determines the privileges of a user. If you are a member of the Built-in Administrators group, you are assigned two run-time access tokens: a standard user access token and an administrator access token. By default, you are in the standard user role. To execute the code that accesses performance counters, you must first elevate your privileges from standard user to administrator. You can do this when you start an application by right-clicking the application icon and indicating that you want to run as an administrator. + + + +## Examples + The following code example creates a and single with help text for each, using the method. + :::code language="csharp" source="~/snippets/csharp/System.Diagnostics/PerformanceCounterCategory/.ctor/perfcountercatcreate.cs" id="Snippet2"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Diagnostics.PerformanceCounterCategory.OtherMembers/VB/perfcountercatcreate.vb" id="Snippet2"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Diagnostics.PerformanceCounterCategory.OtherMembers/VB/perfcountercatcreate.vb" id="Snippet2"::: + ]]> - is or is an empty string (""). - - -or- - - The counter that is specified by already exists. - - -or- - + is or is an empty string (""). + + -or- + + The counter that is specified by already exists. + + -or- + has invalid syntax. It might contain backslash characters ("\\") or have length greater than 80 characters. The category already exists on the local computer. - is . - - -or- - + is . + + -or- + is . A call to an underlying system API failed. Code that is executing without administrative privileges attempted to read a performance counter. @@ -969,49 +951,49 @@ Registers the custom performance counter category containing a single counter of type on the local computer. A that is associated with the new system category, or performance object. - enumeration is used to indicate whether a performance counter can have multiple instances. - - Performance counter categories installed with the .NET Framework 2.0 use separate shared memory, with each performance counter category having its own memory. You can specify the size of separate shared memory by creating a DWORD named FileMappingSize in the registry key HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\\*\*\Performance. The FileMappingSize value is set to the shared memory size of the category. The default size is 131072 decimal. If the FileMappingSize value is not present, the `fileMappingSize` attribute value for the `performanceCounters` element specified in the Machine.config file is used, causing additional overhead for configuration file processing. You can realize a performance improvement for application startup by setting the file mapping size in the registry. - + enumeration is used to indicate whether a performance counter can have multiple instances. + + Performance counter categories installed with the .NET Framework 2.0 use separate shared memory, with each performance counter category having its own memory. You can specify the size of separate shared memory by creating a DWORD named FileMappingSize in the registry key HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\\*\*\Performance. The FileMappingSize value is set to the shared memory size of the category. The default size is 131072 decimal. If the FileMappingSize value is not present, the `fileMappingSize` attribute value for the `performanceCounters` element specified in the Machine.config file is used, causing additional overhead for configuration file processing. You can realize a performance improvement for application startup by setting the file mapping size in the registry. + > [!NOTE] -> It is strongly recommended that new performance counter categories be created during the installation of the application, not during the execution of the application. This allows time for the operating system to refresh its list of registered performance counter categories. If the list has not been refreshed, the attempt to use the category will fail. - +> It is strongly recommended that new performance counter categories be created during the installation of the application, not during the execution of the application. This allows time for the operating system to refresh its list of registered performance counter categories. If the list has not been refreshed, the attempt to use the category will fail. + > [!NOTE] -> To read performance counters from a non-interactive logon session in Windows Vista and later, Windows XP Professional x64 Edition, or Windows Server 2003, you must either be a member of the Performance Monitor Users group or have administrative privileges. -> -> To avoid having to elevate your privileges to access performance counters in Windows Vista and later, add yourself to the Performance Monitor Users group. -> -> In Windows Vista and later, User Account Control (UAC) determines the privileges of a user. If you are a member of the Built-in Administrators group, you are assigned two run-time access tokens: a standard user access token and an administrator access token. By default, you are in the standard user role. To execute the code that accesses performance counters, you must first elevate your privileges from standard user to administrator. You can do this when you start an application by right-clicking the application icon and indicating that you want to run as an administrator. - - - -## Examples - The following code example shows the use of the method. The example shows how to create a custom, single instance performance counter category. - +> To read performance counters from a non-interactive logon session in Windows Vista and later, Windows XP Professional x64 Edition, or Windows Server 2003, you must either be a member of the Performance Monitor Users group or have administrative privileges. +> +> To avoid having to elevate your privileges to access performance counters in Windows Vista and later, add yourself to the Performance Monitor Users group. +> +> In Windows Vista and later, User Account Control (UAC) determines the privileges of a user. If you are a member of the Built-in Administrators group, you are assigned two run-time access tokens: a standard user access token and an administrator access token. By default, you are in the standard user role. To execute the code that accesses performance counters, you must first elevate your privileges from standard user to administrator. You can do this when you start an application by right-clicking the application icon and indicating that you want to run as an administrator. + + + +## Examples + The following code example shows the use of the method. The example shows how to create a custom, single instance performance counter category. + :::code language="csharp" source="~/snippets/csharp/System.Diagnostics/PerformanceCounterCategory/Create/program.cs" id="Snippet3"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Diagnostics.PerformanceCounterCategoryType/VB/program.vb" id="Snippet3"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Diagnostics.PerformanceCounterCategoryType/VB/program.vb" id="Snippet3"::: + ]]> - is or is an empty string (""). - - -or- - - The counter that is specified by already exists. - - -or- - + is or is an empty string (""). + + -or- + + The counter that is specified by already exists. + + -or- + has invalid syntax. It might contain backslash characters ("\\") or have length greater than 80 characters. The category already exists on the local computer. - is . - - -or- - + is . + + -or- + is . A call to an underlying system API failed. Code that is executing without administrative privileges attempted to read a performance counter. @@ -1055,26 +1037,26 @@ The name of the custom performance counter category to delete. Removes the category and its associated counters from the local computer. - [!NOTE] -> To read performance counters from a non-interactive logon session in Windows Vista and later, Windows XP Professional x64 Edition, or Windows Server 2003, you must either be a member of the Performance Monitor Users group or have administrative privileges. -> -> To avoid having to elevate your privileges to access performance counters in Windows Vista and later, add yourself to the Performance Monitor Users group. -> -> In Windows Vista and later, User Account Control (UAC) determines the privileges of a user. If you are a member of the Built-in Administrators group, you are assigned two run-time access tokens: a standard user access token and an administrator access token. By default, you are in the standard user role. To execute the code that accesses performance counters, you must first elevate your privileges from standard user to administrator. You can do this when you start an application by right-clicking the application icon and indicating that you want to run as an administrator. - - - -## Examples - The following code example uses the method to delete a and the objects that it contains. - +> To read performance counters from a non-interactive logon session in Windows Vista and later, Windows XP Professional x64 Edition, or Windows Server 2003, you must either be a member of the Performance Monitor Users group or have administrative privileges. +> +> To avoid having to elevate your privileges to access performance counters in Windows Vista and later, add yourself to the Performance Monitor Users group. +> +> In Windows Vista and later, User Account Control (UAC) determines the privileges of a user. If you are a member of the Built-in Administrators group, you are assigned two run-time access tokens: a standard user access token and an administrator access token. By default, you are in the standard user role. To execute the code that accesses performance counters, you must first elevate your privileges from standard user to administrator. You can do this when you start an application by right-clicking the application icon and indicating that you want to run as an administrator. + + + +## Examples + The following code example uses the method to delete a and the objects that it contains. + :::code language="csharp" source="~/snippets/csharp/System.Diagnostics/PerformanceCounterCategory/.ctor/perfCounterCatDelete.cs" id="Snippet6"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Diagnostics.PerformanceCounterCategory.OtherMembers/VB/perfcountercatdelete.vb" id="Snippet6"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Diagnostics.PerformanceCounterCategory.OtherMembers/VB/perfcountercatdelete.vb" id="Snippet6"::: + ]]> The parameter is . @@ -1136,27 +1118,27 @@ if the category is registered; otherwise, . - method can result in a noticeable performance penalty while all performance counters on the machine are checked for availability. If you are only writing to a performance counter, you can avoid the global search for performance counters by creating the performance counter when the application is installed and assuming the category exists when accessing the counter. There is no way to avoid the performance counter search when reading from performance counters. - + method can result in a noticeable performance penalty while all performance counters on the machine are checked for availability. If you are only writing to a performance counter, you can avoid the global search for performance counters by creating the performance counter when the application is installed and assuming the category exists when accessing the counter. There is no way to avoid the performance counter search when reading from performance counters. + > [!NOTE] -> To read performance counters from a non-interactive logon session in Windows Vista and later, Windows XP Professional x64 Edition, or Windows Server 2003, you must either be a member of the Performance Monitor Users group or have administrative privileges. -> -> To avoid having to elevate your privileges to access performance counters in Windows Vista and later, add yourself to the Performance Monitor Users group. -> -> In Windows Vista and later, User Account Control (UAC) determines the privileges of a user. If you are a member of the Built-in Administrators group, you are assigned two run-time access tokens: a standard user access token and an administrator access token. By default, you are in the standard user role. To execute the code that accesses performance counters, you must first elevate your privileges from standard user to administrator. You can do this when you start an application by right-clicking the application icon and indicating that you want to run as an administrator. - - - -## Examples - The following code example determines whether a object named "orders" exists. If not, it creates the object by using a object that contains two performance counters. - +> To read performance counters from a non-interactive logon session in Windows Vista and later, Windows XP Professional x64 Edition, or Windows Server 2003, you must either be a member of the Performance Monitor Users group or have administrative privileges. +> +> To avoid having to elevate your privileges to access performance counters in Windows Vista and later, add yourself to the Performance Monitor Users group. +> +> In Windows Vista and later, User Account Control (UAC) determines the privileges of a user. If you are a member of the Built-in Administrators group, you are assigned two run-time access tokens: a standard user access token and an administrator access token. By default, you are in the standard user role. To execute the code that accesses performance counters, you must first elevate your privileges from standard user to administrator. You can do this when you start an application by right-clicking the application icon and indicating that you want to run as an administrator. + + + +## Examples + The following code example determines whether a object named "orders" exists. If not, it creates the object by using a object that contains two performance counters. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/PerfCounter_ccd/CPP/ccd.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Diagnostics/PerformanceCounterCategory/Create/ccd.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/PerfCounter_ccd/VB/ccd.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/PerfCounter_ccd/VB/ccd.vb" id="Snippet1"::: + ]]> The parameter is . @@ -1205,41 +1187,41 @@ if the category is registered; otherwise, . - method can result in a noticeable performance penalty while all performance counters on the machine are checked for availability. If you are only writing to a performance counter, you can avoid the global search for performance counters by creating the performance counter when the application is installed and assuming the category exists when accessing the counter. There is no way to avoid the performance counter search when reading from performance counters. - + method can result in a noticeable performance penalty while all performance counters on the machine are checked for availability. If you are only writing to a performance counter, you can avoid the global search for performance counters by creating the performance counter when the application is installed and assuming the category exists when accessing the counter. There is no way to avoid the performance counter search when reading from performance counters. + > [!NOTE] -> To read performance counters from a non-interactive logon session in Windows Vista and later, Windows XP Professional x64 Edition, or Windows Server 2003, you must either be a member of the Performance Monitor Users group or have administrative privileges. -> -> To avoid having to elevate your privileges to access performance counters in Windows Vista and later, add yourself to the Performance Monitor Users group. -> -> In Windows Vista and later, User Account Control (UAC) determines the privileges of a user. If you are a member of the Built-in Administrators group, you are assigned two run-time access tokens: a standard user access token and an administrator access token. By default, you are in the standard user role. To execute the code that accesses performance counters, you must first elevate your privileges from standard user to administrator. You can do this when you start an application by right-clicking the application icon and indicating that you want to run as an administrator. - - - -## Examples - The following example determines whether a object named `Orders` exists. If it does not exist, the example creates the object by using a object that contains two performance counters. - +> To read performance counters from a non-interactive logon session in Windows Vista and later, Windows XP Professional x64 Edition, or Windows Server 2003, you must either be a member of the Performance Monitor Users group or have administrative privileges. +> +> To avoid having to elevate your privileges to access performance counters in Windows Vista and later, add yourself to the Performance Monitor Users group. +> +> In Windows Vista and later, User Account Control (UAC) determines the privileges of a user. If you are a member of the Built-in Administrators group, you are assigned two run-time access tokens: a standard user access token and an administrator access token. By default, you are in the standard user role. To execute the code that accesses performance counters, you must first elevate your privileges from standard user to administrator. You can do this when you start an application by right-clicking the application icon and indicating that you want to run as an administrator. + + + +## Examples + The following example determines whether a object named `Orders` exists. If it does not exist, the example creates the object by using a object that contains two performance counters. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/PerfCounter_ccd/CPP/ccd.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Diagnostics/PerformanceCounterCategory/Create/ccd.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/PerfCounter_ccd/VB/ccd.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/PerfCounter_ccd/VB/ccd.vb" id="Snippet1"::: + ]]> The parameter is . - The parameter is an empty string (""). - - -or- - + The parameter is an empty string (""). + + -or- + The parameter is invalid. A call to an underlying system API failed. The network path cannot be found. - The caller does not have the required permission. - - -or- - + The caller does not have the required permission. + + -or- + Code that is executing without administrative privileges attempted to read a performance counter. @@ -1292,26 +1274,26 @@ Retrieves a list of the performance counter categories that are registered on the local computer. An array of objects indicating the categories that are registered on the local computer. - [!NOTE] -> To read performance counters from a non-interactive logon session in Windows Vista and later, Windows XP Professional x64 Edition, or Windows Server 2003, you must either be a member of the Performance Monitor Users group or have administrative privileges. -> -> To avoid having to elevate your privileges to access performance counters in Windows Vista and later, add yourself to the Performance Monitor Users group. -> -> In Windows Vista and later, User Account Control (UAC) determines the privileges of a user. If you are a member of the Built-in Administrators group, you are assigned two run-time access tokens: a standard user access token and an administrator access token. By default, you are in the standard user role. To execute the code that accesses performance counters, you must first elevate your privileges from standard user to administrator. You can do this when you start an application by right-clicking the application icon and indicating that you want to run as an administrator. - - - -## Examples - The following code example uses the method to return an array of objects from the local computer or a specified computer. It converts the array into an array of category names, which it sorts and displays for the user. The overload is selected based on whether a computer name was specified. - +> To read performance counters from a non-interactive logon session in Windows Vista and later, Windows XP Professional x64 Edition, or Windows Server 2003, you must either be a member of the Performance Monitor Users group or have administrative privileges. +> +> To avoid having to elevate your privileges to access performance counters in Windows Vista and later, add yourself to the Performance Monitor Users group. +> +> In Windows Vista and later, User Account Control (UAC) determines the privileges of a user. If you are a member of the Built-in Administrators group, you are assigned two run-time access tokens: a standard user access token and an administrator access token. By default, you are in the standard user role. To execute the code that accesses performance counters, you must first elevate your privileges from standard user to administrator. You can do this when you start an application by right-clicking the application icon and indicating that you want to run as an administrator. + + + +## Examples + The following code example uses the method to return an array of objects from the local computer or a specified computer. It converts the array into an array of category names, which it sorts and displays for the user. The overload is selected based on whether a computer name was specified. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR_System/system.Diagnostics.PerformanceCounterCategory.GetMembers/cpp/perfcountergetcat.cpp" id="Snippet2"::: :::code language="csharp" source="~/snippets/csharp/System.Diagnostics/PerformanceCounterCategory/GetCategories/perfcountergetcat.cs" id="Snippet2"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Diagnostics.PerformanceCounterCategory.GetMembers/VB/perfcountercatgetcat.vb" id="Snippet2"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Diagnostics.PerformanceCounterCategory.GetMembers/VB/perfcountercatgetcat.vb" id="Snippet2"::: + ]]> A call to an underlying system API failed. @@ -1354,27 +1336,27 @@ Retrieves a list of the performance counter categories that are registered on the specified computer. An array of objects indicating the categories that are registered on the specified computer. - [!NOTE] -> To read performance counters from a non-interactive logon session in Windows Vista and later, Windows XP Professional x64 Edition, or Windows Server 2003, you must either be a member of the Performance Monitor Users group or have administrative privileges. -> -> To avoid having to elevate your privileges to access performance counters in Windows Vista and later, add yourself to the Performance Monitor Users group. -> -> In Windows Vista and later, User Account Control (UAC) determines the privileges of a user. If you are a member of the Built-in Administrators group, you are assigned two run-time access tokens: a standard user access token and an administrator access token. By default, you are in the standard user role. To execute the code that accesses performance counters, you must first elevate your privileges from standard user to administrator. You can do this when you start an application by right-clicking the application icon and indicating that you want to run as an administrator. - - - -## Examples - The following code example uses the method to return an array of objects from the local computer or a specified computer. It converts the array into an array of category names, which it sorts and displays for the user. The overload is selected based on whether a computer name was specified. - +> To read performance counters from a non-interactive logon session in Windows Vista and later, Windows XP Professional x64 Edition, or Windows Server 2003, you must either be a member of the Performance Monitor Users group or have administrative privileges. +> +> To avoid having to elevate your privileges to access performance counters in Windows Vista and later, add yourself to the Performance Monitor Users group. +> +> In Windows Vista and later, User Account Control (UAC) determines the privileges of a user. If you are a member of the Built-in Administrators group, you are assigned two run-time access tokens: a standard user access token and an administrator access token. By default, you are in the standard user role. To execute the code that accesses performance counters, you must first elevate your privileges from standard user to administrator. You can do this when you start an application by right-clicking the application icon and indicating that you want to run as an administrator. + + + +## Examples + The following code example uses the method to return an array of objects from the local computer or a specified computer. It converts the array into an array of category names, which it sorts and displays for the user. The overload is selected based on whether a computer name was specified. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR_System/system.Diagnostics.PerformanceCounterCategory.GetMembers/cpp/perfcountergetcat.cpp" id="Snippet2"::: :::code language="csharp" source="~/snippets/csharp/System.Diagnostics/PerformanceCounterCategory/GetCategories/perfcountergetcat.cs" id="Snippet2"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Diagnostics.PerformanceCounterCategory.GetMembers/VB/perfcountercatgetcat.vb" id="Snippet2"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Diagnostics.PerformanceCounterCategory.GetMembers/VB/perfcountercatgetcat.vb" id="Snippet2"::: + ]]> The parameter is invalid. @@ -1424,29 +1406,29 @@ Retrieves a list of the counters in a performance counter category that contains exactly one instance. An array of objects indicating the counters that are associated with this single-instance performance counter category. - class overview. - + class overview. + > [!NOTE] -> To read performance counters from a non-interactive logon session in Windows Vista and later, Windows XP Professional x64 Edition, or Windows Server 2003, you must either be a member of the Performance Monitor Users group or have administrative privileges. -> -> To avoid having to elevate your privileges to access performance counters in Windows Vista and later, add yourself to the Performance Monitor Users group. -> -> In Windows Vista and later, User Account Control (UAC) determines the privileges of a user. If you are a member of the Built-in Administrators group, you are assigned two run-time access tokens: a standard user access token and an administrator access token. By default, you are in the standard user role. To execute the code that accesses performance counters, you must first elevate your privileges from standard user to administrator. You can do this when you start an application by right-clicking the application icon and indicating that you want to run as an administrator. - - - -## Examples - The following code example gets a list of the objects in a . It first creates a with the appropriate constructor, based on whether a computer name was specified. It then uses the method to return an array of objects, selecting the overload based on whether an instance name was specified. - - This overload fails unless it is used with a single-instance category. - +> To read performance counters from a non-interactive logon session in Windows Vista and later, Windows XP Professional x64 Edition, or Windows Server 2003, you must either be a member of the Performance Monitor Users group or have administrative privileges. +> +> To avoid having to elevate your privileges to access performance counters in Windows Vista and later, add yourself to the Performance Monitor Users group. +> +> In Windows Vista and later, User Account Control (UAC) determines the privileges of a user. If you are a member of the Built-in Administrators group, you are assigned two run-time access tokens: a standard user access token and an administrator access token. By default, you are in the standard user role. To execute the code that accesses performance counters, you must first elevate your privileges from standard user to administrator. You can do this when you start an application by right-clicking the application icon and indicating that you want to run as an administrator. + + + +## Examples + The following code example gets a list of the objects in a . It first creates a with the appropriate constructor, based on whether a computer name was specified. It then uses the method to return an array of objects, selecting the overload based on whether an instance name was specified. + + This overload fails unless it is used with a single-instance category. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR_System/system.Diagnostics.PerformanceCounterCategory.GetMembers/cpp/perfcountercatgetcount.cpp" id="Snippet4"::: :::code language="csharp" source="~/snippets/csharp/System.Diagnostics/PerformanceCounterCategory/GetCategories/perfcountercatgetcount.cs" id="Snippet4"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Diagnostics.PerformanceCounterCategory.GetMembers/VB/perfcountercatgetcount.vb" id="Snippet4"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Diagnostics.PerformanceCounterCategory.GetMembers/VB/perfcountercatgetcount.vb" id="Snippet4"::: + ]]> The category is not a single instance. @@ -1491,38 +1473,38 @@ Retrieves a list of the counters in a performance counter category that contains one or more instances. An array of objects indicating the counters that are associated with the specified object instance of this performance counter category. - class overview. - + class overview. + > [!NOTE] -> To read performance counters from a non-interactive logon session in Windows Vista and later, Windows XP Professional x64 Edition, or Windows Server 2003, you must either be a member of the Performance Monitor Users group or have administrative privileges. -> -> To avoid having to elevate your privileges to access performance counters in Windows Vista and later, add yourself to the Performance Monitor Users group. -> -> In Windows Vista and later, User Account Control (UAC) determines the privileges of a user. If you are a member of the Built-in Administrators group, you are assigned two run-time access tokens: a standard user access token and an administrator access token. By default, you are in the standard user role. To execute the code that accesses performance counters, you must first elevate your privileges from standard user to administrator. You can do this when you start an application by right-clicking the application icon and indicating that you want to run as an administrator. - - - -## Examples - The following code example gets a list of the objects in a . It first creates a with the appropriate constructor, based on whether a computer name was specified. It then uses the method to return an array of objects, selecting the overload based on whether an instance name was specified. - - This overload fails unless it is used with a category that contains instances. - +> To read performance counters from a non-interactive logon session in Windows Vista and later, Windows XP Professional x64 Edition, or Windows Server 2003, you must either be a member of the Performance Monitor Users group or have administrative privileges. +> +> To avoid having to elevate your privileges to access performance counters in Windows Vista and later, add yourself to the Performance Monitor Users group. +> +> In Windows Vista and later, User Account Control (UAC) determines the privileges of a user. If you are a member of the Built-in Administrators group, you are assigned two run-time access tokens: a standard user access token and an administrator access token. By default, you are in the standard user role. To execute the code that accesses performance counters, you must first elevate your privileges from standard user to administrator. You can do this when you start an application by right-clicking the application icon and indicating that you want to run as an administrator. + + + +## Examples + The following code example gets a list of the objects in a . It first creates a with the appropriate constructor, based on whether a computer name was specified. It then uses the method to return an array of objects, selecting the overload based on whether an instance name was specified. + + This overload fails unless it is used with a category that contains instances. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR_System/system.Diagnostics.PerformanceCounterCategory.GetMembers/cpp/perfcountercatgetcount.cpp" id="Snippet4"::: :::code language="csharp" source="~/snippets/csharp/System.Diagnostics/PerformanceCounterCategory/GetCategories/perfcountercatgetcount.cs" id="Snippet4"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Diagnostics.PerformanceCounterCategory.GetMembers/VB/perfcountercatgetcount.vb" id="Snippet4"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Diagnostics.PerformanceCounterCategory.GetMembers/VB/perfcountercatgetcount.vb" id="Snippet4"::: + ]]> The parameter is . - The property for this instance has not been set. - - -or- - + The property for this instance has not been set. + + -or- + The category does not contain the instance that is specified by the parameter. A call to an underlying system API failed. Code that is executing without administrative privileges attempted to read a performance counter. @@ -1561,32 +1543,32 @@ Retrieves the list of performance object instances that are associated with this category. An array of strings representing the performance object instance names that are associated with this category or, if the category contains only one performance object instance, a single-entry array that contains an empty string (""). - [!NOTE] -> To read performance counters from a non-interactive logon session in Windows Vista and later, Windows XP Professional x64 Edition, or Windows Server 2003, you must either be a member of the Performance Monitor Users group or have administrative privileges. -> -> To avoid having to elevate your privileges to access performance counters in Windows Vista and later, add yourself to the Performance Monitor Users group. -> -> In Windows Vista and later, User Account Control (UAC) determines the privileges of a user. If you are a member of the Built-in Administrators group, you are assigned two run-time access tokens: a standard user access token and an administrator access token. By default, you are in the standard user role. To execute the code that accesses performance counters, you must first elevate your privileges from standard user to administrator. You can do this when you start an application by right-clicking the application icon and indicating that you want to run as an administrator. - - - -## Examples - The following code example gets a list of the objects in a . It first creates a object, using the appropriate constructor based on whether a computer name was specified. It then uses to return the instance names as an array of , which it sorts and displays. - +> To read performance counters from a non-interactive logon session in Windows Vista and later, Windows XP Professional x64 Edition, or Windows Server 2003, you must either be a member of the Performance Monitor Users group or have administrative privileges. +> +> To avoid having to elevate your privileges to access performance counters in Windows Vista and later, add yourself to the Performance Monitor Users group. +> +> In Windows Vista and later, User Account Control (UAC) determines the privileges of a user. If you are a member of the Built-in Administrators group, you are assigned two run-time access tokens: a standard user access token and an administrator access token. By default, you are in the standard user role. To execute the code that accesses performance counters, you must first elevate your privileges from standard user to administrator. You can do this when you start an application by right-clicking the application icon and indicating that you want to run as an administrator. + + + +## Examples + The following code example gets a list of the objects in a . It first creates a object, using the appropriate constructor based on whether a computer name was specified. It then uses to return the instance names as an array of , which it sorts and displays. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR_System/system.Diagnostics.PerformanceCounterCategory.GetMembers/cpp/perfcountercatgetinst.cpp" id="Snippet6"::: :::code language="csharp" source="~/snippets/csharp/System.Diagnostics/PerformanceCounterCategory/GetCategories/perfcountercatgetinst.cs" id="Snippet6"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Diagnostics.PerformanceCounterCategory.GetMembers/VB/perfcountercatgetinst.vb" id="Snippet6"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Diagnostics.PerformanceCounterCategory.GetMembers/VB/perfcountercatgetinst.vb" id="Snippet6"::: + ]]> - The property is . The property might not have been set. - - -or- - + The property is . The property might not have been set. + + -or- + The category does not have an associated instance. A call to an underlying system API failed. Code that is executing without administrative privileges attempted to read a performance counter. @@ -1640,26 +1622,26 @@ if the category contains the specified performance object instance; otherwise, . - is not `static`. It requires you to create a object and to set the property. - + is not `static`. It requires you to create a object and to set the property. + > [!NOTE] -> To read performance counters from a non-interactive logon session in Windows Vista and later, Windows XP Professional x64 Edition, or Windows Server 2003, you must either be a member of the Performance Monitor Users group or have administrative privileges. -> -> To avoid having to elevate your privileges to access performance counters in Windows Vista and later, add yourself to the Performance Monitor Users group. -> -> In Windows Vista and later, User Account Control (UAC) determines the privileges of a user. If you are a member of the Built-in Administrators group, you are assigned two run-time access tokens: a standard user access token and an administrator access token. By default, you are in the standard user role. To execute the code that accesses performance counters, you must first elevate your privileges from standard user to administrator. You can do this when you start an application by right-clicking the application icon and indicating that you want to run as an administrator. - - - -## Examples - The following code example determines whether a instance exists within a . It first creates a object, using the appropriate constructor based on whether a computer name was specified. It then uses to determine whether the specified instance exists, then informs the user. If no instance name is specified, the example uses the default single-instance name. - +> To read performance counters from a non-interactive logon session in Windows Vista and later, Windows XP Professional x64 Edition, or Windows Server 2003, you must either be a member of the Performance Monitor Users group or have administrative privileges. +> +> To avoid having to elevate your privileges to access performance counters in Windows Vista and later, add yourself to the Performance Monitor Users group. +> +> In Windows Vista and later, User Account Control (UAC) determines the privileges of a user. If you are a member of the Built-in Administrators group, you are assigned two run-time access tokens: a standard user access token and an administrator access token. By default, you are in the standard user role. To execute the code that accesses performance counters, you must first elevate your privileges from standard user to administrator. You can do this when you start an application by right-clicking the application icon and indicating that you want to run as an administrator. + + + +## Examples + The following code example determines whether a instance exists within a . It first creates a object, using the appropriate constructor based on whether a computer name was specified. It then uses to determine whether the specified instance exists, then informs the user. If no instance name is specified, the example uses the default single-instance name. + :::code language="csharp" source="~/snippets/csharp/System.Diagnostics/PerformanceCounterCategory/CounterExists/perfcounterobjinstexists.cs" id="Snippet2"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Diagnostics.PerformanceCounterCategory.ExistMembers/VB/perfcountercatobjinstexists.vb" id="Snippet2"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Diagnostics.PerformanceCounterCategory.ExistMembers/VB/perfcountercatobjinstexists.vb" id="Snippet2"::: + ]]> The property is . The property might not have been set. @@ -1717,32 +1699,32 @@ if the category contains the specified performance object instance; otherwise, . - [!NOTE] -> To read performance counters from a non-interactive logon session in Windows Vista and later, Windows XP Professional x64 Edition, or Windows Server 2003, you must either be a member of the Performance Monitor Users group or have administrative privileges. -> -> To avoid having to elevate your privileges to access performance counters in Windows Vista and later, add yourself to the Performance Monitor Users group. -> -> In Windows Vista and later, User Account Control (UAC) determines the privileges of a user. If you are a member of the Built-in Administrators group, you are assigned two run-time access tokens: a standard user access token and an administrator access token. By default, you are in the standard user role. To execute the code that accesses performance counters, you must first elevate your privileges from standard user to administrator. You can do this when you start an application by right-clicking the application icon and indicating that you want to run as an administrator. - - - -## Examples - The following code example uses the static overloads of to determine whether the given instance exists in the . The overload is selected based on whether a computer name is specified. If no instance name is specified, the example uses the default single-instance name. - +> To read performance counters from a non-interactive logon session in Windows Vista and later, Windows XP Professional x64 Edition, or Windows Server 2003, you must either be a member of the Performance Monitor Users group or have administrative privileges. +> +> To avoid having to elevate your privileges to access performance counters in Windows Vista and later, add yourself to the Performance Monitor Users group. +> +> In Windows Vista and later, User Account Control (UAC) determines the privileges of a user. If you are a member of the Built-in Administrators group, you are assigned two run-time access tokens: a standard user access token and an administrator access token. By default, you are in the standard user role. To execute the code that accesses performance counters, you must first elevate your privileges from standard user to administrator. You can do this when you start an application by right-clicking the application icon and indicating that you want to run as an administrator. + + + +## Examples + The following code example uses the static overloads of to determine whether the given instance exists in the . The overload is selected based on whether a computer name is specified. If no instance name is specified, the example uses the default single-instance name. + :::code language="csharp" source="~/snippets/csharp/System.Diagnostics/PerformanceCounterCategory/CounterExists/perfcountercatstatinstexists.cs" id="Snippet10"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Diagnostics.PerformanceCounterCategory.ExistMembers/VB/perfcountercatstatinstexists.vb" id="Snippet10"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Diagnostics.PerformanceCounterCategory.ExistMembers/VB/perfcountercatstatinstexists.vb" id="Snippet10"::: + ]]> - The parameter is . - - -or- - + The parameter is . + + -or- + The parameter is . The parameter is an empty string (""). A call to an underlying system API failed. @@ -1793,39 +1775,39 @@ if the category contains the specified performance object instance; otherwise, . - [!NOTE] -> To read performance counters from a non-interactive logon session in Windows Vista and later, Windows XP Professional x64 Edition, or Windows Server 2003, you must either be a member of the Performance Monitor Users group or have administrative privileges. -> -> To avoid having to elevate your privileges to access performance counters in Windows Vista and later, add yourself to the Performance Monitor Users group. -> -> In Windows Vista and later, User Account Control (UAC) determines the privileges of a user. If you are a member of the Built-in Administrators group, you are assigned two run-time access tokens: a standard user access token and an administrator access token. By default, you are in the standard user role. To execute the code that accesses performance counters, you must first elevate your privileges from standard user to administrator. You can do this when you start an application by right-clicking the application icon and indicating that you want to run as an administrator. - - - -## Examples - The following code example uses the static overloads of to determine whether the given instance exists in the . The overload is selected based on whether a computer name is specified. If no instance name is specified, the example uses the default single-instance name. - +> To read performance counters from a non-interactive logon session in Windows Vista and later, Windows XP Professional x64 Edition, or Windows Server 2003, you must either be a member of the Performance Monitor Users group or have administrative privileges. +> +> To avoid having to elevate your privileges to access performance counters in Windows Vista and later, add yourself to the Performance Monitor Users group. +> +> In Windows Vista and later, User Account Control (UAC) determines the privileges of a user. If you are a member of the Built-in Administrators group, you are assigned two run-time access tokens: a standard user access token and an administrator access token. By default, you are in the standard user role. To execute the code that accesses performance counters, you must first elevate your privileges from standard user to administrator. You can do this when you start an application by right-clicking the application icon and indicating that you want to run as an administrator. + + + +## Examples + The following code example uses the static overloads of to determine whether the given instance exists in the . The overload is selected based on whether a computer name is specified. If no instance name is specified, the example uses the default single-instance name. + :::code language="csharp" source="~/snippets/csharp/System.Diagnostics/PerformanceCounterCategory/CounterExists/perfcountercatstatinstexists.cs" id="Snippet10"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Diagnostics.PerformanceCounterCategory.ExistMembers/VB/perfcountercatstatinstexists.vb" id="Snippet10"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Diagnostics.PerformanceCounterCategory.ExistMembers/VB/perfcountercatstatinstexists.vb" id="Snippet10"::: + ]]> - The parameter is . - - -or- - + The parameter is . + + -or- + The parameter is . - The parameter is an empty string (""). - - -or- - + The parameter is an empty string (""). + + -or- + The parameter is invalid. A call to an underlying system API failed. Code that is executing without administrative privileges attempted to read a performance counter. @@ -1872,14 +1854,14 @@ Gets or sets the name of the computer on which this category exists. The name of the computer on which the performance counter category and its associated counters exist. - with the constructor. It prompts the user for the and the computer names, then sets the and properties from the entered values. It then displays the values of the , , and properties, or it displays an error message if the cannot be accessed. - + with the constructor. It prompts the user for the and the computer names, then sets the and properties from the entered values. It then displays the values of the , , and properties, or it displays an error message if the cannot be accessed. + :::code language="csharp" source="~/snippets/csharp/System.Diagnostics/PerformanceCounterCategory/.ctor/perfCounterCatProps.cs" id="Snippet8"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Diagnostics.PerformanceCounterCategory.OtherMembers/VB/perfcountercatprops.vb" id="Snippet8"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Diagnostics.PerformanceCounterCategory.OtherMembers/VB/perfcountercatprops.vb" id="Snippet8"::: + ]]> The syntax is invalid. @@ -1919,28 +1901,28 @@ Reads all the counter and performance object instance data that is associated with this performance counter category. An that contains the counter and performance object instance data for the category. - property before you call . - - Reading the entire category at once can be as efficient as reading a single counter because of the way that the system provides the data. - + property before you call . + + Reading the entire category at once can be as efficient as reading a single counter because of the way that the system provides the data. + > [!NOTE] -> To read performance counters from a non-interactive logon session in Windows Vista and later, Windows XP Professional x64 Edition, or Windows Server 2003, you must either be a member of the Performance Monitor Users group or have administrative privileges. -> -> To avoid having to elevate your privileges to access performance counters in Windows Vista and later, add yourself to the Performance Monitor Users group. -> -> In Windows Vista and later, User Account Control (UAC) determines the privileges of a user. If you are a member of the Built-in Administrators group, you are assigned two run-time access tokens: a standard user access token and an administrator access token. By default, you are in the standard user role. To execute the code that accesses performance counters, you must first elevate your privileges from standard user to administrator. You can do this when you start an application by right-clicking the application icon and indicating that you want to run as an administrator. - - - -## Examples - The following code example creates a for a specified name. It then uses to return an that contains instance data for all the instances of the objects within the . - +> To read performance counters from a non-interactive logon session in Windows Vista and later, Windows XP Professional x64 Edition, or Windows Server 2003, you must either be a member of the Performance Monitor Users group or have administrative privileges. +> +> To avoid having to elevate your privileges to access performance counters in Windows Vista and later, add yourself to the Performance Monitor Users group. +> +> In Windows Vista and later, User Account Control (UAC) determines the privileges of a user. If you are a member of the Built-in Administrators group, you are assigned two run-time access tokens: a standard user access token and an administrator access token. By default, you are in the standard user role. To execute the code that accesses performance counters, you must first elevate your privileges from standard user to administrator. You can do this when you start an application by right-clicking the application icon and indicating that you want to run as an administrator. + + + +## Examples + The following code example creates a for a specified name. It then uses to return an that contains instance data for all the instances of the objects within the . + :::code language="csharp" source="~/snippets/csharp/System.Diagnostics/InstanceData/Overview/instdatacopyto.cs" id="Snippet6"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Diagnostics.InstanceData.CopyTo/VB/instdatacopyto.vb" id="Snippet6"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Diagnostics.InstanceData.CopyTo/VB/instdatacopyto.vb" id="Snippet6"::: + ]]> The property is . The property might not have been set. diff --git a/xml/System.Diagnostics/ProcessStartInfo.xml b/xml/System.Diagnostics/ProcessStartInfo.xml index e0214dc86fe..8fa0a9994b4 100644 --- a/xml/System.Diagnostics/ProcessStartInfo.xml +++ b/xml/System.Diagnostics/ProcessStartInfo.xml @@ -1734,8 +1734,8 @@ You can use asynchronous read operations to avoid these dependencies and their d System.String - Gets or sets the user name to use when starting the process. If you use the UPN format, @, the property must be . - The user name to use when starting the process. If you use the UPN format, @, the property must be . + Gets or sets the user name to use when starting the process. If you use the UPN format, user@DNS_domain_name, the property must be . + The user name to use when starting the process. is . - is less than 0 or greater than or equal to the length. + is less than 0 or greater than or equal to the length. diff --git a/xml/System.Diagnostics/TraceListenerCollection.xml b/xml/System.Diagnostics/TraceListenerCollection.xml index 2dcba1301ee..00eb858f2af 100644 --- a/xml/System.Diagnostics/TraceListenerCollection.xml +++ b/xml/System.Diagnostics/TraceListenerCollection.xml @@ -60,26 +60,26 @@ Provides a thread-safe list of objects. - list is used to specify the output listeners for the and the collections. You cannot create an instance of this class. - - This list is thread-safe, however the methods used to access the list and the enumerator do not take synchronization locks. Instead, the collection is copied, the copy is modified, and a reference is set to the copy of the collection. Methods like , , and modify the elements in the collection. - - The class provides the property for information about the list. It also provides the following methods: , , . - - This class also provides the following methods to modify the list: , , , and . The method copies a part of the list to an array. The method deletes the list member at a specified index number. - - - -## Examples - The following example creates a that writes to the console screen. The code then adds the new listener to the . - + list is used to specify the output listeners for the and the collections. You cannot create an instance of this class. + + This list is thread-safe, however the methods used to access the list and the enumerator do not take synchronization locks. Instead, the collection is copied, the copy is modified, and a reference is set to the copy of the collection. Methods like , , and modify the elements in the collection. + + The class provides the property for information about the list. It also provides the following methods: , , . + + This class also provides the following methods to modify the list: , , , and . The method copies a part of the list to an array. The method deletes the list member at a specified index number. + + + +## Examples + The following example creates a that writes to the console screen. The code then adds the new listener to the . + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR_Classic/classic Trace.Listeners Example/CPP/source.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Diagnostics/Trace/Listeners/source.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_Classic/classic Trace.Listeners Example/VB/source.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_Classic/classic Trace.Listeners Example/VB/source.vb" id="Snippet1"::: + ]]> @@ -133,15 +133,15 @@ Adds a to the list. The position at which the new listener was inserted. - that outputs to the console screen. The code then adds the new listener to the . - + that outputs to the console screen. The code then adds the new listener to the . + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR_Classic/classic TraceListenerCollection.Add Example/CPP/source.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Diagnostics/TraceListenerCollection/Add/source.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_Classic/classic TraceListenerCollection.Add Example/VB/source.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_Classic/classic TraceListenerCollection.Add Example/VB/source.vb" id="Snippet1"::: + ]]> @@ -365,11 +365,11 @@ if the listener is in the list; otherwise, . - method can confirm the existence of a before you perform further operations. - + method can confirm the existence of a before you perform further operations. + ]]> @@ -634,13 +634,13 @@ A to insert in the list. Inserts the listener at the specified index. - The is not a valid index in the list. @@ -708,11 +708,11 @@ Gets or sets the at the specified index. A with the specified index. - to access that . For example, to get the third , you need to specify `myTraceListenerColl[2]`. - + to access that . For example, to get the third , you need to specify `myTraceListenerColl[2]`. + ]]> The value is . @@ -775,11 +775,11 @@ Gets the first in the list with the specified name. The first in the list with the given . This item returns if no with the given name can be found. - property is case-sensitive when searching for names. That is, if two listeners exist with the names "Lname" and "lname", property will find only the with the that you specify, not both. - + property is case-sensitive when searching for names. That is, if two listeners exist with the names "Lname" and "lname", property will find only the with the that you specify, not both. + ]]> @@ -895,11 +895,11 @@ The name of the to remove from the list. Removes from the collection the first with the specified name. - method will find the specific listener you name. - + method will find the specific listener you name. + ]]> @@ -956,11 +956,11 @@ The zero-based index of the to remove from the list. Removes from the collection the at the specified index. - to delete that . For example, to remove the third , you need to specify `myTraceListenerColl.RemoveAt(2)`. - + to delete that . For example, to remove the third , you need to specify `myTraceListenerColl.RemoveAt(2)`. + ]]> The is not a valid index in the list. @@ -1020,11 +1020,11 @@ The zero-based index in at which copying begins. Copies a section of the current to the specified array of objects. - method of the class to copy all or part of the collection to an array. - + method of the class to copy all or part of the collection to an array. + ]]> @@ -1177,18 +1177,18 @@ This member is an explicit interface member implementation. It can be used only Adds a trace listener to the . The position into which the new trace listener was inserted. - method to add a new trace listener to the collection. - + method to add a new trace listener to the collection. + ]]> - is . - - -or- - + is . + + -or- + is not a . @@ -1239,11 +1239,11 @@ This member is an explicit interface member implementation. It can be used only if the is found in the ; otherwise, . - method of the class to determine whether the collection contains a specific object. - + method of the class to determine whether the collection contains a specific object. + ]]> @@ -1294,11 +1294,11 @@ This member is an explicit interface member implementation. It can be used only Determines the index of a specific object in the . The index of if found in the ; otherwise, -1. - method of the class to determine the index of a object in the collection. - + method of the class to determine the index of a object in the collection. + ]]> @@ -1350,11 +1350,11 @@ This member is an explicit interface member implementation. It can be used only The object to insert into the . Inserts a object at the specified position in the . - method of the class to insert a object into the collection. - + method of the class to insert a object into the collection. + ]]> @@ -1511,15 +1511,15 @@ This member is an explicit interface member implementation. It can be used only - The zero-based index of the to get. + The zero-based index of the value to get. Gets or sets the at the specified index in the . The at the specified index. - property or the indexer of the class to get or set a in the collection. - + property or the indexer of the class to get or set a in the collection. + ]]> @@ -1569,11 +1569,11 @@ This member is an explicit interface member implementation. It can be used only The object to remove from the . Removes an object from the . - method of the class to remove a from the collection. - + method of the class to remove a from the collection. + ]]> diff --git a/xml/System.Diagnostics/XmlWriterTraceListener.xml b/xml/System.Diagnostics/XmlWriterTraceListener.xml index 32477071c6e..ce6c758e6e7 100644 --- a/xml/System.Diagnostics/XmlWriterTraceListener.xml +++ b/xml/System.Diagnostics/XmlWriterTraceListener.xml @@ -33,81 +33,81 @@ Directs tracing or debugging output as XML-encoded data to a or to a , such as a . - [!NOTE] -> You must have unmanaged code permission to create an instance of the class. - - The class converts tracing and debugging information into an XML-encoded text stream. The description of the XML output is shown in the tables that follow. You can use the [Service Trace Viewer Tool (SvcTraceViewer.exe)](https://go.microsoft.com/fwlink/p/?LinkId=240129) to display the XML output. - -You can create an in your code. Alternatively, for .NET Framework apps, you can enable or disable an through the application configuration file and then use the configured in your application. To configure an , edit the configuration file that corresponds to the name of your application. In this file, you can add or remove a listener, set the properties for a listener, or remove listeners. The configuration file should be formatted like the following example. - -```xml - - - - - - - - - - -``` - - The class inherits the property from the base class . The property allows an additional level of trace output filtering at the listener. If there is a filter present, the `Trace` methods of the trace listener call the method of the filter to determine whether to emit the trace. - +> You must have unmanaged code permission to create an instance of the class. + + The class converts tracing and debugging information into an XML-encoded text stream. The description of the XML output is shown in the tables that follow. You can use the [Service Trace Viewer Tool (SvcTraceViewer.exe)](https://go.microsoft.com/fwlink/p/?LinkId=240129) to display the XML output. + +You can create an in your code. Alternatively, for .NET Framework apps, you can enable or disable an through the application configuration file and then use the configured in your application. To configure an , edit the configuration file that corresponds to the name of your application. In this file, you can add or remove a listener, set the properties for a listener, or remove listeners. The configuration file should be formatted like the following example. + +```xml + + + + + + + + + + +``` + + The class inherits the property from the base class . The property allows an additional level of trace output filtering at the listener. If there is a filter present, the `Trace` methods of the trace listener call the method of the filter to determine whether to emit the trace. + > [!NOTE] -> If an attempt is made to write to a file that is in use or unavailable, the file name is automatically prefixed by a GUID. - +> If an attempt is made to write to a file that is in use or unavailable, the file name is automatically prefixed by a GUID. + > [!NOTE] -> Listener methods are intended to be called by methods of the , , and classes. The listener methods are not intended to be called directly from application code. The listener is primarily intended for use by the class. The and methods can be called by the and classes, and default values are provided for the XML elements that and do not supply values for. - - 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 that follows.| -|`Computer`|None|Always present.|The value of the property.| -|`Correlation`|`ActivityID`|Always present|If not specified, the default is an empty GUID.| -||`RelatedActivityID`|Depends on the presence of the `relatedActivityId` parameter in the Trace method call.|The `relatedActivityId` parameter of the method.| -|`DataItem`|None|Depends on the `data` parameter of the method.|This element can contain an array of elements or one element, so the values are written as a set of `DataItem` nodes under the `TraceData` element.

The data output uses the `ToString` method of the passed-in data objects.| -|`EventID`|None|Always present.|Parameter input (`id`).| -|`Execution`|`ProcessName`|Always present.|From the .| -||`ProcessID`|Always present.|From the .| -||`ThreadID`|Always present.|From the .| -|`Level`|None|Always present.|Parameter input (the numeric value of `eventType`). Parameter values greater than 255 are output as 255.| -|`LogicalOperationStack`|None|Depends on the presence of the flag in the property.|There can be more than one logical operation, so the values are written as `LogicalOperation` nodes under the `LogicalOperationStack` element.| -|`Message`|None|Depends on the presence of a message in the Trace method call.|This element is a formatted message if formatting arguments are provided.| -|`Source`|`Name`|Always present.|Parameter input.| -|`SubType`|`Name`|Always present.|Parameter input.| -|`TimeCreated`|`SystemTime`|Always present.|If not present in the , the default is the current time.| -|`TimeStamp`|None|Depends on the presence of the flag in the property.|From the .| -|`Type`|None|Always present.|Always the value 3.| - - The following table shows the characters that are escaped in the XML output. Escaping occurs in all the elements and attributes with the exception of the `DataItem` element, which is not escaped if the object passed to the `data` parameter of the method is an object. If an is used for the data object, the method is called and the entire root node is traced as unescaped data. - -|Escaped character|Value| -|-----------------------|-----------| -|&|&| -|\<|<| -|>|>| -|"|"| -|\|'| -|0xD|&\#xD;| +> Listener methods are intended to be called by methods of the , , and classes. The listener methods are not intended to be called directly from application code. The listener is primarily intended for use by the class. The and methods can be called by the and classes, and default values are provided for the XML elements that and do not supply values for. + + 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 that follows.| +|`Computer`|None|Always present.|The value of the property.| +|`Correlation`|`ActivityID`|Always present|If not specified, the default is an empty GUID.| +||`RelatedActivityID`|Depends on the presence of the `relatedActivityId` parameter in the Trace method call.|The `relatedActivityId` parameter of the method.| +|`DataItem`|None|Depends on the `data` parameter of the method.|This element can contain an array of elements or one element, so the values are written as a set of `DataItem` nodes under the `TraceData` element.

The data output uses the `ToString` method of the passed-in data objects.| +|`EventID`|None|Always present.|Parameter input (`id`).| +|`Execution`|`ProcessName`|Always present.|From the .| +||`ProcessID`|Always present.|From the .| +||`ThreadID`|Always present.|From the .| +|`Level`|None|Always present.|Parameter input (the numeric value of `eventType`). Parameter values greater than 255 are output as 255.| +|`LogicalOperationStack`|None|Depends on the presence of the flag in the property.|There can be more than one logical operation, so the values are written as `LogicalOperation` nodes under the `LogicalOperationStack` element.| +|`Message`|None|Depends on the presence of a message in the Trace method call.|This element is a formatted message if formatting arguments are provided.| +|`Source`|`Name`|Always present.|Parameter input.| +|`SubType`|`Name`|Always present.|Parameter input.| +|`TimeCreated`|`SystemTime`|Always present.|If not present in the , the default is the current time.| +|`TimeStamp`|None|Depends on the presence of the flag in the property.|From the .| +|`Type`|None|Always present.|Always the value 3.| + + The following table shows the characters that are escaped in the XML output. Escaping occurs in all the elements and attributes with the exception of the `DataItem` element, which is not escaped if the object passed to the `data` parameter of the method is an object. If an is used for the data object, the method is called and the entire root node is traced as unescaped data. + +|Escaped character|Value| +|-----------------------|-----------| +|&|&| +|\<|<| +|>|>| +|"|"| +|\|'| +|0xD|&\#xD;| |0xA|&\#xA;| - -## Examples - The following code example shows the use of the class to write both escaped and non-escaped data to file logs. - + +## Examples + The following code example shows the use of the class to write both escaped and non-escaped data to file logs. + :::code language="csharp" source="~/snippets/csharp/System.Diagnostics/XmlWriterTraceListener/Overview/program.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Diagnostics.XmlWriterTraceListener/VB/module1.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Diagnostics.XmlWriterTraceListener/VB/module1.vb" id="Snippet1"::: + ]]> @@ -151,11 +151,11 @@ You can create an in your code. A that represents the stream the trace listener writes to. Initializes a new instance of the class, using the specified stream as the recipient of the debugging and tracing output. - property is initialized to an empty string (""). - + property is initialized to an empty string (""). + ]]> @@ -192,11 +192,11 @@ You can create an in your code. A that receives the output from the trace listener. Initializes a new instance of the class using the specified writer as the recipient of the debugging and tracing output. - property is initialized to an empty string (""). - + property is initialized to an empty string (""). + ]]> @@ -234,16 +234,16 @@ You can create an in your code. The name of the file to write to. Initializes a new instance of the class, using the specified file as the recipient of the debugging and tracing output. - class for the specified file on the specified path, using encoding. If the file exists, it is appended to. If the file does not exist, a new file is created. - + class for the specified file on the specified path, using encoding. If the file exists, it is appended to. If the file does not exist, a new file is created. + > [!NOTE] -> To reduce the chance of an exception, any character that might invalidate the output is replaced with a "?" character. - - The property is initialized to an empty string (""). - +> To reduce the chance of an exception, any character that might invalidate the output is replaced with a "?" character. + + The property is initialized to an empty string (""). + ]]> @@ -290,16 +290,16 @@ You can create an in your code. The name of the new instance. Initializes a new instance of the class with the specified name, using the specified stream as the recipient of the debugging and tracing output. - property to the `name` parameter value or to an empty string ("") if the `name` parameter is `null`. The name can be used as an index into the collection to programmatically change the properties for the listener. For example, the following code sets the property for an instance of whose property is "xmlListener". - -``` -((XmlWriterTraceListener)Trace.Listeners["xmlListener"]).TraceOutputOptions = - TraceOptions.Timestamp -``` - + property to the `name` parameter value or to an empty string ("") if the `name` parameter is `null`. The name can be used as an index into the collection to programmatically change the properties for the listener. For example, the following code sets the property for an instance of whose property is "xmlListener". + +``` +((XmlWriterTraceListener)Trace.Listeners["xmlListener"]).TraceOutputOptions = + TraceOptions.Timestamp +``` + ]]> @@ -346,16 +346,16 @@ You can create an in your code. The name of the new instance. Initializes a new instance of the class with the specified name, using the specified writer as the recipient of the debugging and tracing output. - property to the `name` parameter value or to an empty string ("") if the `name` parameter is `null`. The name can be used as an index into the collection to programmatically change the properties for the listener. For example, the following code sets the property for an instance of whose property is "xmlListener". - -``` -((XmlWriterTraceListener)Trace.Listeners["xmlListener"]).TraceOutputOptions = - TraceOptions.Timestamp. -``` - + property to the `name` parameter value or to an empty string ("") if the `name` parameter is `null`. The name can be used as an index into the collection to programmatically change the properties for the listener. For example, the following code sets the property for an instance of whose property is "xmlListener". + +``` +((XmlWriterTraceListener)Trace.Listeners["xmlListener"]).TraceOutputOptions = + TraceOptions.Timestamp. +``` + ]]> @@ -395,25 +395,23 @@ You can create an in your code. The name of the new instance. Initializes a new instance of the class with the specified name, using the specified file as the recipient of the debugging and tracing output. - class for the specified file on the specified path, using encoding. If the file exists, it is appended to. If the file does not exist, a new file is created. - + class for the specified file on the specified path, using encoding. If the file exists, it is appended to. If the file does not exist, a new file is created. + > [!NOTE] -> To reduce the chance of an exception, any character that might invalidate the output is replaced with a "?" character. - - The property is set to the `name` parameter value or to an empty string ("") if the `name` parameter is `null`. The name can be used as an index into the collection to programmatically change the properties for the listener. For example, the following code sets the property for an instance of whose property is "xmlListener". - -``` -((XmlWriterTraceListener)Trace.Listeners["xmlListener"]).TraceOutputOptions = - TraceOptions.Timestamp. -``` - +> To reduce the chance of an exception, any character that might invalidate the output is replaced with a "?" character. + + The property is set to the `name` parameter value or to an empty string ("") if the `name` parameter is `null`. The name can be used as an index into the collection to programmatically change the properties for the listener. For example, the following code sets the property for an instance of whose property is "xmlListener". + +``` +((XmlWriterTraceListener)Trace.Listeners["xmlListener"]).TraceOutputOptions = + TraceOptions.Timestamp. +``` + ]]> - - is . @@ -484,11 +482,11 @@ You can create an in your code. The detailed error message to append to the error message. Writes trace information including an error message and a detailed error message to the file or stream. - instances in the collection. By default, the collection contains an instance of . You can customize this behavior by adding or removing a from the collection. - + instances in the collection. By default, the collection contains an instance of . You can customize this behavior by adding or removing a from the collection. + ]]> @@ -551,14 +549,14 @@ You can create an in your code. A data object to emit. Writes trace information, a data object, and event information to the file or stream. - [!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. + ]]> @@ -619,14 +617,14 @@ You can create an in your code. An array of data objects to emit. Writes trace information, data objects, and event information to the file or stream. - [!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. + ]]> @@ -689,14 +687,14 @@ You can create an in your code. The message to write. Writes trace information, a message, and event information to the file or stream. - [!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. + ]]> @@ -767,14 +765,14 @@ You can create an in your code. An object array containing zero or more objects to format. Writes trace information, a formatted message, and event information to the file or stream. - method is called, passing in the `format` string and `args` array as parameters, to format the `args` object array as the `Message` element. - + method is called, passing in the `format` string and `args` array as parameters, to format the `args` object array as the `Message` 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. + ]]> @@ -828,14 +826,14 @@ You can create an in your code. A structure that identifies a related activity. Writes trace information including the identity of a related activity, a message, and event information to the file or stream. - method is used for the correlation of 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 writing, so a negative `id` value is written as a large positive integer. The `message` parameter is written as the `Message` element. The method is called to convert the `relatedActivityId`value to a "B" formatted string, which appears in the header. The `SubTypeName` element in the footer identifies the trace event type as a . - + method is used for the correlation of 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 writing, so a negative `id` value is written as a large positive integer. The `message` parameter is written as the `Message` element. The method is called to convert the `relatedActivityId`value to a "B" formatted string, which appears in the header. The `SubTypeName` element in the footer identifies the trace event type as a . + > [!IMPORTANT] -> The method is not intended to be called by application code. It is intended to be called by a object to emit the trace information for its method. - +> The method is not intended to be called by application code. It is intended to be called by a object to emit the trace information for its method. + ]]> @@ -874,11 +872,11 @@ You can create an in your code. The message to write. Writes a verbatim message without any additional context information to the file or stream. - method to include context information in the log output. - + method to include context information in the log output. + ]]> @@ -917,11 +915,11 @@ You can create an in your code. The message to write. Writes a verbatim message without any additional context information followed by the current line terminator to the file or stream. - method to include context information in the log output. - + method to include context information in the log output. + ]]> diff --git a/xml/System.DirectoryServices.AccountManagement/PrincipalContext.xml b/xml/System.DirectoryServices.AccountManagement/PrincipalContext.xml index 079cb4a68f1..dd8bdd315db 100644 --- a/xml/System.DirectoryServices.AccountManagement/PrincipalContext.xml +++ b/xml/System.DirectoryServices.AccountManagement/PrincipalContext.xml @@ -30,11 +30,11 @@ Encapsulates the server or domain against which all operations are performed, the container that is used as the base of those operations, and the credentials used to perform the operations. - @@ -47,15 +47,15 @@ Initializes a new instance of the class. - constructors perform validation of the parameters and server, but not do not attempt to validate credentials. - - When the principal context object is created without specifying a container, it may be used to represent multiple distinct containers. One container may be used as the base of query operations, while additional containers can hold newly-created principal objects. For example, when users or groups are inserted into the domain context type, the Account Management API uses the default well-known user container, "CN=Users,DC=Fabrikam,DC=com". When computers are inserted in the store, the API uses the default "CN=Computers,DC=Fabrikam,DC=com" container. Note that the default container names can be changed by the domain administrator. Since the principal object constructors can only specify one principal context, additional contexts are exposed as the default behavior when the application creates a domain context without specifying a container. Since the application directory does not have well-known containers, the application must specify a container in the constructor or the is thrown. Since SAM does not have containers, a is thrown if the application attempts to specify a container in the constructor. - - In each version of the constructor that takes a user name as a parameter, the `userName` string can be in various different formats. The three supported NameFormats for are Nt4Name, UserPrincipalName, and SamAccountName. For more information about name formats, see the [ADS_NAME_TYPE_ENUM documentation](/windows/win32/api/iads/ne-iads-ads_name_type_enum). - + constructors perform validation of the parameters and server, but not do not attempt to validate credentials. + + When the principal context object is created without specifying a container, it may be used to represent multiple distinct containers. One container may be used as the base of query operations, while additional containers can hold newly-created principal objects. For example, when users or groups are inserted into the domain context type, the Account Management API uses the default well-known user container, "CN=Users,DC=Fabrikam,DC=com". When computers are inserted in the store, the API uses the default "CN=Computers,DC=Fabrikam,DC=com" container. Note that the default container names can be changed by the domain administrator. Since the principal object constructors can only specify one principal context, additional contexts are exposed as the default behavior when the application creates a domain context without specifying a container. Since the application directory does not have well-known containers, the application must specify a container in the constructor or the is thrown. Since SAM does not have containers, a is thrown if the application attempts to specify a container in the constructor. + + In each version of the constructor that takes a user name as a parameter, the `userName` string can be in various different formats. The three supported NameFormats for are Nt4Name, UserPrincipalName, and SamAccountName. For more information about name formats, see the [ADS_NAME_TYPE_ENUM documentation](/windows/win32/api/iads/ne-iads-ads_name_type_enum). + ]]> @@ -105,8 +105,8 @@ A enumeration value specifying the type of store for the principal context. - The name of the domain or server for context types, the machine name for context types, or the name of the server and port hosting the instance. - + The name of the domain or server for context types, the machine name for context types, or the name of the server and port hosting the instance. + If the name is for a context type this context is a domain controller for the domain of the user principal under which the thread is running. If the name is for a context type, this is the local machine name. This parameter cannot be for context types. Initializes a new instance of the class with the specified context type and name. To be added. @@ -135,25 +135,25 @@ A enumeration value specifying the type of store for the principal context. - The name of the domain or server for context types, the machine name for context types, or the name of the server and port hosting the instance. - + The name of the domain or server for context types, the machine name for context types, or the name of the server and port hosting the instance. + If the name is for a context type this context is a domain controller for the domain of the user principal under which the thread is running. If the name is for a context type, this is the local machine name. This parameter cannot be for context types. - The container on the store to use as the root of the context. All queries are performed under this root, and all inserts are performed into this container. - - For and context types, this parameter is the distinguished name of a container object. - + The container on the store to use as the root of the context. All queries are performed under this root, and all inserts are performed into this container. + + For and context types, this parameter is the distinguished name of a container object. + For context types, this parameter must be set to . Initializes a new instance of the class with the specified context type, name, and container. - may be thrown in subsequent directory operations calls that connect to the server if the container specified for a principal context is not a valid container. A container is defined as an object whose schema class has the principal classes, either user, group, or computer, in its possibleInferiors attribute. - + may be thrown in subsequent directory operations calls that connect to the server if the container specified for a principal context is not a valid container. A container is defined as an object whose schema class has the principal classes, either user, group, or computer, in its possibleInferiors attribute. + ]]> - A container cannot be specified when the context type is specified in the parameter. - + A container cannot be specified when the context type is specified in the parameter. + A name or container must be specified when is specified in the parameter. The parameter does not contain a valid enumeration value. @@ -186,29 +186,29 @@ A enumeration value specifying the type of store for the principal context. - The name of the domain or server for context types, the machine name for context types, or the name of the server and port hosting the instance. - + The name of the domain or server for context types, the machine name for context types, or the name of the server and port hosting the instance. + If the name is for a context type this context is a domain controller for the domain of the user principal under which the thread is running. If the name is for a context type, this is the local machine name. This parameter cannot be for context types. - The container on the store to use as the root of the context. All queries are performed under this root, and all inserts are performed into this container. - - For and context types, this parameter is the distinguished name of a container object. - + The container on the store to use as the root of the context. All queries are performed under this root, and all inserts are performed into this container. + + For and context types, this parameter is the distinguished name of a container object. + For context types, this parameter must be set to . A combination of one or more enumeration values specifying the options used to bind to the server. If this parameter is , the default options are ContextOptions.Negotiate | ContextOptions.Signing | ContextOptions.Sealing. Initializes a new instance of the class with the specified context type, name, container, and context options. - may be thrown in subsequent directory operations calls that connect to the server if the container specified for a principal context is not a valid container. A container is defined as an object whose schema class has the principal classes, either user, group, or computer, in its possibleInferiors attribute. - + may be thrown in subsequent directory operations calls that connect to the server if the container specified for a principal context is not a valid container. A container is defined as an object whose schema class has the principal classes, either user, group, or computer, in its possibleInferiors attribute. + ]]> - A container cannot be specified when the context type is specified in the parameter. - + A container cannot be specified when the context type is specified in the parameter. + A name or container must be specified when is specified in the parameter. - The parameter does not contain a valid enumeration value. - + The parameter does not contain a valid enumeration value. + The parameter does not contain a combination of valid enumeration values. @@ -234,15 +234,15 @@ A enumeration value specifying the type of store for the principal context. - The name of the domain or server for context types, the machine name for context types, or the name of the server and port hosting the instance. - + The name of the domain or server for context types, the machine name for context types, or the name of the server and port hosting the instance. + If the name is for a context type this context is a domain controller for the domain of the user principal under which the thread is running. If the name is for a context type, this is the local machine name. This parameter cannot be for context types. The username used to connect to the store. If the and parameters are both , the credentials of the current process are used. Otherwise, both and must be non-null, and the credentials they specify are used to connect to the store. The password used to connect to the store. If the and parameters are both , the credentials of the current process are used. Otherwise, both and must be non-null, and the credentials they specify are used to connect to the store. Initializes a new instance of the class with the specified context type, name, username, and password. To be added. - The and parameters must either be or contain a value. - + The and parameters must either be or contain a value. + A name must be specified when is specified in the parameter. The parameter does not contain a valid enumeration value. @@ -270,29 +270,29 @@ A enumeration value specifying the type of store for the principal context. - The name of the domain or server for context types, the machine name for context types, or the name of the server and port hosting the instance. - + The name of the domain or server for context types, the machine name for context types, or the name of the server and port hosting the instance. + If the name is for a context type this context is a domain controller for the domain of the user principal under which the thread is running. If the name is for a context type, this is the local machine name. This parameter cannot be for context types. - The container on the store to use as the root of the context. All queries are performed under this root, and all inserts are performed into this container. - - For and context types, this parameter is the distinguished name of a container object. - + The container on the store to use as the root of the context. All queries are performed under this root, and all inserts are performed into this container. + + For and context types, this parameter is the distinguished name of a container object. + For context types, this parameter must be set to . The username used to connect to the store. If the and parameters are both , the default credentials of the current principal are used. Otherwise, both and must be non-null, and the credentials they specify are used to connect to the store. The password used to connect to the store. If the and parameters are both , the default credentials of the current principal are used. Otherwise, both and must be non-null, and the credentials they specify are used to connect to the store. Initializes a new instance of the class with the specified context type, name, container, username, and password. - may be thrown in subsequent directory operations calls that connect to the server if the container specified for a principal context is not a valid container. A container is defined as an object whose schema class has the principal classes, either user, group, or computer, in its possibleInferiors attribute. - + may be thrown in subsequent directory operations calls that connect to the server if the container specified for a principal context is not a valid container. A container is defined as an object whose schema class has the principal classes, either user, group, or computer, in its possibleInferiors attribute. + ]]> - The and parameters must either be or contain a value. - - A container cannot be specified when the context type is specified in the parameter. - + The and parameters must either be or contain a value. + + A container cannot be specified when the context type is specified in the parameter. + A or must be specified when is specified in the parameter. The parameter does not contain a valid enumeration value. @@ -321,33 +321,33 @@ A enumeration value specifying the type of store for the principal context. - The name of the domain or server for context types, the machine name for context types, or the name of the server and port hosting the instance. - + The name of the domain or server for context types, the machine name for context types, or the name of the server and port hosting the instance. + If the name is for a context type this context is a domain controller for the domain of the user principal under which the thread is running. If the name is for a context type, this is the local machine name. This parameter cannot be for context types. - The container on the store to use as the root of the context. All queries are performed under this root, and all inserts are performed into this container. - - For and context types, this parameter is the distinguished name of a container object. - + The container on the store to use as the root of the context. All queries are performed under this root, and all inserts are performed into this container. + + For and context types, this parameter is the distinguished name of a container object. + For context types, this parameter must be set to . A combination of one or more enumeration values the options used to bind to the server. If this parameter is , the default options are ContextOptions.Negotiate | ContextOptions.Signing | ContextOptions.Sealing. The username used to connect to the store. If the and parameters are both , the default credentials of the current principal are used. Otherwise, both and must be non-null, and the credentials they specify are used to connect to the store. The password used to connect to the store. If the and parameters are both , the default credentials of the current principal are used. Otherwise, both and must be non-null, and the credentials they specify are used to connect to the store. Initializes a new instance of the class with the specified context type, name, container, context options, username, and password. - may be thrown in subsequent directory operations calls that connect to the server if the container specified for a principal context is not a valid container. A container is defined as an object whose schema class has the principal classes, either user, group, or computer, in its possibleInferiors attribute. - + may be thrown in subsequent directory operations calls that connect to the server if the container specified for a principal context is not a valid container. A container is defined as an object whose schema class has the principal classes, either user, group, or computer, in its possibleInferiors attribute. + ]]> - The and parameters must either be or contain a value. - - A container cannot be specified when the context type is specified in the parameter. - + The and parameters must either be or contain a value. + + A container cannot be specified when the context type is specified in the parameter. + A name or container must be specified when is specified in the parameter. - The parameter does not contain a valid enumeration value. - + The parameter does not contain a valid enumeration value. + The parameter does not contain a combination of valid enumeration values. @@ -372,11 +372,11 @@ Gets the name of the server to which the principal context is connected. The name of the server to which the principal context is connected or if the principal context is not connected to a server. - , this property returns the name of the domain controller or application directory instance. When the context type is , this property returns the machine name. - + , this property returns the name of the domain controller or application directory instance. When the context type is , this property returns the machine name. + ]]> @@ -402,11 +402,11 @@ Gets the value specified in the container parameter in the constructor. The container on the store to use as the root of the context or if the container is not specified. - and context types, this property is the distinguished name of a container object. For context types, this property must be `null`. - + and context types, this property is the distinguished name of a container object. For context types, this property must be `null`. + ]]> @@ -432,11 +432,11 @@ Gets the context type that specifies the type of store for the principal context. A enumeration value specifying the type of target to connect to. - @@ -534,11 +534,11 @@ Gets the value specified in the username parameter in the constructor. The username used to connect to the store, or if no user name exists. - @@ -551,11 +551,11 @@ Creates the connection to the server and validates the specified credentials if the connection is successful. - @@ -588,10 +588,10 @@ The `userName` argument in both overloads of this method must take the form *use if the credentials are valid; otherwise . - method binds to the server specified in the constructor. If the `username` and `password` arguments are `null`, this method validates the default credentials for the current principal. + method binds to the server specified in the constructor. If the `username` and `password` arguments are `null`, this method validates the default credentials for the current principal. The `userName` argument must take the form *userName* (for example, *mcampbell*) rather than *domain\username* or *username\@domain*. @@ -629,13 +629,13 @@ The `userName` argument must take the form *userName* (for example, *mcampbell*) if the credentials are valid; otherwise . - method binds to the server specified in the constructor. If the `username` and `password` parameters are `null`, this method validates the default credentials for the current principal. + method binds to the server specified in the constructor. If the `username` and `password` parameters are `null`, this method validates the default credentials for the current principal. + +The `userName` argument must take the form *username* (for example, *mcampbell*) rather than *domain\username* or *username\@domain*. -The `userName` argument must take the form *username* (for example, *mcampbell*) rather than *domain\username* or *username\@domain*. - ]]> The parameter must specify when the context type is . diff --git a/xml/System.DirectoryServices.ActiveDirectory/ActiveDirectorySchedule.xml b/xml/System.DirectoryServices.ActiveDirectory/ActiveDirectorySchedule.xml index e151883479b..d09394b69fd 100644 --- a/xml/System.DirectoryServices.ActiveDirectory/ActiveDirectorySchedule.xml +++ b/xml/System.DirectoryServices.ActiveDirectory/ActiveDirectorySchedule.xml @@ -102,86 +102,86 @@ Gets or sets a three-dimensional array that indicates at what time during the week that the source is available for replication. - A three-dimensional array of elements in which the element is if the source is available for replication during that specific 15-minute interval. The element is if the source is not available for replication. - - The array is in the form RawSchedule[<day-of-week>, <hour>, <15-minute interval>]. All of these values are zero-based and the week begins at 00:00 on Sunday morning, Coordinated Universal Time. - - The following are the valid values for the day-of-week. - - Day-of-week value - - Indicated day of the week. - - 0 - - Sunday - - 1 - - Monday - - 2 - - Tuesday - - 3 - - Wednesday - - 4 - - Thursday - - 5 - - Friday - - 6 - - Saturday - - - - The hour is zero-based and specified in 24-hour format. For example, 2 P.M. would be specified as 14. Valid values are 0-23. - - The 15-minute interval specifies the 15-minute block within the hour that the source is available for replication. The following table identifies the possible values for the 15-minute interval. - - 15-minute interval - - Description - - 0 - - The source is available for replication from 0 to 14 minutes after the hour. - - 1 - - The source is available for replication from 15 to 29 minutes after the hour. - - 2 - - The source is available for replication from 30 to 44 minutes after the hour. - - 3 - - The source is available for replication from 45 to 59 minutes after the hour. - + A three-dimensional array of elements in which the element is if the source is available for replication during that specific 15-minute interval. The element is if the source is not available for replication. + + The array is in the form RawSchedule[<day-of-week>, <hour>, <15-minute interval>]. All of these values are zero-based and the week begins at 00:00 on Sunday morning, Coordinated Universal Time. + + The following are the valid values for the day-of-week. + + Day-of-week value + + Indicated day of the week. + + 0 + + Sunday + + 1 + + Monday + + 2 + + Tuesday + + 3 + + Wednesday + + 4 + + Thursday + + 5 + + Friday + + 6 + + Saturday + + + + The hour is zero-based and specified in 24-hour format. For example, 2 P.M. would be specified as 14. Valid values are 0-23. + + The 15-minute interval specifies the 15-minute block within the hour that the source is available for replication. The following table identifies the possible values for the 15-minute interval. + + 15-minute interval + + Description + + 0 + + The source is available for replication from 0 to 14 minutes after the hour. + + 1 + + The source is available for replication from 15 to 29 minutes after the hour. + + 2 + + The source is available for replication from 30 to 44 minutes after the hour. + + 3 + + The source is available for replication from 45 to 59 minutes after the hour. + - @@ -243,13 +243,13 @@ bool isAvailable = scheduleObject.RawSchedule[2, 15, (Int32)50/15]; One of the members that specifies the final 15-minute interval that the source will be available for replication. Adds a range of times for every day of the week to the schedule. - method. - + method. + ]]> @@ -299,19 +299,19 @@ bool isAvailable = scheduleObject.RawSchedule[2, 15, (Int32)50/15]; One of the members that specifies the final 15-minute interval that the source will be available for replication. Adds a range of times for a single day to the schedule. - method. - + method. + ]]> The start time is after the end time. One or more parameters is not valid. - is . + is . @@ -351,13 +351,13 @@ bool isAvailable = scheduleObject.RawSchedule[2, 15, (Int32)50/15]; One of the members that specifies the final 15-minute interval that the source will be available for replication. Adds a range of times for multiple days to the schedule. - method. - + method. + ]]> The start time is after the end time. diff --git a/xml/System.DirectoryServices.ActiveDirectory/ActiveDirectorySchema.xml b/xml/System.DirectoryServices.ActiveDirectory/ActiveDirectorySchema.xml index 069760daf7a..f98eb750a98 100644 --- a/xml/System.DirectoryServices.ActiveDirectory/ActiveDirectorySchema.xml +++ b/xml/System.DirectoryServices.ActiveDirectory/ActiveDirectorySchema.xml @@ -53,11 +53,11 @@ to release both managed and unmanaged resources; to release only unmanaged resources. Releases the managed resources that are used by the object and, optionally, releases unmanaged resources. - @@ -402,9 +402,9 @@ To be added. A property with the specified name cannot be found. - is . + is . - is zero length. + is zero length. The current object has been disposed. diff --git a/xml/System.DirectoryServices.ActiveDirectory/ActiveDirectorySchemaPropertyCollection.xml b/xml/System.DirectoryServices.ActiveDirectory/ActiveDirectorySchemaPropertyCollection.xml index b6dca510a6b..da4da03836f 100644 --- a/xml/System.DirectoryServices.ActiveDirectory/ActiveDirectorySchemaPropertyCollection.xml +++ b/xml/System.DirectoryServices.ActiveDirectory/ActiveDirectorySchemaPropertyCollection.xml @@ -301,7 +301,7 @@ A call to the underlying directory service resulted in an error. The object already exists in this collection. - is . + is . The specified is out of range of the collection. The object has not yet been saved in the Active Directory Domain Services store. diff --git a/xml/System.DirectoryServices.ActiveDirectory/ActiveDirectorySiteLink.xml b/xml/System.DirectoryServices.ActiveDirectory/ActiveDirectorySiteLink.xml index a37dc1b8e10..9d78f060ff0 100644 --- a/xml/System.DirectoryServices.ActiveDirectory/ActiveDirectorySiteLink.xml +++ b/xml/System.DirectoryServices.ActiveDirectory/ActiveDirectorySiteLink.xml @@ -64,19 +64,19 @@ The name for the site link. Initializes a new instance of the class using the specified object and name. - A call to the underlying directory service resulted in an error. The target server is either busy or unavailable. - This exception will occur for any of the following reasons. - -- The target in the parameter is not a forest, configuration set, domain controller, or an AD LDS server. - + This exception will occur for any of the following reasons. + +- The target in the parameter is not a forest, configuration set, domain controller, or an AD LDS server. + - is an empty string. or is . @@ -113,10 +113,10 @@ To be added. A call to the underlying directory service resulted in an error. The target server is either busy or unavailable. - This exception will occur for any of the following reasons. - -- The target in the parameter is not a forest, configuration set, domain controller, or an AD LDS server. - + This exception will occur for any of the following reasons. + +- The target in the parameter is not a forest, configuration set, domain controller, or an AD LDS server. + - is an empty string. parameter or is . @@ -166,10 +166,10 @@ To be added. A call to the underlying directory service resulted in an error. The target server is either busy or unavailable. - This exception will occur for any of the following reasons. - -- The target in the parameter is not a forest, configuration set, domain controller, or an AD LDS server. - + This exception will occur for any of the following reasons. + +- The target in the parameter is not a forest, configuration set, domain controller, or an AD LDS server. + - is an empty string. or the is . @@ -592,7 +592,7 @@ Gets or sets the replication interval between sites. The replication interval between sites. To be added. - Invalid specified. + The value being set is invalid. The object has been disposed. @@ -618,11 +618,11 @@ Writes any changes to the object to the Active Directory Domain Services store. - The site object already exists. diff --git a/xml/System.DirectoryServices.ActiveDirectory/Domain.xml b/xml/System.DirectoryServices.ActiveDirectory/Domain.xml index 94ec5cb5682..26a8b2e9324 100644 --- a/xml/System.DirectoryServices.ActiveDirectory/Domain.xml +++ b/xml/System.DirectoryServices.ActiveDirectory/Domain.xml @@ -851,7 +851,7 @@ if the authentication of the trust is selective; if the authentication is domain-wide. To be added. - There is no trust relationship with the that is specified by the parameter. + There is no trust relationship with the that is specified by the parameter. The call to LsaQueryTrustedDomainInfoByName failed. For more information, see LsaQueryTrustedDomainInfoByName. The target server is either busy or unavailable. @@ -891,7 +891,7 @@ if SID filtering is enabled; otherwise, . To be added. - There is no trust relationship with the that is specified by the parameter. + There is no trust relationship with the that is specified by the parameter. A call to the underlying directory service resulted in an error. The target server is either busy or unavailable. @@ -930,7 +930,7 @@ Gets the trust relationship between this domain and the specified domain. A object that represents the trust relationship between this domain and the specified domain. To be added. - There is no trust relationship with the that is specified by the parameter. + There is no trust relationship with the that is specified by the parameter. A call to the underlying directory service resulted in an error. The target server is either busy or unavailable. diff --git a/xml/System.DirectoryServices.ActiveDirectory/Forest.xml b/xml/System.DirectoryServices.ActiveDirectory/Forest.xml index 7c60d16485c..bce05f44d8a 100644 --- a/xml/System.DirectoryServices.ActiveDirectory/Forest.xml +++ b/xml/System.DirectoryServices.ActiveDirectory/Forest.xml @@ -88,24 +88,24 @@ The password for the trust. Creates the local side of a trust relationship with the specified forest. - method. - + method. + ]]> The trust relationship already exists. A call to the underlying directory service resulted in an error. The target server is either busy or unavailable. - name or string is empty. + name or string is empty. - or is . + or is . is not a valid value. The object has been disposed. @@ -142,11 +142,11 @@ One of the members that determines the direction of the trust, relative to this forest. Creates both sides of a trust relationship with the specified forest. - method is used to create only one side of a trust. - + method is used to create only one side of a trust. + ]]> The trust relationship already exists. @@ -188,13 +188,13 @@ The DNS name of the forest that the trust exists with. Deletes the local side of a trust relationship. - method. - + method. + ]]> There is no trust relationship with the that is specified by the parameter. @@ -234,11 +234,11 @@ A object that represents the forest that the trust exists with. Deletes both sides of a trust relationship. - method. - + method. + ]]> There is no trust relationship with the specified . @@ -375,11 +375,11 @@ Finds all of the discoverable global catalogs in this forest. A that contains the collection of global catalogs that were found. - The target server is either busy or unavailable. @@ -413,13 +413,13 @@ Finds all of the discoverable global catalogs in this forest in a specified site. A that contains the collection of global catalogs that were found. - The target server is either busy or unavailable. @@ -819,13 +819,13 @@ if selective authentication is enabled; otherwise, . - There is no trust relationship with the that is specified by . @@ -1023,21 +1023,21 @@ A enumeration value that specifies the new operation level for the forest. Raises the mode of operation for the forest. - value can be raised but not lowered. This means that raising the functionality level of the forest is not reversible and the decision to do this should be made carefully. - + value can be raised but not lowered. This means that raising the functionality level of the forest is not reversible and the decision to do this should be made carefully. + For more information about forest operational modes, see [Domain and forest functionality](https://learn.microsoft.com/previous-versions/windows/it-pro/windows-server-2008-r2-and-2008/dd894353(v%3dws.11)). - - The following table defines the valid values for `forestMode` based on the current operating mode of the forest. - -|Current mode|Mode can be raised to| -|------------------|---------------------------| -||

| -||| -||None| - + + The following table defines the valid values for `forestMode` based on the current operating mode of the forest. + +|Current mode|Mode can be raised to| +|------------------|---------------------------| +||

| +||| +||None| + ]]> A call to the underlying directory service resulted in an error. @@ -1260,11 +1260,11 @@ if SID filtering is to be enabled; otherwise, . Sets the SID filtering state with the specified forest. - There is no trust relationship with the forest that is specified by . @@ -1528,11 +1528,11 @@ A value that specifies the direction of the trust, relative to this forest. Verifies that a previously established trust with the specified forest is valid. - There is no trust relationship with the forest that is specified by , or the target forest does not have the trust direction that is specified by . diff --git a/xml/System.DirectoryServices.ActiveDirectory/ForestTrustDomainInformation.xml b/xml/System.DirectoryServices.ActiveDirectory/ForestTrustDomainInformation.xml index c5cca58f747..50d38a755de 100644 --- a/xml/System.DirectoryServices.ActiveDirectory/ForestTrustDomainInformation.xml +++ b/xml/System.DirectoryServices.ActiveDirectory/ForestTrustDomainInformation.xml @@ -127,7 +127,7 @@ One of the values that represents the status of the object. To be added. - is not a valid enumeration value. + The value being set is not a valid enumeration value. diff --git a/xml/System.DirectoryServices.ActiveDirectory/ReadOnlyStringCollection.xml b/xml/System.DirectoryServices.ActiveDirectory/ReadOnlyStringCollection.xml index 0bfe8f11e24..39f49118539 100644 --- a/xml/System.DirectoryServices.ActiveDirectory/ReadOnlyStringCollection.xml +++ b/xml/System.DirectoryServices.ActiveDirectory/ReadOnlyStringCollection.xml @@ -119,7 +119,7 @@ The zero-based index of the first matching object. Returns -1 if no member of this collection is identical to the object. To be added. - is . + is . diff --git a/xml/System.DirectoryServices.Protocols/DirectoryAttribute.xml b/xml/System.DirectoryServices.Protocols/DirectoryAttribute.xml index 6fa343b5e78..52fb8114788 100644 --- a/xml/System.DirectoryServices.Protocols/DirectoryAttribute.xml +++ b/xml/System.DirectoryServices.Protocols/DirectoryAttribute.xml @@ -107,7 +107,7 @@ The constructor creates an instance of the class using the specified attribute name and values. To be added. - or contains a null reference ( in Visual Basic). + or contains a null reference ( in Visual Basic). An element of is not of type string, byte[], or Uri. @@ -200,7 +200,7 @@ The index at which the value has been added. To be added. - contains a null reference ( in Visual Basic). + contains a null reference ( in Visual Basic). @@ -229,7 +229,7 @@ The index at which the value has been added. To be added. - contains a null reference ( in Visual Basic). + contains a null reference ( in Visual Basic). @@ -258,7 +258,7 @@ The index at which the value has been added. To be added. - contains a null reference ( in Visual Basic). + contains a null reference ( in Visual Basic). @@ -288,7 +288,7 @@ is not a byte[][], string[], or Uri[]. - contains a null reference ( in Visual Basic). + contains a null reference ( in Visual Basic). @@ -349,12 +349,12 @@ contains a null reference ( in Visual Basic). is less than zero. - This exception can occur under one of the following conditions: - + This exception can occur under one of the following conditions: + - is multidimensional. - + - is equal to, or greater than, the length of . - + - The number of elements in the source is greater than the space available from to the end of the destination . The type of the source cannot be cast automatically to the type of the destination . @@ -546,11 +546,11 @@ The property gets or sets the object at the specified index. The object at the specified index. - always attempts to convert and return the value object as a string; otherwise it returns a byte array. To get a better performance, use the method if you know the return type of the attribute value. - + always attempts to convert and return the value object as a string; otherwise it returns a byte array. To get a better performance, use the method if you know the return type of the attribute value. + ]]> @@ -608,11 +608,11 @@ The to evaluate. The method verifies that is a object. - object. - + object. + ]]> diff --git a/xml/System.DirectoryServices.Protocols/DirectoryRequest.xml b/xml/System.DirectoryServices.Protocols/DirectoryRequest.xml index 2aba282fe47..d127e9c2352 100644 --- a/xml/System.DirectoryServices.Protocols/DirectoryRequest.xml +++ b/xml/System.DirectoryServices.Protocols/DirectoryRequest.xml @@ -62,8 +62,8 @@ System.String - The property contains the specified in the request. - The specified in the request. + Gets or sets the request ID specified in the request. + The request ID specified in the request. To be added. diff --git a/xml/System.DirectoryServices.Protocols/DsmlRequestDocument.xml b/xml/System.DirectoryServices.Protocols/DsmlRequestDocument.xml index 1b6fc15263a..a088f9c4e66 100644 --- a/xml/System.DirectoryServices.Protocols/DsmlRequestDocument.xml +++ b/xml/System.DirectoryServices.Protocols/DsmlRequestDocument.xml @@ -47,11 +47,11 @@ The constructor creates an instance of the class. - @@ -479,8 +479,8 @@ System.String - The property contains the associated with the . - The associated with the . + Gets or sets the request ID associated with the . + The request ID associated with the . To be added. @@ -528,11 +528,11 @@ The property contains an object that can be used to synchronize access to the . An object that can be used to synchronize access to the . - using the property. The synchronizing code must perform operations on the of the , not directly on the . This ensures proper operation of collections that are derived from other objects. Specifically, it maintains proper synchronization with other threads that might be simultaneously modifying the object. - + using the property. The synchronizing code must perform operations on the of the , not directly on the . This ensures proper operation of collections that are derived from other objects. Specifically, it maintains proper synchronization with other threads that might be simultaneously modifying the object. + ]]> diff --git a/xml/System.DirectoryServices.Protocols/LdapConnection.xml b/xml/System.DirectoryServices.Protocols/LdapConnection.xml index d6aef6d415c..37b86ded2cc 100644 --- a/xml/System.DirectoryServices.Protocols/LdapConnection.xml +++ b/xml/System.DirectoryServices.Protocols/LdapConnection.xml @@ -24,11 +24,11 @@ The class creates a TCP/IP or UDP LDAP connection to Microsoft Active Directory Domain Services or an LDAP server. - property on the object and property on the object are both set, the certificate specified in the property is ignored. - + property on the object and property on the object are both set, the certificate specified in the property is ignored. + ]]> @@ -202,7 +202,7 @@ A supported authentication type. To be added. - is out of range. + The authentication type being set is out of range. @@ -599,8 +599,6 @@ If a connection was created using `ldap_connect`, and if no binding function is A object that contains the response from the server. To be added. The object is already disposed. The object handle is not valid. - - is null ( in Visual Basic). Request is of type DsmlAuthRequest. The error code returned by LDAP does not map to a enumeration error code. The server returned a object with an error. @@ -634,8 +632,6 @@ If a connection was created using `ldap_connect`, and if no binding function is A object that contains the response from the server. To be added. The object is already disposed. The object handle is not valid. - - is null ( in Visual Basic). Request is of type DsmlAuthRequest. The error code returned by LDAP does not map to a enumeration error code. The server returned a object with an error. @@ -662,11 +658,11 @@ If a connection was created using `ldap_connect`, and if no binding function is The property contains an object that specifies the session options. An object that specifies the session options. - property on the object and property on the object are both set, the certificate specified in the property is ignored. - + property on the object and property on the object are both set, the certificate specified in the property is ignored. + ]]> diff --git a/xml/System.DirectoryServices.Protocols/LdapDirectoryIdentifier.xml b/xml/System.DirectoryServices.Protocols/LdapDirectoryIdentifier.xml index 2ac1683b531..4709261d751 100644 --- a/xml/System.DirectoryServices.Protocols/LdapDirectoryIdentifier.xml +++ b/xml/System.DirectoryServices.Protocols/LdapDirectoryIdentifier.xml @@ -48,8 +48,8 @@ - The server ID. A string specifying the server which can be a domain name, LDAP server name or dotted strings representing the IP address of the LDAP server, or . If , it represents the identity of any domain controller in the domain associated with the computer account. - + The server ID. A string specifying the server which can be a domain name, LDAP server name or dotted strings representing the IP address of the LDAP server, or . If , it represents the identity of any domain controller in the domain associated with the computer account. + Optionally, this parameter may also include a port number, separated from the ID itself by a colon (:). The constructor creates an instance of the class using the specified server. To be added. @@ -143,7 +143,7 @@ The constructor creates an instance of the class using the specified server and properties. This constructor creates an identifier that represents a set of LDAP servers. To be added. - has space. + has space. @@ -209,7 +209,7 @@ The constructor creates an instance of the class using the specified server and properties. This constructor creates an identifier that represents a set of LDAP servers. To be added. - has space. + has space. diff --git a/xml/System.DirectoryServices.Protocols/SearchResultEntryCollection.xml b/xml/System.DirectoryServices.Protocols/SearchResultEntryCollection.xml index eca3dcc0e73..d0eada63b0e 100644 --- a/xml/System.DirectoryServices.Protocols/SearchResultEntryCollection.xml +++ b/xml/System.DirectoryServices.Protocols/SearchResultEntryCollection.xml @@ -81,10 +81,10 @@ is less than zero. is multidimensional. - - -or- - - The number of elements in the source is greater than the available space from to the end of the destination . + + -or- + + The number of elements in the source is greater than the available space from to the end of the destination array specified by . The type of the source cannot be cast automatically to the type of the destination . diff --git a/xml/System.DirectoryServices.Protocols/SearchResultReferenceCollection.xml b/xml/System.DirectoryServices.Protocols/SearchResultReferenceCollection.xml index b73b27d2878..56fbfe4c5ef 100644 --- a/xml/System.DirectoryServices.Protocols/SearchResultReferenceCollection.xml +++ b/xml/System.DirectoryServices.Protocols/SearchResultReferenceCollection.xml @@ -81,11 +81,11 @@ is less than zero. is multidimensional. - - -or- - + + -or- + The number of elements in the source is greater than the available space from to the end of the destination . - The type of the source cannot be cast automatically to the type of the destination . + The type of the source cannot be cast automatically to the type of the destination array specified by . diff --git a/xml/System.DirectoryServices/DirectoryServicesPermission.xml b/xml/System.DirectoryServices/DirectoryServicesPermission.xml index d3acb95a51a..3748c873bde 100644 --- a/xml/System.DirectoryServices/DirectoryServicesPermission.xml +++ b/xml/System.DirectoryServices/DirectoryServicesPermission.xml @@ -152,7 +152,7 @@ One of the values. Initializes a new instance of the class with the specified permission state. To be added. - The parameter is not a valid value of . + The parameter is not a valid value of . diff --git a/xml/System.DirectoryServices/PropertyCollection.xml b/xml/System.DirectoryServices/PropertyCollection.xml index 300799b709a..abe02d5f398 100644 --- a/xml/System.DirectoryServices/PropertyCollection.xml +++ b/xml/System.DirectoryServices/PropertyCollection.xml @@ -125,11 +125,11 @@ Gets the number of properties in this collection. The number of properties in this collection. - , so each will throw a . - + , so each will throw a . + ]]> An error occurred during the call to the underlying interface. @@ -193,13 +193,13 @@ Gets the specified property. The value of the specified property. - class. - - In JScript, you can use the default indexed properties defined by a type, but you cannot explicitly define your own. However, specifying the expando attribute on a class automatically provides a default indexed property with a type of Object and an index type of . - + class. + + In JScript, you can use the default indexed properties defined by a type, but you cannot explicitly define your own. However, specifying the expando attribute on a class automatically provides a default indexed property with a type of Object and an index type of . + ]]> @@ -227,11 +227,11 @@ Gets the names of the properties in this collection. An object that contains the names of the properties in this collection. - property, a might be thrown due to an error while accessing the underlying interface. - + property, a might be thrown due to an error while accessing the underlying interface. + ]]> @@ -272,10 +272,10 @@ is less than zero. - is multidimensional. - - -or- - + is multidimensional. + + -or- + The number of elements in the source is greater than the available space from to the end of the destination . The type of the source cannot be cast automatically to the type of the destination . @@ -306,37 +306,37 @@ if access to the is synchronized (thread safe); otherwise, . - returns an object, which can be used to synchronize access to the . - - Most collection classes in the namespace also implement a Synchronized method, which provides a synchronized wrapper around the underlying collection. - - Enumerating through a collection is intrinsically not a thread safe procedure. Even when a collection is synchronized, other threads can still modify the collection, which causes the enumerator to throw an exception. To guarantee thread safety during enumeration, you can either lock the collection during the entire enumeration or catch the exceptions that result from changes made by other threads. - - - The following example shows how to lock the collection using the during the entire enumeration: - -```csharp -ICollection myCollection = new ICollection(); - lock(myCollection.SyncRoot) { - foreach (Object item in myCollection) { - // Insert your code here. - } - } -``` - -```vb -Dim myCollection As New ICollection() - Dim item As Object - SyncLock myCollection.SyncRoot - For Each item In myCollection - ' Insert your code here. - Next item - End SyncLock -``` - + returns an object, which can be used to synchronize access to the . + + Most collection classes in the namespace also implement a Synchronized method, which provides a synchronized wrapper around the underlying collection. + + Enumerating through a collection is intrinsically not a thread safe procedure. Even when a collection is synchronized, other threads can still modify the collection, which causes the enumerator to throw an exception. To guarantee thread safety during enumeration, you can either lock the collection during the entire enumeration or catch the exceptions that result from changes made by other threads. + + + The following example shows how to lock the collection using the during the entire enumeration: + +```csharp +ICollection myCollection = new ICollection(); + lock(myCollection.SyncRoot) { + foreach (Object item in myCollection) { + // Insert your code here. + } + } +``` + +```vb +Dim myCollection As New ICollection() + Dim item As Object + SyncLock myCollection.SyncRoot + For Each item In myCollection + ' Insert your code here. + Next item + End SyncLock +``` + ]]> @@ -367,53 +367,53 @@ Dim myCollection As New ICollection() Gets an object that can be used to synchronize access to the . An object that can be used to synchronize access to the . - namespace also implement a Synchronized method, which provides a synchronized wrapper around the underlying collection. However, derived classes can provide their own synchronized version of the collection using the property. The synchronizing code must perform operations on the of the collection, not directly on the collection. This ensures proper operation of collections that are derived from other objects. Specifically, it maintains proper synchronization with other threads that might be simultaneously modifying the collection instance. - - In the absence of a Synchronized method on a collection, the expected usage for looks like this: - -```csharp -ICollection MyCollection =... - lock(MyCollection.SyncRoot) { - // Some operation on the collection, which is now thread safe. - } -``` - -```vb -Dim myCollection as New ICollection() - SyncLock myCollection.SyncRoot - ' Some operation on the collection, which is now thread safe. - End SyncLock -``` - - Enumerating through a collection is intrinsically not a thread safe procedure. Even when a collection is synchronized, other threads can still modify the collection, which causes the enumerator to throw an exception. To guarantee thread safety during enumeration, you can either lock the collection during the entire enumeration or catch the exceptions resulting from changes made by other threads. - - - The following code example shows how to lock the collection using the during the entire enumeration: - -```csharp -ICollection myCollection = new ICollection(); - lock(myCollection.SyncRoot) { - foreach (Object item in myCollection) { - // Insert your code here. - } - } -``` - -```vb -Dim myCollection As New ICollection() - Dim item As Object - SyncLock myCollection.SyncRoot - For Each item In myCollection - ' Insert your code here. - Next item - End SyncLock -``` - + namespace also implement a Synchronized method, which provides a synchronized wrapper around the underlying collection. However, derived classes can provide their own synchronized version of the collection using the property. The synchronizing code must perform operations on the of the collection, not directly on the collection. This ensures proper operation of collections that are derived from other objects. Specifically, it maintains proper synchronization with other threads that might be simultaneously modifying the collection instance. + + In the absence of a Synchronized method on a collection, the expected usage for looks like this: + +```csharp +ICollection MyCollection =... + lock(MyCollection.SyncRoot) { + // Some operation on the collection, which is now thread safe. + } +``` + +```vb +Dim myCollection as New ICollection() + SyncLock myCollection.SyncRoot + ' Some operation on the collection, which is now thread safe. + End SyncLock +``` + + Enumerating through a collection is intrinsically not a thread safe procedure. Even when a collection is synchronized, other threads can still modify the collection, which causes the enumerator to throw an exception. To guarantee thread safety during enumeration, you can either lock the collection during the entire enumeration or catch the exceptions resulting from changes made by other threads. + + + The following code example shows how to lock the collection using the during the entire enumeration: + +```csharp +ICollection myCollection = new ICollection(); + lock(myCollection.SyncRoot) { + foreach (Object item in myCollection) { + // Insert your code here. + } + } +``` + +```vb +Dim myCollection As New ICollection() + Dim item As Object + SyncLock myCollection.SyncRoot + For Each item In myCollection + ' Insert your code here. + Next item + End SyncLock +``` + ]]> @@ -450,29 +450,29 @@ Dim myCollection As New ICollection() The to use as the value of the element to add. Adds an element with the provided key and value to the object. - property to add new elements by setting the value of a key that does not exist in the dictionary (for example, `myCollection["myNonexistentKey"] = myValue`). However, if the specified key already exists in the dictionary, setting the property overwrites the old value. In contrast, the method does not modify existing elements. - - - -## Examples - The following example shows how to implement the method. This code example is part of a larger example provided for the class. - + property to add new elements by setting the value of a key that does not exist in the dictionary (for example, `myCollection["myNonexistentKey"] = myValue`). However, if the specified key already exists in the dictionary, setting the property overwrites the old value. In contrast, the method does not modify existing elements. + + + +## Examples + The following example shows how to implement the method. This code example is part of a larger example provided for the class. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/Dictionary/cpp/Dictionary.cpp" id="Snippet9"::: :::code language="csharp" source="~/snippets/csharp/System.Collections/DictionaryEntry/Key/Dictionary.cs" id="Snippet9"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Dictionary/VB/Dictionary.vb" id="Snippet9"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Dictionary/VB/Dictionary.vb" id="Snippet9"::: + ]]> is . An element with the same key already exists in the object. - The is read-only. - - -or- - + The is read-only. + + -or- + The has a fixed size. @@ -503,15 +503,15 @@ Dim myCollection As New ICollection() Removes all elements from the object. - method. This example is part of a larger example provided for the class. - + method. This example is part of a larger example provided for the class. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/Dictionary/cpp/Dictionary.cpp" id="Snippet8"::: :::code language="csharp" source="~/snippets/csharp/System.Collections/DictionaryEntry/Key/Dictionary.cs" id="Snippet8"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Dictionary/VB/Dictionary.vb" id="Snippet8"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Dictionary/VB/Dictionary.vb" id="Snippet8"::: + ]]> The object is read-only. @@ -548,19 +548,19 @@ Dim myCollection As New ICollection() if the contains an element with the key; otherwise, . - method. This example is part of a larger example provided for the class. - + method. This example is part of a larger example provided for the class. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/Dictionary/cpp/Dictionary.cpp" id="Snippet5"::: :::code language="csharp" source="~/snippets/csharp/System.Collections/DictionaryEntry/Key/Dictionary.cs" id="Snippet5"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Dictionary/VB/Dictionary.vb" id="Snippet5"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Dictionary/VB/Dictionary.vb" id="Snippet5"::: + ]]> - is . + is . @@ -589,22 +589,22 @@ Dim myCollection As New ICollection() if the object has a fixed size; otherwise, . - property. This code example is part of a larger example provided for the class. - + property. This code example is part of a larger example provided for the class. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/Dictionary/cpp/Dictionary.cpp" id="Snippet6"::: :::code language="csharp" source="~/snippets/csharp/System.Collections/DictionaryEntry/Key/Dictionary.cs" id="Snippet6"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Dictionary/VB/Dictionary.vb" id="Snippet6"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Dictionary/VB/Dictionary.vb" id="Snippet6"::: + ]]> @@ -635,20 +635,20 @@ Dim myCollection As New ICollection() if the object is read-only; otherwise, . - property. This code example is part of a larger example provided for the class. - + property. This code example is part of a larger example provided for the class. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/Dictionary/cpp/Dictionary.cpp" id="Snippet4"::: :::code language="csharp" source="~/snippets/csharp/System.Collections/DictionaryEntry/Key/Dictionary.cs" id="Snippet4"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Dictionary/VB/Dictionary.vb" id="Snippet4"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Dictionary/VB/Dictionary.vb" id="Snippet4"::: + ]]> @@ -689,30 +689,30 @@ Dim myCollection As New ICollection() Gets or sets the element with the specified key. The element with the specified key. - property to add new elements by setting the value of a key that does not exist in the dictionary (for example, `myCollection["myNonexistentKey"] = myValue`). However, if the specified key already exists in the dictionary, setting the property overwrites the old value. In contrast, the method does not modify existing elements. - - - -## Examples - The following example shows how to implement the property. This code example is part of a larger example provided for the class. - + property to add new elements by setting the value of a key that does not exist in the dictionary (for example, `myCollection["myNonexistentKey"] = myValue`). However, if the specified key already exists in the dictionary, setting the property overwrites the old value. In contrast, the method does not modify existing elements. + + + +## Examples + The following example shows how to implement the property. This code example is part of a larger example provided for the class. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/Dictionary/cpp/Dictionary.cpp" id="Snippet13"::: :::code language="csharp" source="~/snippets/csharp/System.Collections/DictionaryEntry/Key/Dictionary.cs" id="Snippet13"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Dictionary/VB/Dictionary.vb" id="Snippet13"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Dictionary/VB/Dictionary.vb" id="Snippet13"::: + ]]> is . - The property is set and the object is read-only. - - -or- - + The property is set and the object is read-only. + + -or- + The property is set, does not exist in the collection, and the has a fixed size. @@ -742,20 +742,20 @@ Dim myCollection As New ICollection() Gets an object containing the keys of the object. An object containing the keys of the object. - object is unspecified, but is guaranteed to be the same order as the corresponding values in the returned by the property. - - - -## Examples - The following example shows how to implement the property. This code example is part of a larger example provided for the class. - + object is unspecified, but is guaranteed to be the same order as the corresponding values in the returned by the property. + + + +## Examples + The following example shows how to implement the property. This code example is part of a larger example provided for the class. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/Dictionary/cpp/Dictionary.cpp" id="Snippet10"::: :::code language="csharp" source="~/snippets/csharp/System.Collections/DictionaryEntry/Key/Dictionary.cs" id="Snippet10"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Dictionary/VB/Dictionary.vb" id="Snippet10"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Dictionary/VB/Dictionary.vb" id="Snippet10"::: + ]]> @@ -790,23 +790,23 @@ Dim myCollection As New ICollection() The key of the element to remove. Removes the element with the specified key from the object. - method. This code example is part of a larger example provided for the class. - + method. This code example is part of a larger example provided for the class. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/Dictionary/cpp/Dictionary.cpp" id="Snippet7"::: :::code language="csharp" source="~/snippets/csharp/System.Collections/DictionaryEntry/Key/Dictionary.cs" id="Snippet7"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Dictionary/VB/Dictionary.vb" id="Snippet7"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Dictionary/VB/Dictionary.vb" id="Snippet7"::: + ]]> is . - The object is read-only. - - -or- - + The object is read-only. + + -or- + The has a fixed size. @@ -837,24 +837,24 @@ Dim myCollection As New ICollection() Returns an object. An .object. - also brings the enumerator back to this position. At this position, the property is undefined. Therefore, you must call to advance the enumerator to the first element of the collection before reading the value of . - - returns the same object until either or is called. sets to the next element. - - If passes the end of the collection, the enumerator is positioned after the last element in the collection and returns `false`. When the enumerator is at this position, subsequent calls to also return `false`. If the last call to returned `false`, is undefined. To set to the first element of the collection again, you can call followed by . - - An enumerator remains valid as long as the collection remains unchanged. If changes are made to the collection, such as adding, modifying, or deleting elements, the enumerator is irrecoverably invalidated and its behavior is undefined. - - The enumerator does not have exclusive access to the collection; therefore, enumerating through a collection is intrinsically not a thread-safe procedure. To guarantee thread safety during enumeration, you can lock the collection during the entire enumeration. To allow the collection to be accessed by multiple threads for reading and writing, you must implement your own synchronization. - + also brings the enumerator back to this position. At this position, the property is undefined. Therefore, you must call to advance the enumerator to the first element of the collection before reading the value of . + + returns the same object until either or is called. sets to the next element. + + If passes the end of the collection, the enumerator is positioned after the last element in the collection and returns `false`. When the enumerator is at this position, subsequent calls to also return `false`. If the last call to returned `false`, is undefined. To set to the first element of the collection again, you can call followed by . + + An enumerator remains valid as long as the collection remains unchanged. If changes are made to the collection, such as adding, modifying, or deleting elements, the enumerator is irrecoverably invalidated and its behavior is undefined. + + The enumerator does not have exclusive access to the collection; therefore, enumerating through a collection is intrinsically not a thread-safe procedure. To guarantee thread safety during enumeration, you can lock the collection during the entire enumeration. To allow the collection to be accessed by multiple threads for reading and writing, you must implement your own synchronization. + ]]> @@ -886,11 +886,11 @@ Dim myCollection As New ICollection() Gets the values of the properties in this collection. An that contains the values of the properties in this collection. - property, a exception might be thrown due to an error while accessing the underlying interface. - + property, a exception might be thrown due to an error while accessing the underlying interface. + ]]> From 03377c1bbfcc6d628c449affe99bc44c97198a6f Mon Sep 17 00:00:00 2001 From: Genevieve Warren <24882762+gewarren@users.noreply.github.com> Date: Tue, 7 Jan 2025 10:25:44 -0800 Subject: [PATCH 3/5] fix paramrefs (#10791) --- .../ISupportRequiredService.xml | 2 - xml/System.Buffers.Text/Base64Url.xml | 8 +- xml/System.Buffers/BuffersExtensions.xml | 4 +- .../BlockingCollection`1.xml | 2 +- .../ConcurrentDictionary`2.xml | 2 +- xml/System.Collections.Generic/Comparer`1.xml | 14 +- .../Dictionary`2.xml | 8 +- xml/System.Collections.Generic/HashSet`1.xml | 2 +- xml/System.Collections.Generic/List`1.xml | 2 +- .../OrderedDictionary`2+KeyCollection.xml | 2 +- .../SortedDictionary`2.xml | 1122 ++++++------- .../SortedList`2.xml | 1360 +++++++-------- .../SynchronizedKeyedCollection`2.xml | 48 +- .../IImmutableList`1.xml | 20 +- .../ImmutableArray`1.xml | 6 +- .../ImmutableInterlocked.xml | 8 +- .../ImmutableList`1+Builder.xml | 150 +- .../Collection`1.xml | 34 +- .../KeyedCollection`2.xml | 4 +- .../ReadOnlyCollection`1.xml | 804 ++++----- .../HybridDictionary.xml | 628 ++++--- .../NotifyCollectionChangedEventArgs.xml | 2 +- xml/System.Collections/IEqualityComparer.xml | 66 +- xml/System.Runtime.Intrinsics.Arm/Sve.xml | 1470 ++++++++--------- xml/System/Char.xml | 4 +- xml/System/Uri.xml | 2 +- 26 files changed, 2880 insertions(+), 2894 deletions(-) diff --git a/xml/Microsoft.Extensions.DependencyInjection/ISupportRequiredService.xml b/xml/Microsoft.Extensions.DependencyInjection/ISupportRequiredService.xml index 7fb1f497d84..6b99840f6ef 100644 --- a/xml/Microsoft.Extensions.DependencyInjection/ISupportRequiredService.xml +++ b/xml/Microsoft.Extensions.DependencyInjection/ISupportRequiredService.xml @@ -56,8 +56,6 @@ A service object of type . Throws an exception if the cannot create the object. To be added. - - has already been disposed. diff --git a/xml/System.Buffers.Text/Base64Url.xml b/xml/System.Buffers.Text/Base64Url.xml index cb17c1fdf9c..b3578410f4f 100644 --- a/xml/System.Buffers.Text/Base64Url.xml +++ b/xml/System.Buffers.Text/Base64Url.xml @@ -378,7 +378,7 @@ The input span which contains binary data that needs to be encoded. The output span which contains the result of the operation, i.e. the ASCII chars in Base64Url. - Encodes the span of binary data into unicode ASCII chars represented as Base64Url. + Encodes the span of binary data into Unicode ASCII chars represented as Base64Url. The number of bytes written into the destination span. This can be used to slice the output for subsequent calls, if necessary. This implementation of the base64url encoding omits the optional padding characters. The buffer in is too small to hold the encoded output. @@ -791,7 +791,7 @@ The input span which contains ASCII chars in Base64Url that needs to be decoded. The output span which contains the result of the operation, i.e. the decoded binary data. When this method returns, contains the number of bytes written into the output span. This can be used to slice the output for subsequent calls, if necessary. This parameter is treated as uninitialized. - Decodes the span of unicode ASCII chars represented as Base64Url into binary data. + Decodes the span of Unicode ASCII chars represented as Base64Url into binary data. if bytes decoded successfully; if is too small. To be added. @@ -869,7 +869,7 @@ The input span which contains binary data that needs to be encoded. The output span which contains the result of the operation, i.e. the ASCII chars in Base64Url. When this method returns, contains the number of chars written into the output span. This can be used to slice the output for subsequent calls, if necessary. This parameter is treated as uninitialized. - Encodes the span of binary data into unicode ASCII chars represented as Base64Url. + Encodes the span of binary data into Unicode ASCII chars represented as Base64Url. if chars encoded successfully; if is too small. This implementation of the base64url encoding omits the optional padding characters. @@ -948,7 +948,7 @@ The encoded text output is larger than the binary data contained in the input (the operation inflates the data). - if bytes encoded successfully; if is too small. + if bytes encoded successfully; if is too small to fit the result. This implementation of the base64url encoding omits the optional padding characters. diff --git a/xml/System.Buffers/BuffersExtensions.xml b/xml/System.Buffers/BuffersExtensions.xml index fbd634b8676..d49a2a66d0b 100644 --- a/xml/System.Buffers/BuffersExtensions.xml +++ b/xml/System.Buffers/BuffersExtensions.xml @@ -158,8 +158,8 @@ The type of the items in the . The source . The item to find in the . - Returns the position of the first occurrence of in the . - An object whose method returns the position of the first occurrence of , or an object whose property is . + Returns the position of the first occurrence of in the . + An object whose method returns the position of the first occurrence of , or an object whose property is . To be added. diff --git a/xml/System.Collections.Concurrent/BlockingCollection`1.xml b/xml/System.Collections.Concurrent/BlockingCollection`1.xml index 35148988b45..fbfdc06f8be 100644 --- a/xml/System.Collections.Concurrent/BlockingCollection`1.xml +++ b/xml/System.Collections.Concurrent/BlockingCollection`1.xml @@ -2170,7 +2170,7 @@ This member is an explicit interface member implementation. It can be used only ]]> - At least one of the instances or the that created has been disposed. + At least one of the instances has been disposed. The argument is null. is a negative number other than -1 milliseconds, which represents an infinite time-out. diff --git a/xml/System.Collections.Concurrent/ConcurrentDictionary`2.xml b/xml/System.Collections.Concurrent/ConcurrentDictionary`2.xml index 827429ad799..31cc5031057 100644 --- a/xml/System.Collections.Concurrent/ConcurrentDictionary`2.xml +++ b/xml/System.Collections.Concurrent/ConcurrentDictionary`2.xml @@ -1663,7 +1663,7 @@ The number of elements in the source The to remove. Removes the specified key/value pair from the collection. - if the element is successfully removed; otherwise, . This method also returns false if was not found in the original . + if the element is successfully removed; otherwise, . This method also returns false if the key was not found in the original . To be added. Thread-Safe Collections How to: Add and Remove Items from a ConcurrentDictionary diff --git a/xml/System.Collections.Generic/Comparer`1.xml b/xml/System.Collections.Generic/Comparer`1.xml index 38ee8107a2b..ec541de744f 100644 --- a/xml/System.Collections.Generic/Comparer`1.xml +++ b/xml/System.Collections.Generic/Comparer`1.xml @@ -235,8 +235,6 @@ ## Remarks Implement this method to provide a customized sort order comparison for type `T`. - - ## Examples The following example defines a comparer of `Box` objects that can be used instead of the default comparer. This example is part of a larger example provided for the class. @@ -246,7 +244,7 @@ ]]> - Type does not implement either the generic interface or the interface. + Type T does not implement either the generic interface or the interface. Comparing with any reference type is allowed and does not generate an exception. A null reference is considered to be less than any reference that is not null. @@ -345,16 +343,14 @@ System.Collections.Generic.Comparer<T> - Returns a default sort order comparer for the type specified by the generic argument. - An object that inherits and serves as a sort order comparer for type . + Returns a default sort-order comparer for the type specified by the generic argument. + An object that inherits and serves as a sort-order comparer for type T. returned by this property uses the generic interface (`IComparable` in C#, `IComparable(Of T)` in Visual Basic) to compare two objects. If type `T` does not implement the generic interface, this property returns a that uses the interface. - - ## Examples The following example shows how to use the property to get an object that performs the default comparison. This example is part of a larger example provided for the class. @@ -448,8 +444,6 @@ Comparing `null` with any reference type is allowed and does not generate an exception. When sorting, `null` is considered to be less than any other object. - - ## Examples The following example shows how to use the method to compare two objects. This example is part of a larger example provided for the class. @@ -460,7 +454,7 @@ ]]> - or is of a type that cannot be cast to type . + or is of a type that cannot be cast to type T. -or- diff --git a/xml/System.Collections.Generic/Dictionary`2.xml b/xml/System.Collections.Generic/Dictionary`2.xml index ed01c459cef..1464e0c93f9 100644 --- a/xml/System.Collections.Generic/Dictionary`2.xml +++ b/xml/System.Collections.Generic/Dictionary`2.xml @@ -2533,13 +2533,13 @@ finally { property to add new elements by setting the value of a key that does not exist in the dictionary; for example, `myCollection["myNonexistentKey"] = myValue`. However, if the specified key already exists in the dictionary, setting the property overwrites the old value. In contrast, the method throws an exception if the specified key already exists. If is less than the capacity, this method approaches an O(1) operation. If the capacity needs to be increased to accommodate the new element, this method becomes an O(`n`) operation, where `n` is . - - ## Examples + The following code example shows how to access the class through the interface. The code example creates an empty of strings with string keys and uses the method to add some elements. The example demonstrates that the method throws an when attempting to add a duplicate key, or when a key or value of the wrong data type is supplied. The code example demonstrates the use of several other members of the interface. @@ -2907,8 +2907,6 @@ finally { Getting or setting the value of this property approaches an O(1) operation. - - ## Examples The following code example shows how to use the property (the indexer in C#) of the interface with a , and ways the property differs from the property. @@ -2936,7 +2934,7 @@ finally { -or- - A value is being assigned, and is of a type that is not assignable to the value type of the . + A value is being assigned and is of a type that isn't assignable to the value type of the . diff --git a/xml/System.Collections.Generic/HashSet`1.xml b/xml/System.Collections.Generic/HashSet`1.xml index fae2391a39d..1217bd75060 100644 --- a/xml/System.Collections.Generic/HashSet`1.xml +++ b/xml/System.Collections.Generic/HashSet`1.xml @@ -1033,7 +1033,7 @@ The following example demonstrates how to merge two disparate sets. This example -or- - is greater than the available space from the to the end of the destination . + is greater than the available space from to the end of the destination . diff --git a/xml/System.Collections.Generic/List`1.xml b/xml/System.Collections.Generic/List`1.xml index 834b50754aa..6d0f3316ad3 100644 --- a/xml/System.Collections.Generic/List`1.xml +++ b/xml/System.Collections.Generic/List`1.xml @@ -5027,7 +5027,7 @@ finally is not a valid index in the . - The property is set and is of a type that is not assignable to the . + The property is set and the value is of a type that isn't assignable to the . diff --git a/xml/System.Collections.Generic/OrderedDictionary`2+KeyCollection.xml b/xml/System.Collections.Generic/OrderedDictionary`2+KeyCollection.xml index f8801f78fdb..5e342d81b86 100644 --- a/xml/System.Collections.Generic/OrderedDictionary`2+KeyCollection.xml +++ b/xml/System.Collections.Generic/OrderedDictionary`2+KeyCollection.xml @@ -88,7 +88,7 @@ They key to the location in the collection. Determines whether the contains a specific value. - if is found in the ; otherwise, . + if is found in the ; otherwise, . To be added. diff --git a/xml/System.Collections.Generic/SortedDictionary`2.xml b/xml/System.Collections.Generic/SortedDictionary`2.xml index da35c286feb..bed450986d0 100644 --- a/xml/System.Collections.Generic/SortedDictionary`2.xml +++ b/xml/System.Collections.Generic/SortedDictionary`2.xml @@ -111,51 +111,51 @@ The type of the values in the dictionary. Represents a collection of key/value pairs that are sorted on the key. - generic class is a binary search tree with O(log n) retrieval, where n is the number of elements in the dictionary. In this respect, it is similar to the generic class. The two classes have similar object models, and both have O(log n) retrieval. Where the two classes differ is in memory use and speed of insertion and removal: - -- uses less memory than . - -- has faster insertion and removal operations for unsorted data: O(log n) as opposed to O(n) for . - -- If the list is populated all at once from sorted data, is faster than . - - Each key/value pair can be retrieved as a structure, or as a through the nongeneric interface. - - Keys must be immutable as long as they are used as keys in the . Every key in a must be unique. A key cannot be `null`, but a value can be, if the value type `TValue` is a reference type. - - requires a comparer implementation to perform key comparisons. You can specify an implementation of the generic interface by using a constructor that accepts a `comparer` parameter; if you do not specify an implementation, the default generic comparer is used. If type `TKey` implements the generic interface, the default comparer uses that implementation. - - The `foreach` statement of the C# language (`for each` in C++, `For Each` in Visual Basic) returns an object of the type of the elements in the collection. Since each element of the is a key/value pair, the element type is not the type of the key or the type of the value. Instead, the element type is . The following code shows C#, C++, and Visual Basic syntax. - + generic class is a binary search tree with O(log n) retrieval, where n is the number of elements in the dictionary. In this respect, it is similar to the generic class. The two classes have similar object models, and both have O(log n) retrieval. Where the two classes differ is in memory use and speed of insertion and removal: + +- uses less memory than . + +- has faster insertion and removal operations for unsorted data: O(log n) as opposed to O(n) for . + +- If the list is populated all at once from sorted data, is faster than . + + Each key/value pair can be retrieved as a structure, or as a through the nongeneric interface. + + Keys must be immutable as long as they are used as keys in the . Every key in a must be unique. A key cannot be `null`, but a value can be, if the value type `TValue` is a reference type. + + requires a comparer implementation to perform key comparisons. You can specify an implementation of the generic interface by using a constructor that accepts a `comparer` parameter; if you do not specify an implementation, the default generic comparer is used. If type `TKey` implements the generic interface, the default comparer uses that implementation. + + The `foreach` statement of the C# language (`for each` in C++, `For Each` in Visual Basic) returns an object of the type of the elements in the collection. Since each element of the is a key/value pair, the element type is not the type of the key or the type of the value. Instead, the element type is . The following code shows C#, C++, and Visual Basic syntax. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/Generic.Dictionary/cpp/source2.cpp" id="Snippet11"::: :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/DictionaryTKey,TValue/Overview/source2.cs" id="Snippet11"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.Dictionary/VB/source2.vb" id="Snippet11"::: - - The `foreach` statement is a wrapper around the enumerator, which allows only reading from the collection, not writing to it. - - - -## Examples - The following code example creates an empty of strings with string keys and uses the method to add some elements. The example demonstrates that the method throws an when attempting to add a duplicate key. - - The example uses the property (the indexer in C#) to retrieve values, demonstrating that a is thrown when a requested key is not present, and showing that the value associated with a key can be replaced. - - The example shows how to use the method as a more efficient way to retrieve values if a program often must try key values that are not in the dictionary, and it shows how to use the method to test whether a key exists before calling the method. - - The example shows how to enumerate the keys and values in the dictionary and how to enumerate the keys and values alone using the property and the property. - - Finally, the example demonstrates the method. - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.Dictionary/VB/source2.vb" id="Snippet11"::: + + The `foreach` statement is a wrapper around the enumerator, which allows only reading from the collection, not writing to it. + + + +## Examples + The following code example creates an empty of strings with string keys and uses the method to add some elements. The example demonstrates that the method throws an when attempting to add a duplicate key. + + The example uses the property (the indexer in C#) to retrieve values, demonstrating that a is thrown when a requested key is not present, and showing that the value associated with a key can be replaced. + + The example shows how to use the method as a more efficient way to retrieve values if a program often must try key values that are not in the dictionary, and it shows how to use the method to test whether a key exists before calling the method. + + The example shows how to enumerate the keys and values in the dictionary and how to enumerate the keys and values alone using the property and the property. + + Finally, the example demonstrates the method. + :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/SortedDictionaryTKey,TValue/Overview/source.cs" id="Snippet1"::: -:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedDictionary/VB/source.vb" id="Snippet1"::: - +:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedDictionary/VB/source.vb" id="Snippet1"::: + ]]> - Public static ( in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe. - + Public static ( in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe. + A can support multiple readers concurrently, as long as the collection is not modified. Even so, enumerating through a collection is intrinsically not a thread-safe procedure. To guarantee thread safety during enumeration, you can lock the collection during the entire enumeration. To allow the collection to be accessed by multiple threads for reading and writing, you must implement your own synchronization. @@ -213,25 +213,25 @@ Initializes a new instance of the class that is empty and uses the default implementation for the key type. - must be unique according to the default comparer. - - requires a comparer implementation to perform key comparisons. This constructor uses the default generic equality comparer . If type `TKey` implements the generic interface, the default comparer uses that implementation. Alternatively, you can specify an implementation of the generic interface by using a constructor that accepts a `comparer` parameter. - - This constructor is an O(1) operation. - - - -## Examples - The following code example creates an empty of strings with string keys and uses the method to add some elements. The example demonstrates that the method throws an when attempting to add a duplicate key. - - This code example is part of a larger example provided for the class. - + must be unique according to the default comparer. + + requires a comparer implementation to perform key comparisons. This constructor uses the default generic equality comparer . If type `TKey` implements the generic interface, the default comparer uses that implementation. Alternatively, you can specify an implementation of the generic interface by using a constructor that accepts a `comparer` parameter. + + This constructor is an O(1) operation. + + + +## Examples + The following code example creates an empty of strings with string keys and uses the method to add some elements. The example demonstrates that the method throws an when attempting to add a duplicate key. + + This code example is part of a larger example provided for the class. + :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/SortedDictionaryTKey,TValue/Overview/source.cs" interactive="try-dotnet-method" id="Snippet2"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedDictionary/VB/source.vb" id="Snippet2"::: - + ]]> @@ -286,23 +286,23 @@ The implementation to use when comparing keys, or to use the default for the type of the key. Initializes a new instance of the class that is empty and uses the specified implementation to compare keys. - must be unique according to the specified comparer. - - requires a comparer implementation to perform key comparisons. If `comparer` is `null`, this constructor uses the default generic equality comparer, . If type `TKey` implements the generic interface, the default comparer uses that implementation. - - This constructor is an O(1) operation. - - - -## Examples - The following code example creates a with a case-insensitive comparer for the current culture. The example adds four elements, some with lower-case keys and some with upper-case keys. The example then attempts to add an element with a key that differs from an existing key only by case, catches the resulting exception, and displays an error message. Finally, the example displays the elements in case-insensitive sort order. - + must be unique according to the specified comparer. + + requires a comparer implementation to perform key comparisons. If `comparer` is `null`, this constructor uses the default generic equality comparer, . If type `TKey` implements the generic interface, the default comparer uses that implementation. + + This constructor is an O(1) operation. + + + +## Examples + The following code example creates a with a case-insensitive comparer for the current culture. The example adds four elements, some with lower-case keys and some with upper-case keys. The example then attempts to add an element with a key that differs from an existing key only by case, catches the resulting exception, and displays an error message. Finally, the example displays the elements in case-insensitive sort order. + :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/SortedDictionaryTKey,TValue/.ctor/source.cs" interactive="try-dotnet" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedDictionary.ctor_IComp/VB/source.vb" id="Snippet1"::: - + ]]> @@ -356,23 +356,23 @@ The whose elements are copied to the new . Initializes a new instance of the class that contains elements copied from the specified and uses the default implementation for the key type. - must be unique according to the default comparer; therefore, every key in the source `dictionary` must also be unique according to the default comparer. - - requires a comparer implementation to perform key comparisons. This constructor uses the default generic equality comparer, . If type `TKey` implements the generic interface, the default comparer uses that implementation. Alternatively, you can specify an implementation of the generic interface by using a constructor that accepts a `comparer` parameter. - - This constructor is an O(`n` log `n`) operation, where `n` is the number of elements in `dictionary`. - - - -## Examples - The following code example shows how to use to create a sorted copy of the information in a , by passing the to the constructor. - + must be unique according to the default comparer; therefore, every key in the source `dictionary` must also be unique according to the default comparer. + + requires a comparer implementation to perform key comparisons. This constructor uses the default generic equality comparer, . If type `TKey` implements the generic interface, the default comparer uses that implementation. Alternatively, you can specify an implementation of the generic interface by using a constructor that accepts a `comparer` parameter. + + This constructor is an O(`n` log `n`) operation, where `n` is the number of elements in `dictionary`. + + + +## Examples + The following code example shows how to use to create a sorted copy of the information in a , by passing the to the constructor. + :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/SortedDictionaryTKey,TValue/.ctor/source1.cs" interactive="try-dotnet" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedDictionary.ctor_IDic/VB/source.vb" id="Snippet1"::: - + ]]> @@ -434,23 +434,23 @@ The implementation to use when comparing keys, or to use the default for the type of the key. Initializes a new instance of the class that contains elements copied from the specified and uses the specified implementation to compare keys. - must be unique according to the specified comparer; therefore, every key in the source `dictionary` must also be unique according to the specified comparer. - - requires a comparer implementation to perform key comparisons. If `comparer` is `null`, this constructor uses the default generic equality comparer, . If type `TKey` implements the generic interface, the default comparer uses that implementation. - - This constructor is an O(`n` log `n`) operation, where `n` is the number of elements in `dictionary`. - - - -## Examples - The following code example shows how to use to create a case-insensitive sorted copy of the information in a case-insensitive , by passing the to the constructor. In this example, the case-insensitive comparers are for the current culture. - + must be unique according to the specified comparer; therefore, every key in the source `dictionary` must also be unique according to the specified comparer. + + requires a comparer implementation to perform key comparisons. If `comparer` is `null`, this constructor uses the default generic equality comparer, . If type `TKey` implements the generic interface, the default comparer uses that implementation. + + This constructor is an O(`n` log `n`) operation, where `n` is the number of elements in `dictionary`. + + + +## Examples + The following code example shows how to use to create a case-insensitive sorted copy of the information in a case-insensitive , by passing the to the constructor. In this example, the case-insensitive comparers are for the current culture. + :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/SortedDictionaryTKey,TValue/.ctor/source2.cs" interactive="try-dotnet" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedDictionary.ctor_IDicIComp/VB/source.vb" id="Snippet1"::: - + ]]> @@ -511,25 +511,25 @@ The value of the element to add. The value can be for reference types. Adds an element with the specified key and value into the . - property to add new elements by setting the value of a key that does not exist in the ; for example, `myCollection["myNonexistentKey"] = myValue` (in Visual Basic, `myCollection("myNonexistantKey") = myValue`). However, if the specified key already exists in the , setting the property overwrites the old value. In contrast, the method throws an exception if an element with the specified key already exists. - - A key cannot be `null`, but a value can be, if the value type `TValue` is a reference type. - - This method is an O(log `n`) operation, where `n` is . - - - -## Examples - The following code example creates an empty of strings with string keys and uses the method to add some elements. The example demonstrates that the method throws an when attempting to add a duplicate key. - - This code example is part of a larger example provided for the class. - + property to add new elements by setting the value of a key that does not exist in the ; for example, `myCollection["myNonexistentKey"] = myValue` (in Visual Basic, `myCollection("myNonexistantKey") = myValue`). However, if the specified key already exists in the , setting the property overwrites the old value. In contrast, the method throws an exception if an element with the specified key already exists. + + A key cannot be `null`, but a value can be, if the value type `TValue` is a reference type. + + This method is an O(log `n`) operation, where `n` is . + + + +## Examples + The following code example creates an empty of strings with string keys and uses the method to add some elements. The example demonstrates that the method throws an when attempting to add a duplicate key. + + This code example is part of a larger example provided for the class. + :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/SortedDictionaryTKey,TValue/Overview/source.cs" interactive="try-dotnet-method" id="Snippet2"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedDictionary/VB/source.vb" id="Snippet2"::: - + ]]> @@ -583,13 +583,13 @@ Removes all elements from the . - property is set to 0, and references to other objects from elements of the collection are also released. - - This method is an O(1) operation, since the root of the internal data structures is simply released for garbage collection. - + property is set to 0, and references to other objects from elements of the collection are also released. + + This method is an O(1) operation, since the root of the internal data structures is simply released for garbage collection. + ]]> @@ -633,13 +633,13 @@ Gets the used to order the elements of the . The used to order the elements of the - requires a comparer implementation to perform key comparisons. You can specify an implementation of the generic interface by using a constructor that accepts a `comparer` parameter. If you do not, the default generic equality comparer, , is used. If type `TKey` implements the generic interface, the default comparer uses that implementation. - - Getting the value of this property is an O(1) operation. - + requires a comparer implementation to perform key comparisons. You can specify an implementation of the generic interface by using a constructor that accepts a `comparer` parameter. If you do not, the default generic equality comparer, , is used. If type `TKey` implements the generic interface, the default comparer uses that implementation. + + Getting the value of this property is an O(1) operation. + ]]> @@ -693,25 +693,25 @@ if the contains an element with the specified key; otherwise, . - method to test whether a key exists prior to calling the method. It also shows how to use the method to retrieve values, which is an efficient way to retrieve values when a program frequently tries keys that are not in the dictionary. Finally, it shows the least efficient way to test whether keys exist, by using the property (the indexer in C#). - - This code example is part of a larger example provided for the class. - + method to test whether a key exists prior to calling the method. It also shows how to use the method to retrieve values, which is an efficient way to retrieve values when a program frequently tries keys that are not in the dictionary. Finally, it shows the least efficient way to test whether keys exist, by using the property (the indexer in C#). + + This code example is part of a larger example provided for the class. + :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/SortedDictionaryTKey,TValue/Overview/source.cs" id="Snippet6"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedDictionary/VB/source.vb" id="Snippet6"::: + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedDictionary/VB/source.vb" id="Snippet6"::: :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/SortedDictionaryTKey,TValue/Overview/source.cs" id="Snippet5"::: -:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedDictionary/VB/source.vb" id="Snippet5"::: +:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedDictionary/VB/source.vb" id="Snippet5"::: :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/SortedDictionaryTKey,TValue/Overview/source.cs" id="Snippet4"::: -:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedDictionary/VB/source.vb" id="Snippet4"::: - +:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedDictionary/VB/source.vb" id="Snippet4"::: + ]]> @@ -763,13 +763,13 @@ if the contains an element with the specified value; otherwise, . - for the value type `TValue`. - - This method performs a linear search; therefore, the average execution time is proportional to the property. That is, this method is an O(`n`) operation, where `n` is . - + for the value type `TValue`. + + This method performs a linear search; therefore, the average execution time is proportional to the property. That is, this method is an O(`n`) operation, where `n` is . + ]]> @@ -830,15 +830,15 @@ The zero-based index in at which copying begins. Copies the elements of the to the specified array of structures, starting at the specified index. - [!NOTE] -> If the type of the source cannot be cast automatically to the type of the destination `array`, the nongeneric implementations of throw , whereas the generic implementations throw . - - This method is an O(`n`) operation, where `n` is . - +> If the type of the source cannot be cast automatically to the type of the destination `array`, the nongeneric implementations of throw , whereas the generic implementations throw . + + This method is an O(`n`) operation, where `n` is . + ]]> @@ -892,11 +892,11 @@ Gets the number of key/value pairs contained in the . The number of key/value pairs contained in the . - @@ -941,31 +941,31 @@ Returns an enumerator that iterates through the . A for the . - structure representing a value and its key. - - The `foreach` statement of the C# language (`for each` in C++, `For Each` in Visual Basic) hides the complexity of enumerators. Therefore, using `foreach` is recommended, instead of directly manipulating the enumerator. - - Enumerators can be used to read the data in the collection, but they cannot be used to modify the underlying collection. - - The dictionary is maintained in a sorted order using an internal tree. Every new element is positioned at the correct sort position, and the tree is adjusted to maintain the sort order whenever an element is removed. While enumerating, the sort order is maintained. - - Initially, the enumerator is positioned before the first element in the collection. At this position, the property is undefined. Therefore, you must call the method to advance the enumerator to the first element of the collection before reading the value of . - - The property returns the same element until the method is called. sets to the next element. - - If passes the end of the collection, the enumerator is positioned after the last element in the collection and returns `false`. When the enumerator is at this position, subsequent calls to also return `false`. If the last call to returned `false`, is undefined. You cannot set to the first element of the collection again; you must create a new enumerator instance instead. - - An enumerator remains valid as long as the collection remains unchanged. If changes are made to the collection, such as adding, modifying, or deleting elements, the enumerator is irrecoverably invalidated and the next call to or throws an . - - The enumerator does not have exclusive access to the collection; therefore, enumerating through a collection is intrinsically not a thread-safe procedure. To guarantee thread safety during enumeration, you can lock the collection during the entire enumeration. To allow the collection to be accessed by multiple threads for reading and writing, you must implement your own synchronization. - - Default implementations of collections in the namespace are not synchronized. - - This method is an O(log n) operation, where n is count. - + structure representing a value and its key. + + The `foreach` statement of the C# language (`for each` in C++, `For Each` in Visual Basic) hides the complexity of enumerators. Therefore, using `foreach` is recommended, instead of directly manipulating the enumerator. + + Enumerators can be used to read the data in the collection, but they cannot be used to modify the underlying collection. + + The dictionary is maintained in a sorted order using an internal tree. Every new element is positioned at the correct sort position, and the tree is adjusted to maintain the sort order whenever an element is removed. While enumerating, the sort order is maintained. + + Initially, the enumerator is positioned before the first element in the collection. At this position, the property is undefined. Therefore, you must call the method to advance the enumerator to the first element of the collection before reading the value of . + + The property returns the same element until the method is called. sets to the next element. + + If passes the end of the collection, the enumerator is positioned after the last element in the collection and returns `false`. When the enumerator is at this position, subsequent calls to also return `false`. If the last call to returned `false`, is undefined. You cannot set to the first element of the collection again; you must create a new enumerator instance instead. + + An enumerator remains valid as long as the collection remains unchanged. If changes are made to the collection, such as adding, modifying, or deleting elements, the enumerator is irrecoverably invalidated and the next call to or throws an . + + The enumerator does not have exclusive access to the collection; therefore, enumerating through a collection is intrinsically not a thread-safe procedure. To guarantee thread safety during enumeration, you can lock the collection during the entire enumeration. To allow the collection to be accessed by multiple threads for reading and writing, you must implement your own synchronization. + + Default implementations of collections in the namespace are not synchronized. + + This method is an O(log n) operation, where n is count. + ]]> @@ -1018,35 +1018,35 @@ Gets or sets the value associated with the specified key. The value associated with the specified key. If the specified key is not found, a get operation throws a , and a set operation creates a new element with the specified key. - property to add new elements by setting the value of a key that does not exist in the ; for example, `myCollection["myNonexistentKey"] = myValue`. However, if the specified key already exists in the , setting the property overwrites the old value. In contrast, the method does not modify existing elements. - - A key cannot be `null`, but a value can be, if the value type `TValue` is a reference type. - - The C# language uses the [this](/dotnet/csharp/language-reference/keywords/this) keyword to define the indexers instead of implementing the property. Visual Basic implements as a default property, which provides the same indexing functionality. - - Getting the value of this property is an O(log `n`) operation; setting the property is also an O(log `n`) operation. - - - -## Examples - The following code example uses the property (the indexer in C#) to retrieve values, demonstrating that a is thrown when a requested key is not present, and showing that the value associated with a key can be replaced. - - The example also shows how to use the method as a more efficient way to retrieve values if a program often must try key values that are not in the dictionary. - - This code example is part of a larger example provided for the class. - + property to add new elements by setting the value of a key that does not exist in the ; for example, `myCollection["myNonexistentKey"] = myValue`. However, if the specified key already exists in the , setting the property overwrites the old value. In contrast, the method does not modify existing elements. + + A key cannot be `null`, but a value can be, if the value type `TValue` is a reference type. + + The C# language uses the [this](/dotnet/csharp/language-reference/keywords/this) keyword to define the indexers instead of implementing the property. Visual Basic implements as a default property, which provides the same indexing functionality. + + Getting the value of this property is an O(log `n`) operation; setting the property is also an O(log `n`) operation. + + + +## Examples + The following code example uses the property (the indexer in C#) to retrieve values, demonstrating that a is thrown when a requested key is not present, and showing that the value associated with a key can be replaced. + + The example also shows how to use the method as a more efficient way to retrieve values if a program often must try key values that are not in the dictionary. + + This code example is part of a larger example provided for the class. + :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/SortedDictionaryTKey,TValue/Overview/source.cs" id="Snippet3"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedDictionary/VB/source.vb" id="Snippet3"::: + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedDictionary/VB/source.vb" id="Snippet3"::: :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/SortedDictionaryTKey,TValue/Overview/source.cs" id="Snippet4"::: -:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedDictionary/VB/source.vb" id="Snippet4"::: +:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedDictionary/VB/source.vb" id="Snippet4"::: :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/SortedDictionaryTKey,TValue/Overview/source.cs" id="Snippet5"::: -:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedDictionary/VB/source.vb" id="Snippet5"::: - +:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedDictionary/VB/source.vb" id="Snippet5"::: + ]]> @@ -1094,27 +1094,27 @@ Gets a collection containing the keys in the . A containing the keys in the . - are sorted according to the property and are in the same order as the associated values in the returned by the property. - - The returned is not a static copy; instead, the refers back to the keys in the original . Therefore, changes to the continue to be reflected in the . - - Getting the value of this property is an O(1) operation. - - - -## Examples - The following code example shows how to enumerate the keys in the dictionary using the property, and how to enumerate the keys and values in the dictionary. - - This code is part of a larger example that can be compiled and executed. See . - + are sorted according to the property and are in the same order as the associated values in the returned by the property. + + The returned is not a static copy; instead, the refers back to the keys in the original . Therefore, changes to the continue to be reflected in the . + + Getting the value of this property is an O(1) operation. + + + +## Examples + The following code example shows how to enumerate the keys in the dictionary using the property, and how to enumerate the keys and values in the dictionary. + + This code is part of a larger example that can be compiled and executed. See . + :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/SortedDictionaryTKey,TValue/Overview/source.cs" id="Snippet9"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedDictionary/VB/source.vb" id="Snippet9"::: + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedDictionary/VB/source.vb" id="Snippet9"::: :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/SortedDictionaryTKey,TValue/Overview/source.cs" id="Snippet7"::: -:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedDictionary/VB/source.vb" id="Snippet7"::: - +:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedDictionary/VB/source.vb" id="Snippet7"::: + ]]> @@ -1168,23 +1168,23 @@ if the element is successfully removed; otherwise, . This method also returns if is not found in the . - does not contain an element with the specified key, the remains unchanged. No exception is thrown. - - This method is an O(log `n`) operation. - - - -## Examples - The following code example shows how to remove a key/value pair from the dictionary using the method. - - This code example is part of a larger example provided for the class. - + does not contain an element with the specified key, the remains unchanged. No exception is thrown. + + This method is an O(log `n`) operation. + + + +## Examples + The following code example shows how to remove a key/value pair from the dictionary using the method. + + This code example is part of a larger example provided for the class. + :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/SortedDictionaryTKey,TValue/Overview/source.cs" id="Snippet10"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedDictionary/VB/source.vb" id="Snippet10"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedDictionary/VB/source.vb" id="Snippet10"::: + ]]> @@ -1663,15 +1663,15 @@ The zero-based index in at which copying begins. Copies the elements of the to an array, starting at the specified array index. - [!NOTE] -> If the type of the source cannot be cast automatically to the type of the destination `array`, the nongeneric implementations of throw an , whereas the generic implementations throw an . - - This method is an O(`n`) operation, where `n` is . - +> If the type of the source cannot be cast automatically to the type of the destination `array`, the nongeneric implementations of throw an , whereas the generic implementations throw an . + + This method is an O(`n`) operation, where `n` is . + ]]> @@ -1679,18 +1679,18 @@ is less than 0. - is multidimensional. - - -or- - - does not have zero-based indexing. - - -or- - - The number of elements in the source is greater than the available space from to the end of the destination . - - -or- - + is multidimensional. + + -or- + + does not have zero-based indexing. + + -or- + + The number of elements in the source is greater than the available space from to the end of the destination . + + -or- + The type of the source cannot be cast automatically to the type of the destination . @@ -1737,17 +1737,17 @@ if access to the is synchronized (thread safe); otherwise, . In the default implementation of , this property always returns . - namespace are not synchronized. - - Enumerating through a collection is intrinsically not a thread-safe procedure. Even when a collection is synchronized, other threads can still modify the collection, which can cause the enumerator to throw an exception. To guarantee thread safety during enumeration, you can either lock the collection during the entire enumeration or catch the exceptions resulting from changes made by other threads. - - The property returns an object that can be used to synchronize access to the . Synchronization is effective only if all threads lock the object before accessing the collection. - - Getting the value of this property is an O(1) operation. - + namespace are not synchronized. + + Enumerating through a collection is intrinsically not a thread-safe procedure. Even when a collection is synchronized, other threads can still modify the collection, which can cause the enumerator to throw an exception. To guarantee thread safety during enumeration, you can either lock the collection during the entire enumeration or catch the exceptions resulting from changes made by other threads. + + The property returns an object that can be used to synchronize access to the . Synchronization is effective only if all threads lock the object before accessing the collection. + + Getting the value of this property is an O(1) operation. + ]]> @@ -1795,45 +1795,45 @@ Gets an object that can be used to synchronize access to the . An object that can be used to synchronize access to the . - namespace are not synchronized. - - Enumerating through a collection is intrinsically not a thread-safe procedure. To guarantee thread safety during enumeration, you can lock the collection during the entire enumeration. To allow the collection to be accessed by multiple threads for reading and writing, you must implement your own synchronization. - - The property returns an object that can be used to synchronize access to the . Synchronization is effective only if all threads lock the object before accessing the collection. The following code shows the use of the property for C#, C++, and Visual Basic. - -```csharp -ICollection ic = ...; -lock (ic.SyncRoot) -{ - // Access the collection. -} -``` - -```vb -Dim ic As ICollection = ... -SyncLock ic.SyncRoot - ' Access the collection. -End SyncLock -``` - -```cpp -ICollection^ ic = ...; -try -{ - Monitor::Enter(ic->SyncRoot); - // Access the collection. -} -finally -{ - Monitor::Exit(ic->SyncRoot); -} -``` - - Getting the value of this property is an O(1) operation. - + namespace are not synchronized. + + Enumerating through a collection is intrinsically not a thread-safe procedure. To guarantee thread safety during enumeration, you can lock the collection during the entire enumeration. To allow the collection to be accessed by multiple threads for reading and writing, you must implement your own synchronization. + + The property returns an object that can be used to synchronize access to the . Synchronization is effective only if all threads lock the object before accessing the collection. The following code shows the use of the property for C#, C++, and Visual Basic. + +```csharp +ICollection ic = ...; +lock (ic.SyncRoot) +{ + // Access the collection. +} +``` + +```vb +Dim ic As ICollection = ... +SyncLock ic.SyncRoot + ' Access the collection. +End SyncLock +``` + +```cpp +ICollection^ ic = ...; +try +{ + Monitor::Enter(ic->SyncRoot); + // Access the collection. +} +finally +{ + Monitor::Exit(ic->SyncRoot); +} +``` + + Getting the value of this property is an O(1) operation. + ]]> @@ -1886,36 +1886,36 @@ finally The object to use as the value of the element to add. Adds an element with the provided key and value to the . - property to add new elements by setting the value of a key that does not exist in the dictionary; for example, `myCollection["myNonexistentKey"] = myValue`. However, if the specified key already exists in the dictionary, setting the property overwrites the old value. In contrast, the method does not modify existing elements. - - This method is an O(log `n`) operation, where `n` is . - - - -## Examples - The following code example shows how to access the class through the interface. The code example creates an empty of strings with string keys and uses the method to add some elements. The example demonstrates that the method throws an when attempting to add a duplicate key, or when a key or value of the wrong data type is supplied. - - The code example demonstrates the use of several other members of the interface. - + property to add new elements by setting the value of a key that does not exist in the dictionary; for example, `myCollection["myNonexistentKey"] = myValue`. However, if the specified key already exists in the dictionary, setting the property overwrites the old value. In contrast, the method does not modify existing elements. + + This method is an O(log `n`) operation, where `n` is . + + + +## Examples + The following code example shows how to access the class through the interface. The code example creates an empty of strings with string keys and uses the method to add some elements. The example demonstrates that the method throws an when attempting to add a duplicate key, or when a key or value of the wrong data type is supplied. + + The code example demonstrates the use of several other members of the interface. + :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/SortedDictionaryTKey,TValue/System.Collections.IDictionary.Add/source.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedDictionary.IDictionary/VB/source.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedDictionary.IDictionary/VB/source.vb" id="Snippet1"::: + ]]> is . - is of a type that is not assignable to the key type of the . - - -or- - - is of a type that is not assignable to the value type of the . - - -or- - + is of a type that is not assignable to the key type of the . + + -or- + + is of a type that is not assignable to the value type of the . + + -or- + An element with the same key already exists in the . @@ -1967,27 +1967,27 @@ finally if the contains an element with the key; otherwise, . - . - - This method is an O(log `n`) operation, where `n` is . - - - -## Examples - The following code example shows how to use the method of the interface with a . The example demonstrates that the method returns `false` if a key of the wrong data type is supplied. - - The code example is part of a larger example, including output, provided for the method. - + . + + This method is an O(log `n`) operation, where `n` is . + + + +## Examples + The following code example shows how to use the method of the interface with a . The example demonstrates that the method returns `false` if a key of the wrong data type is supplied. + + The code example is part of a larger example, including output, provided for the method. + :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/SortedDictionaryTKey,TValue/System.Collections.IDictionary.Add/source.cs" id="Snippet31"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedDictionary.IDictionary/VB/source.vb" id="Snippet31"::: + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedDictionary.IDictionary/VB/source.vb" id="Snippet31"::: :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/SortedDictionaryTKey,TValue/System.Collections.IDictionary.Add/source.cs" id="Snippet6"::: -:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedDictionary.IDictionary/VB/source.vb" id="Snippet6"::: +:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedDictionary.IDictionary/VB/source.vb" id="Snippet6"::: :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/SortedDictionaryTKey,TValue/System.Collections.IDictionary.Add/source.cs" id="Snippet32"::: -:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedDictionary.IDictionary/VB/source.vb" id="Snippet32"::: - +:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedDictionary.IDictionary/VB/source.vb" id="Snippet32"::: + ]]> @@ -2037,43 +2037,43 @@ finally Returns an for the . An for the . - structure. - - The `foreach` statement of the C# language (`for each` in C++, `For Each` in Visual Basic) hides the complexity of enumerators. Therefore, using `foreach` is recommended, instead of directly manipulating the enumerator. - - Enumerators can be used to read the data in the collection, but they cannot be used to modify the underlying collection. - - Initially, the enumerator is positioned before the first element in the collection. The method also brings the enumerator back to this position. At this position, is undefined. Therefore, you must call the method to advance the enumerator to the first element of the collection before reading the value of . - - The property returns the same object until either or is called. sets to the next element. - - If passes the end of the collection, the enumerator is positioned after the last element in the collection and returns `false`. When the enumerator is at this position, subsequent calls to also return `false`. If the last call to returned `false`, is undefined. To set to the first element of the collection again, you can call followed by . - - An enumerator remains valid as long as the collection remains unchanged. If changes are made to the collection, such as adding, modifying, or deleting elements, the enumerator is irrecoverably invalidated and the next call to or throws an . - - The enumerator does not have exclusive access to the collection; therefore, enumerating through a collection is intrinsically not a thread-safe procedure. To guarantee thread safety during enumeration, you can lock the collection during the entire enumeration. To allow the collection to be accessed by multiple threads for reading and writing, you must implement your own synchronization. - - Default implementations of collections in the namespace are not synchronized. - + structure. + + The `foreach` statement of the C# language (`for each` in C++, `For Each` in Visual Basic) hides the complexity of enumerators. Therefore, using `foreach` is recommended, instead of directly manipulating the enumerator. + + Enumerators can be used to read the data in the collection, but they cannot be used to modify the underlying collection. + + Initially, the enumerator is positioned before the first element in the collection. The method also brings the enumerator back to this position. At this position, is undefined. Therefore, you must call the method to advance the enumerator to the first element of the collection before reading the value of . + + The property returns the same object until either or is called. sets to the next element. + + If passes the end of the collection, the enumerator is positioned after the last element in the collection and returns `false`. When the enumerator is at this position, subsequent calls to also return `false`. If the last call to returned `false`, is undefined. To set to the first element of the collection again, you can call followed by . + + An enumerator remains valid as long as the collection remains unchanged. If changes are made to the collection, such as adding, modifying, or deleting elements, the enumerator is irrecoverably invalidated and the next call to or throws an . + + The enumerator does not have exclusive access to the collection; therefore, enumerating through a collection is intrinsically not a thread-safe procedure. To guarantee thread safety during enumeration, you can lock the collection during the entire enumeration. To allow the collection to be accessed by multiple threads for reading and writing, you must implement your own synchronization. + + Default implementations of collections in the namespace are not synchronized. + This method is an O(log n) operation where n is a number of elements in a collection. - - - -## Examples - The following code example shows how to enumerate the key/value pairs in the dictionary by using the `foreach` statement (`For Each` in Visual Basic, `for each` in C++), which hides the use of the enumerator. In particular, note that the enumerator for the interface returns objects rather than objects. - - The code example is part of a larger example, including output, provided for the method. - + + + +## Examples + The following code example shows how to enumerate the key/value pairs in the dictionary by using the `foreach` statement (`For Each` in Visual Basic, `for each` in C++), which hides the use of the enumerator. In particular, note that the enumerator for the interface returns objects rather than objects. + + The code example is part of a larger example, including output, provided for the method. + :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/SortedDictionaryTKey,TValue/System.Collections.IDictionary.Add/source.cs" id="Snippet31"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedDictionary.IDictionary/VB/source.vb" id="Snippet31"::: + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedDictionary.IDictionary/VB/source.vb" id="Snippet31"::: :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/SortedDictionaryTKey,TValue/System.Collections.IDictionary.Add/source.cs" id="Snippet7"::: -:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedDictionary.IDictionary/VB/source.vb" id="Snippet7"::: +:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedDictionary.IDictionary/VB/source.vb" id="Snippet7"::: :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/SortedDictionaryTKey,TValue/System.Collections.IDictionary.Add/source.cs" id="Snippet32"::: -:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedDictionary.IDictionary/VB/source.vb" id="Snippet32"::: - +:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedDictionary.IDictionary/VB/source.vb" id="Snippet32"::: + ]]> @@ -2123,15 +2123,15 @@ finally if the has a fixed size; otherwise, . In the default implementation of , this property always returns . - @@ -2179,15 +2179,15 @@ finally if the is read-only; otherwise, . In the default implementation of , this property always returns . - @@ -2245,44 +2245,44 @@ finally Gets or sets the element with the specified key. The element with the specified key, or if is not in the dictionary or is of a type that is not assignable to the key type of the . - property to add new elements by setting the value of a key that does not exist in the dictionary; for example, `myCollection["myNonexistentKey"] = myValue`. However, if the specified key already exists in the dictionary, setting the property overwrites the old value. In contrast, the method does not modify existing elements. - - The C# language uses the [this](/dotnet/csharp/language-reference/keywords/this) keyword to define the indexers instead of implementing the property. Visual Basic implements as a default property, which provides the same indexing functionality. - - Getting the value of this property is an O(log `n`) operation; setting the property is also an O(log `n`) operation. - - - -## Examples - The following code example shows how to use the property (the indexer in C#) of the interface with a , and ways the property differs from the property. - - The example shows that, like the property, the property can change the value associated with an existing key and can be used to add a new key/value pair if the specified key is not in the dictionary. The example also shows that unlike the property, the property does not throw an exception if `key` is not in the dictionary, returning a null reference instead. Finally, the example demonstrates that getting the property returns a null reference if `key` is not the correct data type, and that setting the property throws an exception if `key` is not the correct data type. - - The code example is part of a larger example, including output, provided for the method. - + property to add new elements by setting the value of a key that does not exist in the dictionary; for example, `myCollection["myNonexistentKey"] = myValue`. However, if the specified key already exists in the dictionary, setting the property overwrites the old value. In contrast, the method does not modify existing elements. + + The C# language uses the [this](/dotnet/csharp/language-reference/keywords/this) keyword to define the indexers instead of implementing the property. Visual Basic implements as a default property, which provides the same indexing functionality. + + Getting the value of this property is an O(log `n`) operation; setting the property is also an O(log `n`) operation. + + + +## Examples + The following code example shows how to use the property (the indexer in C#) of the interface with a , and ways the property differs from the property. + + The example shows that, like the property, the property can change the value associated with an existing key and can be used to add a new key/value pair if the specified key is not in the dictionary. The example also shows that unlike the property, the property does not throw an exception if `key` is not in the dictionary, returning a null reference instead. Finally, the example demonstrates that getting the property returns a null reference if `key` is not the correct data type, and that setting the property throws an exception if `key` is not the correct data type. + + The code example is part of a larger example, including output, provided for the method. + :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/SortedDictionaryTKey,TValue/System.Collections.IDictionary.Add/source.cs" id="Snippet31"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedDictionary.IDictionary/VB/source.vb" id="Snippet31"::: + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedDictionary.IDictionary/VB/source.vb" id="Snippet31"::: :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/SortedDictionaryTKey,TValue/System.Collections.IDictionary.Add/source.cs" id="Snippet3"::: -:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedDictionary.IDictionary/VB/source.vb" id="Snippet3"::: +:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedDictionary.IDictionary/VB/source.vb" id="Snippet3"::: :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/SortedDictionaryTKey,TValue/System.Collections.IDictionary.Add/source.cs" id="Snippet4"::: -:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedDictionary.IDictionary/VB/source.vb" id="Snippet4"::: +:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedDictionary.IDictionary/VB/source.vb" id="Snippet4"::: :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/SortedDictionaryTKey,TValue/System.Collections.IDictionary.Add/source.cs" id="Snippet32"::: -:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedDictionary.IDictionary/VB/source.vb" id="Snippet32"::: - +:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedDictionary.IDictionary/VB/source.vb" id="Snippet32"::: + ]]> is . - A value is being assigned, and is of a type that is not assignable to the key type of the . - - -or- - - A value is being assigned, and is of a type that is not assignable to the value type of the . + A value is being assigned, and is of a type that is not assignable to the key type of the . + + -or- + + A value is being assigned and is of a type that isn't assignable to the value type of the . @@ -2334,29 +2334,29 @@ finally Gets an containing the keys of the . An containing the keys of the . - are sorted according to the property and are guaranteed to be in the same order as the corresponding values in the returned by the property. - - Getting the value of this property is an O(1) operation. - - - -## Examples - The following code example shows how to use the property of the interface with a , to list the keys in the dictionary. The example also shows how to enumerate the key/value pairs in the dictionary; note that the enumerator for the interface returns objects rather than objects. - - The code example is part of a larger example, including output, provided for the method. - + are sorted according to the property and are guaranteed to be in the same order as the corresponding values in the returned by the property. + + Getting the value of this property is an O(1) operation. + + + +## Examples + The following code example shows how to use the property of the interface with a , to list the keys in the dictionary. The example also shows how to enumerate the key/value pairs in the dictionary; note that the enumerator for the interface returns objects rather than objects. + + The code example is part of a larger example, including output, provided for the method. + :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/SortedDictionaryTKey,TValue/System.Collections.IDictionary.Add/source.cs" id="Snippet31"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedDictionary.IDictionary/VB/source.vb" id="Snippet31"::: + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedDictionary.IDictionary/VB/source.vb" id="Snippet31"::: :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/SortedDictionaryTKey,TValue/System.Collections.IDictionary.Add/source.cs" id="Snippet9"::: -:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedDictionary.IDictionary/VB/source.vb" id="Snippet9"::: +:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedDictionary.IDictionary/VB/source.vb" id="Snippet9"::: :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/SortedDictionaryTKey,TValue/System.Collections.IDictionary.Add/source.cs" id="Snippet7"::: -:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedDictionary.IDictionary/VB/source.vb" id="Snippet7"::: +:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedDictionary.IDictionary/VB/source.vb" id="Snippet7"::: :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/SortedDictionaryTKey,TValue/System.Collections.IDictionary.Add/source.cs" id="Snippet32"::: -:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedDictionary.IDictionary/VB/source.vb" id="Snippet32"::: - +:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedDictionary.IDictionary/VB/source.vb" id="Snippet32"::: + ]]> @@ -2407,25 +2407,25 @@ finally The key of the element to remove. Removes the element with the specified key from the . - of the interface with a . - - The code example is part of a larger example, including output, provided for the method. - + of the interface with a . + + The code example is part of a larger example, including output, provided for the method. + :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/SortedDictionaryTKey,TValue/System.Collections.IDictionary.Add/source.cs" id="Snippet31"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedDictionary.IDictionary/VB/source.vb" id="Snippet31"::: + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedDictionary.IDictionary/VB/source.vb" id="Snippet31"::: :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/SortedDictionaryTKey,TValue/System.Collections.IDictionary.Add/source.cs" id="Snippet10"::: -:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedDictionary.IDictionary/VB/source.vb" id="Snippet10"::: +:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedDictionary.IDictionary/VB/source.vb" id="Snippet10"::: :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/SortedDictionaryTKey,TValue/System.Collections.IDictionary.Add/source.cs" id="Snippet32"::: -:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedDictionary.IDictionary/VB/source.vb" id="Snippet32"::: - +:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedDictionary.IDictionary/VB/source.vb" id="Snippet32"::: + ]]> @@ -2480,29 +2480,29 @@ finally Gets an containing the values in the . An containing the values in the . - are sorted according to the property, and are guaranteed to be in the same order as the corresponding keys in the returned by the property. - - Getting the value of this property is an O(1) operation. - - - -## Examples - The following code example shows how to use the property of the interface with a , to list the values in the dictionary. The example also shows how to enumerate the key/value pairs in the dictionary; note that the enumerator for the interface returns objects rather than objects. - - The code example is part of a larger example, including output, provided for the method. - + are sorted according to the property, and are guaranteed to be in the same order as the corresponding keys in the returned by the property. + + Getting the value of this property is an O(1) operation. + + + +## Examples + The following code example shows how to use the property of the interface with a , to list the values in the dictionary. The example also shows how to enumerate the key/value pairs in the dictionary; note that the enumerator for the interface returns objects rather than objects. + + The code example is part of a larger example, including output, provided for the method. + :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/SortedDictionaryTKey,TValue/System.Collections.IDictionary.Add/source.cs" id="Snippet31"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedDictionary.IDictionary/VB/source.vb" id="Snippet31"::: + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedDictionary.IDictionary/VB/source.vb" id="Snippet31"::: :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/SortedDictionaryTKey,TValue/System.Collections.IDictionary.Add/source.cs" id="Snippet8"::: -:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedDictionary.IDictionary/VB/source.vb" id="Snippet8"::: +:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedDictionary.IDictionary/VB/source.vb" id="Snippet8"::: :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/SortedDictionaryTKey,TValue/System.Collections.IDictionary.Add/source.cs" id="Snippet7"::: -:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedDictionary.IDictionary/VB/source.vb" id="Snippet7"::: +:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedDictionary.IDictionary/VB/source.vb" id="Snippet7"::: :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/SortedDictionaryTKey,TValue/System.Collections.IDictionary.Add/source.cs" id="Snippet32"::: -:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedDictionary.IDictionary/VB/source.vb" id="Snippet32"::: - +:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedDictionary.IDictionary/VB/source.vb" id="Snippet32"::: + ]]> @@ -2551,28 +2551,28 @@ finally Returns an enumerator that iterates through the collection. An that can be used to iterate through the collection. - property is undefined. Therefore, you must call the method to advance the enumerator to the first element of the collection before reading the value of . - - The property returns the same element until the method is called. sets to the next element. - - If passes the end of the collection, the enumerator is positioned after the last element in the collection and returns `false`. When the enumerator is at this position, subsequent calls to also return `false`. If the last call to returned `false`, is undefined. You cannot set to the first element of the collection again; you must create a new enumerator instance instead. - - An enumerator remains valid as long as the collection remains unchanged. If changes are made to the collection, such as adding, modifying, or deleting elements, the enumerator is irrecoverably invalidated and the next call to or throws an . - - The enumerator does not have exclusive access to the collection; therefore, enumerating through a collection is intrinsically not a thread-safe procedure. To guarantee thread safety during enumeration, you can lock the collection during the entire enumeration. To allow the collection to be accessed by multiple threads for reading and writing, you must implement your own synchronization. - - Default implementations of collections in the namespace are not synchronized. - + property is undefined. Therefore, you must call the method to advance the enumerator to the first element of the collection before reading the value of . + + The property returns the same element until the method is called. sets to the next element. + + If passes the end of the collection, the enumerator is positioned after the last element in the collection and returns `false`. When the enumerator is at this position, subsequent calls to also return `false`. If the last call to returned `false`, is undefined. You cannot set to the first element of the collection again; you must create a new enumerator instance instead. + + An enumerator remains valid as long as the collection remains unchanged. If changes are made to the collection, such as adding, modifying, or deleting elements, the enumerator is irrecoverably invalidated and the next call to or throws an . + + The enumerator does not have exclusive access to the collection; therefore, enumerating through a collection is intrinsically not a thread-safe procedure. To guarantee thread safety during enumeration, you can lock the collection during the entire enumeration. To allow the collection to be accessed by multiple threads for reading and writing, you must implement your own synchronization. + + Default implementations of collections in the namespace are not synchronized. + This method is an O(log n) operation where n is a number of elements in a collection. - + ]]> @@ -2636,27 +2636,27 @@ finally if the contains an element with the specified key; otherwise, . - method and the property. - - If the key is not found, then the `value` parameter gets the appropriate default value for the value type `TValue`; for example, 0 (zero) for integer types, `false` for Boolean types, and `null` for reference types. - - This method is an O(log `n`) operation. - - - -## Examples - The example shows how to use the method as a more efficient way to retrieve values in a program that frequently tries keys that are not in the dictionary. For contrast, the example also shows how the property (the indexer in C#) throws exceptions when attempting to retrieve nonexistent keys. - - This code example is part of a larger example provided for the class. - + method and the property. + + If the key is not found, then the `value` parameter gets the appropriate default value for the value type `TValue`; for example, 0 (zero) for integer types, `false` for Boolean types, and `null` for reference types. + + This method is an O(log `n`) operation. + + + +## Examples + The example shows how to use the method as a more efficient way to retrieve values in a program that frequently tries keys that are not in the dictionary. For contrast, the example also shows how the property (the indexer in C#) throws exceptions when attempting to retrieve nonexistent keys. + + This code example is part of a larger example provided for the class. + :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/SortedDictionaryTKey,TValue/Overview/source.cs" id="Snippet5"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedDictionary/VB/source.vb" id="Snippet5"::: + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedDictionary/VB/source.vb" id="Snippet5"::: :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/SortedDictionaryTKey,TValue/Overview/source.cs" id="Snippet4"::: -:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedDictionary/VB/source.vb" id="Snippet4"::: - +:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedDictionary/VB/source.vb" id="Snippet4"::: + ]]> @@ -2704,27 +2704,27 @@ finally Gets a collection containing the values in the . A containing the values in the . - are sorted according to the property, and are in the same order as the associated keys in the returned by the property. - - The returned is not a static copy; instead, the refers back to the values in the original . Therefore, changes to the continue to be reflected in the . - - Getting the value of this property is an O(1) operation. - - - -## Examples - This code example shows how to enumerate the values in the dictionary using the property, and how to enumerate the keys and values in the dictionary. - - This code example is part of a larger example provided for the class. - + are sorted according to the property, and are in the same order as the associated keys in the returned by the property. + + The returned is not a static copy; instead, the refers back to the values in the original . Therefore, changes to the continue to be reflected in the . + + Getting the value of this property is an O(1) operation. + + + +## Examples + This code example shows how to enumerate the values in the dictionary using the property, and how to enumerate the keys and values in the dictionary. + + This code example is part of a larger example provided for the class. + :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/SortedDictionaryTKey,TValue/Overview/source.cs" id="Snippet8"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedDictionary/VB/source.vb" id="Snippet8"::: + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedDictionary/VB/source.vb" id="Snippet8"::: :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/SortedDictionaryTKey,TValue/Overview/source.cs" id="Snippet7"::: -:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedDictionary/VB/source.vb" id="Snippet7"::: - +:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedDictionary/VB/source.vb" id="Snippet7"::: + ]]> diff --git a/xml/System.Collections.Generic/SortedList`2.xml b/xml/System.Collections.Generic/SortedList`2.xml index e0f9f3cc4f2..228317ac31d 100644 --- a/xml/System.Collections.Generic/SortedList`2.xml +++ b/xml/System.Collections.Generic/SortedList`2.xml @@ -112,65 +112,65 @@ The type of values in the collection. Represents a collection of key/value pairs that are sorted by key based on the associated implementation. - generic class is an array of key/value pairs with O(log `n`) retrieval, where n is the number of elements in the dictionary. In this, it is similar to the generic class. The two classes have similar object models, and both have O(log `n`) retrieval. Where the two classes differ is in memory use and speed of insertion and removal: - -- uses less memory than . - -- has faster insertion and removal operations for unsorted data, O(log `n`) as opposed to O(`n`) for . - -- If the list is populated all at once from sorted data, is faster than . - - Another difference between the and classes is that supports efficient indexed retrieval of keys and values through the collections returned by the and properties. It is not necessary to regenerate the lists when the properties are accessed, because the lists are just wrappers for the internal arrays of keys and values. The following code shows the use of the property for indexed retrieval of values from a sorted list of strings: - + generic class is an array of key/value pairs with O(log `n`) retrieval, where n is the number of elements in the dictionary. In this, it is similar to the generic class. The two classes have similar object models, and both have O(log `n`) retrieval. Where the two classes differ is in memory use and speed of insertion and removal: + +- uses less memory than . + +- has faster insertion and removal operations for unsorted data, O(log `n`) as opposed to O(`n`) for . + +- If the list is populated all at once from sorted data, is faster than . + + Another difference between the and classes is that supports efficient indexed retrieval of keys and values through the collections returned by the and properties. It is not necessary to regenerate the lists when the properties are accessed, because the lists are just wrappers for the internal arrays of keys and values. The following code shows the use of the property for indexed retrieval of values from a sorted list of strings: + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/Generic.SortedList/cpp/remarks.cpp" id="Snippet11"::: :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/SortedListTKey,TValue/Overview/remarks.cs" id="Snippet11"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedList/VB/remarks.vb" id="Snippet11"::: - :::code language="fsharp" source="~/snippets/fsharp/System.Collections.Generic/SortedListTKey,TValue/Overview/remarks.fs" id="Snippet11"::: - - is implemented as an array of key/value pairs, sorted by the key. Each element can be retrieved as a object. - - Key objects must be immutable as long as they are used as keys in the . Every key in a must be unique. A key cannot be `null`, but a value can be, if the type of values in the list, `TValue`, is a reference type. - - requires a comparer implementation to sort and to perform comparisons. The default comparer checks whether the key type `TKey` implements and uses that implementation, if available. If not, checks whether the key type `TKey` implements . If the key type `TKey` does not implement either interface, you can specify a implementation in a constructor overload that accepts a `comparer` parameter. - - The capacity of a is the number of elements the can hold. As elements are added to a , the capacity is automatically increased as required by reallocating the internal array. The capacity can be decreased by calling or by setting the property explicitly. Decreasing the capacity reallocates memory and copies all the elements in the . - - **.NET Framework only:** For very large objects, you can increase the maximum capacity to 2 billion elements on a 64-bit system by setting the `enabled` attribute of the [``](/dotnet/framework/configure-apps/file-schema/runtime/gcallowverylargeobjects-element) configuration element to `true` in the run-time environment. - - The `foreach` statement of the C# language (`for each` in C++, `For Each` in Visual Basic) returns an object of the type of the elements in the collection. Since the elements of the are key/value pairs, the element type is not the type of the key or the type of the value. Instead, the element type is . For example: - + :::code language="fsharp" source="~/snippets/fsharp/System.Collections.Generic/SortedListTKey,TValue/Overview/remarks.fs" id="Snippet11"::: + + is implemented as an array of key/value pairs, sorted by the key. Each element can be retrieved as a object. + + Key objects must be immutable as long as they are used as keys in the . Every key in a must be unique. A key cannot be `null`, but a value can be, if the type of values in the list, `TValue`, is a reference type. + + requires a comparer implementation to sort and to perform comparisons. The default comparer checks whether the key type `TKey` implements and uses that implementation, if available. If not, checks whether the key type `TKey` implements . If the key type `TKey` does not implement either interface, you can specify a implementation in a constructor overload that accepts a `comparer` parameter. + + The capacity of a is the number of elements the can hold. As elements are added to a , the capacity is automatically increased as required by reallocating the internal array. The capacity can be decreased by calling or by setting the property explicitly. Decreasing the capacity reallocates memory and copies all the elements in the . + + **.NET Framework only:** For very large objects, you can increase the maximum capacity to 2 billion elements on a 64-bit system by setting the `enabled` attribute of the [``](/dotnet/framework/configure-apps/file-schema/runtime/gcallowverylargeobjects-element) configuration element to `true` in the run-time environment. + + The `foreach` statement of the C# language (`for each` in C++, `For Each` in Visual Basic) returns an object of the type of the elements in the collection. Since the elements of the are key/value pairs, the element type is not the type of the key or the type of the value. Instead, the element type is . For example: + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/Generic.SortedList/cpp/remarks.cpp" id="Snippet12"::: :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/SortedListTKey,TValue/Overview/remarks.cs" id="Snippet12"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedList/VB/remarks.vb" id="Snippet12"::: + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedList/VB/remarks.vb" id="Snippet12"::: :::code language="fsharp" source="~/snippets/fsharp/System.Collections.Generic/SortedListTKey,TValue/Overview/remarks.fs" id="Snippet12"::: - - The `foreach` statement is a wrapper around the enumerator, which only allows reading from, not writing to, the collection. - - - -## Examples - The following code example creates an empty of strings with string keys and uses the method to add some elements. The example demonstrates that the method throws an when attempting to add a duplicate key. - - The example uses the property (the indexer in C#) to retrieve values, demonstrating that a is thrown when a requested key is not present, and showing that the value associated with a key can be replaced. - - The example shows how to use the method as a more efficient way to retrieve values if a program often must try key values that are not in the sorted list, and it shows how to use the method to test whether a key exists before calling the method. - - The example shows how to enumerate the keys and values in the sorted list and how to enumerate the keys and values alone using the property and the property. - - Finally, the example demonstrates the method. - + + The `foreach` statement is a wrapper around the enumerator, which only allows reading from, not writing to, the collection. + + + +## Examples + The following code example creates an empty of strings with string keys and uses the method to add some elements. The example demonstrates that the method throws an when attempting to add a duplicate key. + + The example uses the property (the indexer in C#) to retrieve values, demonstrating that a is thrown when a requested key is not present, and showing that the value associated with a key can be replaced. + + The example shows how to use the method as a more efficient way to retrieve values if a program often must try key values that are not in the sorted list, and it shows how to use the method to test whether a key exists before calling the method. + + The example shows how to enumerate the keys and values in the sorted list and how to enumerate the keys and values alone using the property and the property. + + Finally, the example demonstrates the method. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/Generic.SortedList/cpp/source.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/SortedListTKey,TValue/Overview/source.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedList/VB/source.vb" id="Snippet1"::: + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedList/VB/source.vb" id="Snippet1"::: :::code language="fsharp" source="~/snippets/fsharp/System.Collections.Generic/SortedListTKey,TValue/Overview/source.fs" id="Snippet1"::: - + ]]> - Public static ( in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe. - + Public static ( in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe. + A can support multiple readers concurrently, as long as the collection is not modified. Even so, enumerating through a collection is intrinsically not a thread-safe procedure. To guarantee thread safety during enumeration, you can lock the collection during the entire enumeration. To allow the collection to be accessed by multiple threads for reading and writing, you must implement your own synchronization. @@ -223,29 +223,29 @@ Initializes a new instance of the class that is empty, has the default initial capacity, and uses the default . - must be unique according to the default comparer. - - This constructor uses the default value for the initial capacity of the . To set the initial capacity, use the constructor. If the final size of the collection can be estimated, specifying the initial capacity eliminates the need to perform a number of resizing operations while adding elements to the . - - This constructor uses the default comparer for `TKey`. To specify a comparer, use the constructor. The default comparer checks whether the key type `TKey` implements and uses that implementation, if available. If not, checks whether the key type `TKey` implements . If the key type `TKey` does not implement either interface, you can specify a implementation in a constructor overload that accepts a `comparer` parameter. - - This constructor is an O(1) operation. - - - -## Examples - The following code example creates an empty of strings with string keys and uses the method to add some elements. The example demonstrates that the method throws an when attempting to add a duplicate key. - - This code example is part of a larger example provided for the class. - + must be unique according to the default comparer. + + This constructor uses the default value for the initial capacity of the . To set the initial capacity, use the constructor. If the final size of the collection can be estimated, specifying the initial capacity eliminates the need to perform a number of resizing operations while adding elements to the . + + This constructor uses the default comparer for `TKey`. To specify a comparer, use the constructor. The default comparer checks whether the key type `TKey` implements and uses that implementation, if available. If not, checks whether the key type `TKey` implements . If the key type `TKey` does not implement either interface, you can specify a implementation in a constructor overload that accepts a `comparer` parameter. + + This constructor is an O(1) operation. + + + +## Examples + The following code example creates an empty of strings with string keys and uses the method to add some elements. The example demonstrates that the method throws an when attempting to add a duplicate key. + + This code example is part of a larger example provided for the class. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/Generic.SortedList/cpp/source.cpp" id="Snippet2"::: :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/SortedListTKey,TValue/Overview/source.cs" interactive="try-dotnet-method" id="Snippet2"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedList/VB/source.vb" id="Snippet2"::: :::code language="fsharp" source="~/snippets/fsharp/System.Collections.Generic/SortedListTKey,TValue/Overview/source.fs" id="Snippet2"::: - + ]]> @@ -296,30 +296,30 @@ - The implementation to use when comparing keys. - - -or- - + The implementation to use when comparing keys. + + -or- + to use the default for the type of the key. Initializes a new instance of the class that is empty, has the default initial capacity, and uses the specified . - must be unique according to the specified comparer. - - This constructor uses the default value for the initial capacity of the . To set the initial capacity, use the constructor. If the final size of the collection can be estimated, specifying the initial capacity eliminates the need to perform a number of resizing operations while adding elements to the . - - This constructor is an O(1) operation. - - - -## Examples - The following code example creates a sorted list with a case-insensitive comparer for the current culture. The example adds four elements, some with lower-case keys and some with upper-case keys. The example then attempts to add an element with a key that differs from an existing key only by case, catches the resulting exception, and displays an error message. Finally, the example displays the elements in case-insensitive sort order. - + must be unique according to the specified comparer. + + This constructor uses the default value for the initial capacity of the . To set the initial capacity, use the constructor. If the final size of the collection can be estimated, specifying the initial capacity eliminates the need to perform a number of resizing operations while adding elements to the . + + This constructor is an O(1) operation. + + + +## Examples + The following code example creates a sorted list with a case-insensitive comparer for the current culture. The example adds four elements, some with lower-case keys and some with upper-case keys. The example then attempts to add an element with a key that differs from an existing key only by case, catches the resulting exception, and displays an error message. Finally, the example displays the elements in case-insensitive sort order. + :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/SortedListTKey,TValue/.ctor/source.cs" interactive="try-dotnet" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedList.ctor_IComp/VB/source.vb" id="Snippet1"::: - + ]]> @@ -372,22 +372,22 @@ The whose elements are copied to the new . Initializes a new instance of the class that contains elements copied from the specified , has sufficient capacity to accommodate the number of elements copied, and uses the default . - must be unique according to the default comparer; likewise, every key in the source `dictionary` must also be unique according to the default comparer. - - The capacity of the new is set to the number of elements in `dictionary`, so no resizing takes place while the list is being populated. - - This constructor uses the default comparer for `TKey`. To specify a comparer, use the constructor. The default comparer checks whether the key type `TKey` implements and uses that implementation, if available. If not, checks whether the key type `TKey` implements . If the key type `TKey` does not implement either interface, you can specify a implementation in a constructor overload that accepts a `comparer` parameter. - - The keys in `dictionary` are copied to the new and sorted once, which makes this constructor an O(`n` log `n`) operation. - - - -## Examples - The following code example shows how to use to create a sorted copy of the information in a , by passing the to the constructor. - + must be unique according to the default comparer; likewise, every key in the source `dictionary` must also be unique according to the default comparer. + + The capacity of the new is set to the number of elements in `dictionary`, so no resizing takes place while the list is being populated. + + This constructor uses the default comparer for `TKey`. To specify a comparer, use the constructor. The default comparer checks whether the key type `TKey` implements and uses that implementation, if available. If not, checks whether the key type `TKey` implements . If the key type `TKey` does not implement either interface, you can specify a implementation in a constructor overload that accepts a `comparer` parameter. + + The keys in `dictionary` are copied to the new and sorted once, which makes this constructor an O(`n` log `n`) operation. + + + +## Examples + The following code example shows how to use to create a sorted copy of the information in a , by passing the to the constructor. + :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/SortedListTKey,TValue/.ctor/source1.cs" interactive="try-dotnet" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedList.ctor_IDic/VB/source.vb" id="Snippet1"::: @@ -441,29 +441,29 @@ The initial number of elements that the can contain. Initializes a new instance of the class that is empty, has the specified initial capacity, and uses the default . - must be unique according to the default comparer. - - The capacity of a is the number of elements that the can hold before resizing. As elements are added to a , the capacity is automatically increased as required by reallocating the internal array. - - If the size of the collection can be estimated, specifying the initial capacity eliminates the need to perform a number of resizing operations while adding elements to the . - - The capacity can be decreased by calling or by setting the property explicitly. Decreasing the capacity reallocates memory and copies all the elements in the . - - This constructor uses the default comparer for `TKey`. To specify a comparer, use the constructor. The default comparer checks whether the key type `TKey` implements and uses that implementation, if available. If not, checks whether the key type `TKey` implements . If the key type `TKey` does not implement either interface, you can specify a implementation in a constructor overload that accepts a `comparer` parameter. - - This constructor is an O(`n`) operation, where `n` is `capacity`. - - - -## Examples - The following code example creates a sorted list with an initial capacity of 4 and populates it with 4 entries. - + must be unique according to the default comparer. + + The capacity of a is the number of elements that the can hold before resizing. As elements are added to a , the capacity is automatically increased as required by reallocating the internal array. + + If the size of the collection can be estimated, specifying the initial capacity eliminates the need to perform a number of resizing operations while adding elements to the . + + The capacity can be decreased by calling or by setting the property explicitly. Decreasing the capacity reallocates memory and copies all the elements in the . + + This constructor uses the default comparer for `TKey`. To specify a comparer, use the constructor. The default comparer checks whether the key type `TKey` implements and uses that implementation, if available. If not, checks whether the key type `TKey` implements . If the key type `TKey` does not implement either interface, you can specify a implementation in a constructor overload that accepts a `comparer` parameter. + + This constructor is an O(`n`) operation, where `n` is `capacity`. + + + +## Examples + The following code example creates a sorted list with an initial capacity of 4 and populates it with 4 entries. + :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/SortedListTKey,TValue/.ctor/source3.cs" interactive="try-dotnet" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedList.ctor_Int32/VB/source.vb" id="Snippet1"::: - + ]]> @@ -519,30 +519,30 @@ The whose elements are copied to the new . - The implementation to use when comparing keys. - - -or- - + The implementation to use when comparing keys. + + -or- + to use the default for the type of the key. Initializes a new instance of the class that contains elements copied from the specified , has sufficient capacity to accommodate the number of elements copied, and uses the specified . - must be unique according to the specified comparer; likewise, every key in the source `dictionary` must also be unique according to the specified comparer. - - The capacity of the new is set to the number of elements in `dictionary`, so no resizing takes place while the list is being populated. - - The keys in `dictionary` are copied to the new and sorted once, which makes this constructor an O(`n` log `n`) operation. - - - -## Examples - The following code example shows how to use to create a case-insensitive sorted copy of the information in a case-insensitive , by passing the to the constructor. In this example, the case-insensitive comparers are for the current culture. - + must be unique according to the specified comparer; likewise, every key in the source `dictionary` must also be unique according to the specified comparer. + + The capacity of the new is set to the number of elements in `dictionary`, so no resizing takes place while the list is being populated. + + The keys in `dictionary` are copied to the new and sorted once, which makes this constructor an O(`n` log `n`) operation. + + + +## Examples + The following code example shows how to use to create a case-insensitive sorted copy of the information in a case-insensitive , by passing the to the constructor. In this example, the case-insensitive comparers are for the current culture. + :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/SortedListTKey,TValue/.ctor/source2.cs" interactive="try-dotnet" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedList.ctor_IDicIComp/VB/source.vb" id="Snippet1"::: - + ]]> @@ -601,34 +601,34 @@ The initial number of elements that the can contain. - The implementation to use when comparing keys. - - -or- - + The implementation to use when comparing keys. + + -or- + to use the default for the type of the key. Initializes a new instance of the class that is empty, has the specified initial capacity, and uses the specified . - must be unique according to the specified comparer. - - The capacity of a is the number of elements that the can hold before resizing. As elements are added to a , the capacity is automatically increased as required by reallocating the internal array. - - If the size of the collection can be estimated, specifying the initial capacity eliminates the need to perform a number of resizing operations while adding elements to the . - - The capacity can be decreased by calling or by setting the property explicitly. Decreasing the capacity reallocates memory and copies all the elements in the . - - This constructor is an O(`n`) operation, where `n` is `capacity`. - - - -## Examples - The following code example creates a sorted list with an initial capacity of 5 and a case-insensitive comparer for the current culture. The example adds four elements, some with lower-case keys and some with upper-case keys. The example then attempts to add an element with a key that differs from an existing key only by case, catches the resulting exception, and displays an error message. Finally, the example displays the elements in case-insensitive sort order. + must be unique according to the specified comparer. + + The capacity of a is the number of elements that the can hold before resizing. As elements are added to a , the capacity is automatically increased as required by reallocating the internal array. + + If the size of the collection can be estimated, specifying the initial capacity eliminates the need to perform a number of resizing operations while adding elements to the . + + The capacity can be decreased by calling or by setting the property explicitly. Decreasing the capacity reallocates memory and copies all the elements in the . + + This constructor is an O(`n`) operation, where `n` is `capacity`. + + + +## Examples + The following code example creates a sorted list with an initial capacity of 5 and a case-insensitive comparer for the current culture. The example adds four elements, some with lower-case keys and some with upper-case keys. The example then attempts to add an element with a key that differs from an existing key only by case, catches the resulting exception, and displays an error message. Finally, the example displays the elements in case-insensitive sort order. :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/SortedListTKey,TValue/.ctor/source4.cs" interactive="try-dotnet" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedList.ctor_Int32IComp/VB/source.vb" id="Snippet1"::: - + ]]> @@ -686,24 +686,24 @@ The value of the element to add. The value can be for reference types. Adds an element with the specified key and value into the . - property to add new elements by setting the value of a key that does not exist in the ; for example, `myCollection["myNonexistentKey"] = myValue`. However, if the specified key already exists in the , setting the property overwrites the old value. In contrast, the method does not modify existing elements. - - If already equals , the capacity of the is increased by automatically reallocating the internal array, and the existing elements are copied to the new array before the new element is added. - - This method is an O(`n`) operation for unsorted data, where `n` is . It is an O(log `n`) operation if the new element is added at the end of the list. If insertion causes a resize, the operation is O(`n`). - - - -## Examples - The following code example creates an empty of strings with string keys and uses the method to add some elements. The example demonstrates that the method throws an when attempting to add a duplicate key. - - This code example is part of a larger example provided for the class. - + property to add new elements by setting the value of a key that does not exist in the ; for example, `myCollection["myNonexistentKey"] = myValue`. However, if the specified key already exists in the , setting the property overwrites the old value. In contrast, the method does not modify existing elements. + + If already equals , the capacity of the is increased by automatically reallocating the internal array, and the existing elements are copied to the new array before the new element is added. + + This method is an O(`n`) operation for unsorted data, where `n` is . It is an O(log `n`) operation if the new element is added at the end of the list. If insertion causes a resize, the operation is O(`n`). + + + +## Examples + The following code example creates an empty of strings with string keys and uses the method to add some elements. The example demonstrates that the method throws an when attempting to add a duplicate key. + + This code example is part of a larger example provided for the class. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/Generic.SortedList/cpp/source.cpp" id="Snippet2"::: :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/SortedListTKey,TValue/Overview/source.cs" interactive="try-dotnet-method" id="Snippet2"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedList/VB/source.vb" id="Snippet2"::: @@ -757,17 +757,17 @@ Gets or sets the number of elements that the can contain. The number of elements that the can contain. - is the number of elements that the can store. is the number of elements that are actually in the . - - is always greater than or equal to . If exceeds while adding elements, the capacity is increased by automatically reallocating the internal array before copying the old elements and adding the new elements. - - The capacity can be decreased by calling or by setting the property explicitly. When the value of is set explicitly, the internal array is also reallocated to accommodate the specified capacity. - - Retrieving the value of this property is an O(1) operation; setting the property is an O(`n`) operation, where `n` is the new capacity. - + is the number of elements that the can store. is the number of elements that are actually in the . + + is always greater than or equal to . If exceeds while adding elements, the capacity is increased by automatically reallocating the internal array before copying the old elements and adding the new elements. + + The capacity can be decreased by calling or by setting the property explicitly. When the value of is set explicitly, the internal array is also reallocated to accommodate the specified capacity. + + Retrieving the value of this property is an O(1) operation; setting the property is an O(`n`) operation, where `n` is the new capacity. + ]]> @@ -819,15 +819,15 @@ Removes all elements from the . - is set to zero, and references to other objects from elements of the collection are also released. - - remains unchanged. To reset the capacity of the , call or set the property directly. Trimming an empty sets the capacity of the to the default capacity. - - This method is an O(`n`) operation, where `n` is . - + is set to zero, and references to other objects from elements of the collection are also released. + + remains unchanged. To reset the capacity of the , call or set the property directly. Trimming an empty sets the capacity of the to the default capacity. + + This method is an O(`n`) operation, where `n` is . + ]]> @@ -879,11 +879,11 @@ Gets the for the sorted list. The for the current . - @@ -935,31 +935,31 @@ if the contains an element with the specified key; otherwise, . - . - - - -## Examples - The following code example shows how to use the method to test whether a key exists prior to calling the method. It also shows how to use the method to retrieve values, which is an efficient way to retrieve values when a program frequently tries keys that are not in the sorted list. Finally, it shows the least efficient way to test whether keys exist, by using the property (the indexer in C#). - - This code example is part of a larger example provided for the class. - + . + + + +## Examples + The following code example shows how to use the method to test whether a key exists prior to calling the method. It also shows how to use the method to retrieve values, which is an efficient way to retrieve values when a program frequently tries keys that are not in the sorted list. Finally, it shows the least efficient way to test whether keys exist, by using the property (the indexer in C#). + + This code example is part of a larger example provided for the class. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/Generic.SortedList/cpp/source.cpp" id="Snippet6"::: :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/SortedListTKey,TValue/Overview/source.cs" id="Snippet6"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedList/VB/source.vb" id="Snippet6"::: - :::code language="fsharp" source="~/snippets/fsharp/System.Collections.Generic/SortedListTKey,TValue/Overview/source.fs" id="Snippet6"::: + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedList/VB/source.vb" id="Snippet6"::: + :::code language="fsharp" source="~/snippets/fsharp/System.Collections.Generic/SortedListTKey,TValue/Overview/source.fs" id="Snippet6"::: :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/Generic.SortedList/cpp/source.cpp" id="Snippet5"::: :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/SortedListTKey,TValue/Overview/source.cs" id="Snippet5"::: -:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedList/VB/source.vb" id="Snippet5"::: -:::code language="fsharp" source="~/snippets/fsharp/System.Collections.Generic/SortedListTKey,TValue/Overview/source.fs" id="Snippet5"::: +:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedList/VB/source.vb" id="Snippet5"::: +:::code language="fsharp" source="~/snippets/fsharp/System.Collections.Generic/SortedListTKey,TValue/Overview/source.fs" id="Snippet5"::: :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/Generic.SortedList/cpp/source.cpp" id="Snippet4"::: :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/SortedListTKey,TValue/Overview/source.cs" id="Snippet4"::: -:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedList/VB/source.vb" id="Snippet4"::: +:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedList/VB/source.vb" id="Snippet4"::: :::code language="fsharp" source="~/snippets/fsharp/System.Collections.Generic/SortedListTKey,TValue/Overview/source.fs" id="Snippet4"::: - + ]]> @@ -1011,13 +1011,13 @@ if the contains an element with the specified value; otherwise, . - for the value type `TValue`. checks whether the value type `TValue` implements and uses that implementation, if available. If not, checks whether the value type `TValue` implements . If the value type `TValue` does not implement either interface, this method uses . - - This method performs a linear search; therefore, the average execution time is proportional to . That is, this method is an O(`n`) operation, where `n` is . - + for the value type `TValue`. checks whether the value type `TValue` implements and uses that implementation, if available. If not, checks whether the value type `TValue` implements . If the value type `TValue` does not implement either interface, this method uses . + + This method performs a linear search; therefore, the average execution time is proportional to . That is, this method is an O(`n`) operation, where `n` is . + ]]> @@ -1073,15 +1073,15 @@ Gets the number of key/value pairs contained in the . The number of key/value pairs contained in the . - is the number of elements that the can store. is the number of elements that are actually in the . - - is always greater than or equal to . If exceeds while adding elements, the capacity is increased by automatically reallocating the internal array before copying the old elements and adding the new elements. - - Retrieving the value of this property is an O(1) operation. - + is the number of elements that the can store. is the number of elements that are actually in the . + + is always greater than or equal to . If exceeds while adding elements, the capacity is increased by automatically reallocating the internal array before copying the old elements and adding the new elements. + + Retrieving the value of this property is an O(1) operation. + ]]> @@ -1129,29 +1129,29 @@ Returns an enumerator that iterates through the . An of type for the . - is undefined. Therefore, you must call to advance the enumerator to the first element of the collection before reading the value of . - - returns the same object until is called. sets to the next element. - - If passes the end of the collection, the enumerator is positioned after the last element in the collection and returns `false`. When the enumerator is at this position, subsequent calls to return `false`. If the last call to returned `false`, is undefined. You cannot set to the first element of the collection again; you must create a new enumerator instance instead. - - An enumerator remains valid as long as the collection remains unchanged. If changes are made to the collection, such as adding, modifying, or deleting elements, the enumerator is irrecoverably invalidated and the next call to or throws an . - - The enumerator does not have exclusive access to the collection; therefore, enumerating through a collection is intrinsically not a thread-safe procedure. To guarantee thread safety during enumeration, you can lock the collection during the entire enumeration. To allow the collection to be accessed by multiple threads for reading and writing, you must implement your own synchronization. - - Default implementations of collections in are not synchronized. - - This method is an O(1) operation. - + is undefined. Therefore, you must call to advance the enumerator to the first element of the collection before reading the value of . + + returns the same object until is called. sets to the next element. + + If passes the end of the collection, the enumerator is positioned after the last element in the collection and returns `false`. When the enumerator is at this position, subsequent calls to return `false`. If the last call to returned `false`, is undefined. You cannot set to the first element of the collection again; you must create a new enumerator instance instead. + + An enumerator remains valid as long as the collection remains unchanged. If changes are made to the collection, such as adding, modifying, or deleting elements, the enumerator is irrecoverably invalidated and the next call to or throws an . + + The enumerator does not have exclusive access to the collection; therefore, enumerating through a collection is intrinsically not a thread-safe procedure. To guarantee thread safety during enumeration, you can lock the collection during the entire enumeration. To allow the collection to be accessed by multiple threads for reading and writing, you must implement your own synchronization. + + Default implementations of collections in are not synchronized. + + This method is an O(1) operation. + ]]> @@ -1261,11 +1261,11 @@ Searches for the specified key and returns the zero-based index within the entire . The zero-based index of within the entire , if found; otherwise, -1. - . - + . + ]]> @@ -1316,13 +1316,13 @@ Searches for the specified value and returns the zero-based index of the first occurrence within the entire . The zero-based index of the first occurrence of within the entire , if found; otherwise, -1. - for the value type `TValue`. checks whether the value type `TValue` implements and uses that implementation, if available. If not, checks whether the value type `TValue` implements . If the value type `TValue` does not implement either interface, this method uses . - - This method performs a linear search; therefore, the average execution time is proportional to . That is, this method is an O(`n`) operation, where `n` is . - + for the value type `TValue`. checks whether the value type `TValue` implements and uses that implementation, if available. If not, checks whether the value type `TValue` implements . If the value type `TValue` does not implement either interface, this method uses . + + This method performs a linear search; therefore, the average execution time is proportional to . That is, this method is an O(`n`) operation, where `n` is . + ]]> @@ -1374,43 +1374,43 @@ Gets or sets the value associated with the specified key. The value associated with the specified key. If the specified key is not found, a get operation throws a and a set operation creates a new element using the specified key. - is thrown. If the key is not found when a value is being set, the key and value are added. - - You can also use the property to add new elements by setting the value of a key that does not exist in the ; for example, `myCollection["myNonexistentKey"] = myValue`. However, if the specified key already exists in the , setting the property overwrites the old value. In contrast, the method does not modify existing elements. - - The C# language uses the [`this`](/dotnet/csharp/language-reference/keywords/this) keyword to define the indexers instead of implementing the property. Visual Basic implements as a default property, which provides the same indexing functionality. - - Retrieving the value of this property is an O(log `n`) operation, where n is . Setting the property is an O(log `n`) operation if the key is already in the . If the key is not in the list, setting the property is an O(`n`) operation for unsorted data, or O(log `n`) if the new element is added at the end of the list. If insertion causes a resize, the operation is O(`n`). - - - -## Examples - The following code example uses the property (the indexer in C#) to retrieve values, demonstrating that a is thrown when a requested key is not present, and showing that the value associated with a key can be replaced. - - The example also shows how to use the method as a more efficient way to retrieve values if a program often must try key values that are not in the sorted list. - - This code example is part of a larger example provided for the class. - + is thrown. If the key is not found when a value is being set, the key and value are added. + + You can also use the property to add new elements by setting the value of a key that does not exist in the ; for example, `myCollection["myNonexistentKey"] = myValue`. However, if the specified key already exists in the , setting the property overwrites the old value. In contrast, the method does not modify existing elements. + + The C# language uses the [`this`](/dotnet/csharp/language-reference/keywords/this) keyword to define the indexers instead of implementing the property. Visual Basic implements as a default property, which provides the same indexing functionality. + + Retrieving the value of this property is an O(log `n`) operation, where n is . Setting the property is an O(log `n`) operation if the key is already in the . If the key is not in the list, setting the property is an O(`n`) operation for unsorted data, or O(log `n`) if the new element is added at the end of the list. If insertion causes a resize, the operation is O(`n`). + + + +## Examples + The following code example uses the property (the indexer in C#) to retrieve values, demonstrating that a is thrown when a requested key is not present, and showing that the value associated with a key can be replaced. + + The example also shows how to use the method as a more efficient way to retrieve values if a program often must try key values that are not in the sorted list. + + This code example is part of a larger example provided for the class. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/Generic.SortedList/cpp/source.cpp" id="Snippet3"::: :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/SortedListTKey,TValue/Overview/source.cs" id="Snippet3"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedList/VB/source.vb" id="Snippet3"::: - :::code language="fsharp" source="~/snippets/fsharp/System.Collections.Generic/SortedListTKey,TValue/Overview/source.fs" id="Snippet3"::: + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedList/VB/source.vb" id="Snippet3"::: + :::code language="fsharp" source="~/snippets/fsharp/System.Collections.Generic/SortedListTKey,TValue/Overview/source.fs" id="Snippet3"::: :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/Generic.SortedList/cpp/source.cpp" id="Snippet4"::: :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/SortedListTKey,TValue/Overview/source.cs" id="Snippet4"::: -:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedList/VB/source.vb" id="Snippet4"::: -:::code language="fsharp" source="~/snippets/fsharp/System.Collections.Generic/SortedListTKey,TValue/Overview/source.fs" id="Snippet4"::: +:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedList/VB/source.vb" id="Snippet4"::: +:::code language="fsharp" source="~/snippets/fsharp/System.Collections.Generic/SortedListTKey,TValue/Overview/source.fs" id="Snippet4"::: :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/Generic.SortedList/cpp/source.cpp" id="Snippet5"::: :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/SortedListTKey,TValue/Overview/source.cs" id="Snippet5"::: -:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedList/VB/source.vb" id="Snippet5"::: +:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedList/VB/source.vb" id="Snippet5"::: :::code language="fsharp" source="~/snippets/fsharp/System.Collections.Generic/SortedListTKey,TValue/Overview/source.fs" id="Snippet5"::: - + ]]> @@ -1463,40 +1463,40 @@ Gets a collection containing the keys in the , in sorted order. A containing the keys in the . - is the same as the order in the . - - The returned is not a static copy; instead, the refers back to the keys in the original . Therefore, changes to the continue to be reflected in the . - - The collection returned by the property provides an efficient way to retrieve keys by index. It is not necessary to regenerate the list when the property is accessed, because the list is just a wrapper for the internal array of keys. The following code shows the use of the property for indexed retrieval of keys from a sorted list of elements with string keys: - + is the same as the order in the . + + The returned is not a static copy; instead, the refers back to the keys in the original . Therefore, changes to the continue to be reflected in the . + + The collection returned by the property provides an efficient way to retrieve keys by index. It is not necessary to regenerate the list when the property is accessed, because the list is just a wrapper for the internal array of keys. The following code shows the use of the property for indexed retrieval of keys from a sorted list of elements with string keys: + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/Generic.SortedList/cpp/remarks.cpp" id="Snippet11"::: :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/SortedListTKey,TValue/Overview/remarks.cs" id="Snippet11"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedList/VB/remarks.vb" id="Snippet11"::: + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedList/VB/remarks.vb" id="Snippet11"::: :::code language="fsharp" source="~/snippets/fsharp/System.Collections.Generic/SortedListTKey,TValue/Overview/remarks.fs" id="Snippet11"::: - - Retrieving the value of this property is an O(1) operation. - - - -## Examples - The following code example shows how to enumerate the keys in the sorted list using the property, and how to enumerate the keys and values in the sorted list. - - The example also shows how to use the property for efficient indexed retrieval of keys. - - This code is part of a larger example that can be compiled and executed. See . - + + Retrieving the value of this property is an O(1) operation. + + + +## Examples + The following code example shows how to enumerate the keys in the sorted list using the property, and how to enumerate the keys and values in the sorted list. + + The example also shows how to use the property for efficient indexed retrieval of keys. + + This code is part of a larger example that can be compiled and executed. See . + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/Generic.SortedList/cpp/source.cpp" id="Snippet9"::: :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/SortedListTKey,TValue/Overview/source.cs" id="Snippet9"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedList/VB/source.vb" id="Snippet9"::: - :::code language="fsharp" source="~/snippets/fsharp/System.Collections.Generic/SortedListTKey,TValue/Overview/source.fs" id="Snippet9"::: + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedList/VB/source.vb" id="Snippet9"::: + :::code language="fsharp" source="~/snippets/fsharp/System.Collections.Generic/SortedListTKey,TValue/Overview/source.fs" id="Snippet9"::: :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/Generic.SortedList/cpp/source.cpp" id="Snippet7"::: :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/SortedListTKey,TValue/Overview/source.cs" id="Snippet7"::: -:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedList/VB/source.vb" id="Snippet7"::: +:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedList/VB/source.vb" id="Snippet7"::: :::code language="fsharp" source="~/snippets/fsharp/System.Collections.Generic/SortedListTKey,TValue/Overview/source.fs" id="Snippet7"::: - + ]]> @@ -1549,23 +1549,23 @@ if the element is successfully removed; otherwise, . This method also returns if was not found in the original . - . - - - -## Examples - The following code example shows how to remove a key/value pair from the sorted list using the method. - - This code example is part of a larger example provided for the class. - + . + + + +## Examples + The following code example shows how to remove a key/value pair from the sorted list using the method. + + This code example is part of a larger example provided for the class. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/Generic.SortedList/cpp/source.cpp" id="Snippet10"::: :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/SortedListTKey,TValue/Overview/source.cs" id="Snippet10"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedList/VB/source.vb" id="Snippet10"::: + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedList/VB/source.vb" id="Snippet10"::: :::code language="fsharp" source="~/snippets/fsharp/System.Collections.Generic/SortedListTKey,TValue/Overview/source.fs" id="Snippet10"::: - + ]]> @@ -1616,18 +1616,18 @@ The zero-based index of the element to remove. Removes the element at the specified index of the . - . - + . + ]]> - is less than zero. - - -or- - + is less than zero. + + -or- + is equal to or greater than . @@ -2184,15 +2184,15 @@ The zero-based index in at which copying begins. Copies the elements of the to an , starting at a particular index. - [!NOTE] -> If the type of the source cannot be cast automatically to the type of the destination `array`, the non-generic implementations of throw , whereas the generic implementations throw . - - This method is an O(`n`) operation, where `n` is . - +> If the type of the source cannot be cast automatically to the type of the destination `array`, the non-generic implementations of throw , whereas the generic implementations throw . + + This method is an O(`n`) operation, where `n` is . + ]]> @@ -2200,18 +2200,18 @@ is less than zero. - is multidimensional. - - -or- - - does not have zero-based indexing. - - -or- - - The number of elements in the source is greater than the available space from to the end of the destination . - - -or- - + is multidimensional. + + -or- + + does not have zero-based indexing. + + -or- + + The number of elements in the source is greater than the available space from to the end of the destination . + + -or- + The type of the source cannot be cast automatically to the type of the destination . @@ -2258,17 +2258,17 @@ if access to the is synchronized (thread safe); otherwise, . In the default implementation of , this property always returns . - are not synchronized. - - Enumerating through a collection is intrinsically not a thread-safe procedure. To guarantee thread safety during enumeration, you can lock the collection during the entire enumeration. To allow the collection to be accessed by multiple threads for reading and writing, you must implement your own synchronization. - - The property returns an object that can be used to synchronize access to the . Synchronization is effective only if all threads lock this object before accessing the collection. - - Retrieving the value of this property is an O(1) operation. - + are not synchronized. + + Enumerating through a collection is intrinsically not a thread-safe procedure. To guarantee thread safety during enumeration, you can lock the collection during the entire enumeration. To allow the collection to be accessed by multiple threads for reading and writing, you must implement your own synchronization. + + The property returns an object that can be used to synchronize access to the . Synchronization is effective only if all threads lock this object before accessing the collection. + + Retrieving the value of this property is an O(1) operation. + ]]> @@ -2315,42 +2315,42 @@ Gets an object that can be used to synchronize access to the . An object that can be used to synchronize access to the . In the default implementation of , this property always returns the current instance. - are not synchronized. - - Enumerating through a collection is intrinsically not a thread-safe procedure. To guarantee thread safety during enumeration, you can lock the collection during the entire enumeration. To allow the collection to be accessed by multiple threads for reading and writing, you must implement your own synchronization. - - The property returns an object that can be used to synchronize access to the . Synchronization is effective only if all threads lock this object before accessing the collection. The following code shows the use of the property for C#, C++, and Visual Basic. - -```csharp -ICollection ic = ...; -lock (ic.SyncRoot) { - // Access the collection. -} -``` - -```vb -Dim ic As ICollection = ... -SyncLock ic.SyncRoot - ' Access the collection. -End SyncLock -``` - -```cpp -ICollection^ ic = ...; -try { - Monitor::Enter(ic->SyncRoot); - // Access the collection. -} -finally { - Monitor::Exit(ic->SyncRoot); -} -``` - - Retrieving the value of this property is an O(1) operation. - + are not synchronized. + + Enumerating through a collection is intrinsically not a thread-safe procedure. To guarantee thread safety during enumeration, you can lock the collection during the entire enumeration. To allow the collection to be accessed by multiple threads for reading and writing, you must implement your own synchronization. + + The property returns an object that can be used to synchronize access to the . Synchronization is effective only if all threads lock this object before accessing the collection. The following code shows the use of the property for C#, C++, and Visual Basic. + +```csharp +ICollection ic = ...; +lock (ic.SyncRoot) { + // Access the collection. +} +``` + +```vb +Dim ic As ICollection = ... +SyncLock ic.SyncRoot + ' Access the collection. +End SyncLock +``` + +```cpp +ICollection^ ic = ...; +try { + Monitor::Enter(ic->SyncRoot); + // Access the collection. +} +finally { + Monitor::Exit(ic->SyncRoot); +} +``` + + Retrieving the value of this property is an O(1) operation. + ]]> @@ -2402,36 +2402,36 @@ finally { The to use as the value of the element to add. Adds an element with the provided key and value to the . - property to add new elements by setting the value of a key that does not exist in the dictionary; for example, `myCollection["myNonexistentKey"] = myValue`. However, if the specified key already exists in the dictionary, setting the property overwrites the old value. In contrast, the method does not modify existing elements. - - This method is an O(`n`) operation for unsorted data, where `n` is . It is an O(log `n`) operation if the new element is added at the end of the list. If insertion causes a resize, the operation is O(`n`). - - - -## Examples - The following code example shows how to access the class through the interface. The code example creates an empty of strings with string keys and uses the method to add some elements. The example demonstrates that the method throws an when attempting to add a duplicate key, or when a key or value of the wrong data type is supplied. - - The code example demonstrates the use of several other members of the interface. - + property to add new elements by setting the value of a key that does not exist in the dictionary; for example, `myCollection["myNonexistentKey"] = myValue`. However, if the specified key already exists in the dictionary, setting the property overwrites the old value. In contrast, the method does not modify existing elements. + + This method is an O(`n`) operation for unsorted data, where `n` is . It is an O(log `n`) operation if the new element is added at the end of the list. If insertion causes a resize, the operation is O(`n`). + + + +## Examples + The following code example shows how to access the class through the interface. The code example creates an empty of strings with string keys and uses the method to add some elements. The example demonstrates that the method throws an when attempting to add a duplicate key, or when a key or value of the wrong data type is supplied. + + The code example demonstrates the use of several other members of the interface. + :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/SortedListTKey,TValue/System.Collections.IDictionary.Add/source.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedList.IDictionary/VB/source.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedList.IDictionary/VB/source.vb" id="Snippet1"::: + ]]> is . - is of a type that is not assignable to the key type of the . - - -or- - - is of a type that is not assignable to the value type of the . - - -or- - + is of a type that is not assignable to the key type of the . + + -or- + + is of a type that is not assignable to the value type of the . + + -or- + An element with the same key already exists in the . @@ -2482,27 +2482,27 @@ finally { if the contains an element with the key; otherwise, . - . - - This method is an O(log `n`) operation, where `n` is . - - - -## Examples - The following code example shows how to use the method of the interface with a . The example demonstrates that the method returns `false` if a key of the wrong data type is supplied. - - The code example is part of a larger example, including output, provided for the method. - + . + + This method is an O(log `n`) operation, where `n` is . + + + +## Examples + The following code example shows how to use the method of the interface with a . The example demonstrates that the method returns `false` if a key of the wrong data type is supplied. + + The code example is part of a larger example, including output, provided for the method. + :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/SortedListTKey,TValue/System.Collections.IDictionary.Add/source.cs" id="Snippet31"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedList.IDictionary/VB/source.vb" id="Snippet31"::: + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedList.IDictionary/VB/source.vb" id="Snippet31"::: :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/SortedListTKey,TValue/System.Collections.IDictionary.Add/source.cs" id="Snippet6"::: -:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedList.IDictionary/VB/source.vb" id="Snippet6"::: +:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedList.IDictionary/VB/source.vb" id="Snippet6"::: :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/SortedListTKey,TValue/System.Collections.IDictionary.Add/source.cs" id="Snippet32"::: -:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedList.IDictionary/VB/source.vb" id="Snippet32"::: - +:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedList.IDictionary/VB/source.vb" id="Snippet32"::: + ]]> @@ -2553,41 +2553,41 @@ finally { Returns an for the . An for the . - also brings the enumerator back to this position. At this position, is undefined. Therefore, you must call to advance the enumerator to the first element of the collection before reading the value of . - - returns the same object until either or is called. sets to the next element. - - If passes the end of the collection, the enumerator is positioned after the last element in the collection and returns `false`. When the enumerator is at this position, subsequent calls to also return `false`. If the last call to returned `false`, is undefined. To set to the first element of the collection again, you can call followed by . - - An enumerator remains valid as long as the collection remains unchanged. If changes are made to the collection, such as adding, modifying, or deleting elements, the enumerator is irrecoverably invalidated and the next call to or throws an . - - The enumerator does not have exclusive access to the collection; therefore, enumerating through a collection is intrinsically not a thread-safe procedure. To guarantee thread safety during enumeration, you can lock the collection during the entire enumeration. To allow the collection to be accessed by multiple threads for reading and writing, you must implement your own synchronization. - - Default implementations of collections in are not synchronized. - - This method is an O(1) operation. - - - -## Examples - The following code example shows how to enumerate the key/value pairs in the sorted list by using the `foreach` statement (`For Each` in Visual Basic, `for each` in C++), which hides the use of the enumerator. In particular, note that the enumerator for the interface returns objects rather than objects. - - The code example is part of a larger example, including output, provided for the method. - + also brings the enumerator back to this position. At this position, is undefined. Therefore, you must call to advance the enumerator to the first element of the collection before reading the value of . + + returns the same object until either or is called. sets to the next element. + + If passes the end of the collection, the enumerator is positioned after the last element in the collection and returns `false`. When the enumerator is at this position, subsequent calls to also return `false`. If the last call to returned `false`, is undefined. To set to the first element of the collection again, you can call followed by . + + An enumerator remains valid as long as the collection remains unchanged. If changes are made to the collection, such as adding, modifying, or deleting elements, the enumerator is irrecoverably invalidated and the next call to or throws an . + + The enumerator does not have exclusive access to the collection; therefore, enumerating through a collection is intrinsically not a thread-safe procedure. To guarantee thread safety during enumeration, you can lock the collection during the entire enumeration. To allow the collection to be accessed by multiple threads for reading and writing, you must implement your own synchronization. + + Default implementations of collections in are not synchronized. + + This method is an O(1) operation. + + + +## Examples + The following code example shows how to enumerate the key/value pairs in the sorted list by using the `foreach` statement (`For Each` in Visual Basic, `for each` in C++), which hides the use of the enumerator. In particular, note that the enumerator for the interface returns objects rather than objects. + + The code example is part of a larger example, including output, provided for the method. + :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/SortedListTKey,TValue/System.Collections.IDictionary.Add/source.cs" id="Snippet31"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedList.IDictionary/VB/source.vb" id="Snippet31"::: + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedList.IDictionary/VB/source.vb" id="Snippet31"::: :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/SortedListTKey,TValue/System.Collections.IDictionary.Add/source.cs" id="Snippet7"::: -:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedList.IDictionary/VB/source.vb" id="Snippet7"::: +:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedList.IDictionary/VB/source.vb" id="Snippet7"::: :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/SortedListTKey,TValue/System.Collections.IDictionary.Add/source.cs" id="Snippet32"::: -:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedList.IDictionary/VB/source.vb" id="Snippet32"::: - +:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedList.IDictionary/VB/source.vb" id="Snippet32"::: + ]]> @@ -2636,15 +2636,15 @@ finally { if the has a fixed size; otherwise, . In the default implementation of , this property always returns . - @@ -2693,15 +2693,15 @@ finally { if the is read-only; otherwise, . In the default implementation of , this property always returns . - @@ -2760,46 +2760,46 @@ finally { Gets or sets the element with the specified key. The element with the specified key, or if is not in the dictionary or is of a type that is not assignable to the key type of the . - . - - This property provides the ability to access a specific element in the collection by using the following syntax: `myCollection[key]`. - - You can also use the property to add new elements by setting the value of a key that does not exist in the dictionary; for example, `myCollection["myNonexistentKey"] = myValue`. However, if the specified key already exists in the dictionary, setting the property overwrites the old value. In contrast, the method does not modify existing elements. - - The C# language uses the [this](/dotnet/csharp/language-reference/keywords/this) keyword to define the indexers instead of implementing the property. Visual Basic implements as a default property, which provides the same indexing functionality. - - Retrieving the value of this property is an O(log `n`) operation, where n is . Setting the property is an O(log `n`) operation if the key is already in the . If the key is not in the list, setting the property is an O(`n`) operation for unsorted data, or O(log `n`) if the new element is added at the end of the list. If insertion causes a resize, the operation is O(`n`). - - - -## Examples - The following code example shows how to use the property (the indexer in C#) of the interface with a , and ways the property differs from the property. - - The example shows that, like the property, the property can change the value associated with an existing key and can be used to add a new key/value pair if the specified key is not in the sorted list. The example also shows that unlike the property, the property does not throw an exception if `key` is not in the sorted list, returning a null reference instead. Finally, the example demonstrates that getting the property returns a null reference if `key` is not the correct data type, and that setting the property throws an exception if `key` is not the correct data type. - - The code example is part of a larger example, including output, provided for the method. - + . + + This property provides the ability to access a specific element in the collection by using the following syntax: `myCollection[key]`. + + You can also use the property to add new elements by setting the value of a key that does not exist in the dictionary; for example, `myCollection["myNonexistentKey"] = myValue`. However, if the specified key already exists in the dictionary, setting the property overwrites the old value. In contrast, the method does not modify existing elements. + + The C# language uses the [this](/dotnet/csharp/language-reference/keywords/this) keyword to define the indexers instead of implementing the property. Visual Basic implements as a default property, which provides the same indexing functionality. + + Retrieving the value of this property is an O(log `n`) operation, where n is . Setting the property is an O(log `n`) operation if the key is already in the . If the key is not in the list, setting the property is an O(`n`) operation for unsorted data, or O(log `n`) if the new element is added at the end of the list. If insertion causes a resize, the operation is O(`n`). + + + +## Examples + The following code example shows how to use the property (the indexer in C#) of the interface with a , and ways the property differs from the property. + + The example shows that, like the property, the property can change the value associated with an existing key and can be used to add a new key/value pair if the specified key is not in the sorted list. The example also shows that unlike the property, the property does not throw an exception if `key` is not in the sorted list, returning a null reference instead. Finally, the example demonstrates that getting the property returns a null reference if `key` is not the correct data type, and that setting the property throws an exception if `key` is not the correct data type. + + The code example is part of a larger example, including output, provided for the method. + :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/SortedListTKey,TValue/System.Collections.IDictionary.Add/source.cs" id="Snippet31"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedList.IDictionary/VB/source.vb" id="Snippet31"::: + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedList.IDictionary/VB/source.vb" id="Snippet31"::: :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/SortedListTKey,TValue/System.Collections.IDictionary.Add/source.cs" id="Snippet3"::: -:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedList.IDictionary/VB/source.vb" id="Snippet3"::: +:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedList.IDictionary/VB/source.vb" id="Snippet3"::: :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/SortedListTKey,TValue/System.Collections.IDictionary.Add/source.cs" id="Snippet4"::: -:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedList.IDictionary/VB/source.vb" id="Snippet4"::: +:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedList.IDictionary/VB/source.vb" id="Snippet4"::: :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/SortedListTKey,TValue/System.Collections.IDictionary.Add/source.cs" id="Snippet32"::: -:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedList.IDictionary/VB/source.vb" id="Snippet32"::: - +:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedList.IDictionary/VB/source.vb" id="Snippet32"::: + ]]> is . - A value is being assigned, and is of a type that is not assignable to the key type of the . - - -or- - - A value is being assigned, and is of a type that is not assignable to the value type of the . + A value is being assigned, and is of a type that is not assignable to the key type of the . + + -or- + + A value is being assigned and is of a type that isn't assignable to the value type of the . @@ -2851,29 +2851,29 @@ finally { Gets an containing the keys of the . An containing the keys of the . - is the same as the order in the . - - Retrieving the value of this property is an O(1) operation. - - - -## Examples - The following code example shows how to use the property of the interface with a , to list the keys in the dictionary. The example also shows how to enumerate the key/value pairs in the sorted list; note that the enumerator for the interface returns objects rather than objects. - - The code example is part of a larger example, including output, provided for the method. - + is the same as the order in the . + + Retrieving the value of this property is an O(1) operation. + + + +## Examples + The following code example shows how to use the property of the interface with a , to list the keys in the dictionary. The example also shows how to enumerate the key/value pairs in the sorted list; note that the enumerator for the interface returns objects rather than objects. + + The code example is part of a larger example, including output, provided for the method. + :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/SortedListTKey,TValue/System.Collections.IDictionary.Add/source.cs" id="Snippet31"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedList.IDictionary/VB/source.vb" id="Snippet31"::: + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedList.IDictionary/VB/source.vb" id="Snippet31"::: :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/SortedListTKey,TValue/System.Collections.IDictionary.Add/source.cs" id="Snippet9"::: -:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedList.IDictionary/VB/source.vb" id="Snippet9"::: +:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedList.IDictionary/VB/source.vb" id="Snippet9"::: :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/SortedListTKey,TValue/System.Collections.IDictionary.Add/source.cs" id="Snippet7"::: -:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedList.IDictionary/VB/source.vb" id="Snippet7"::: +:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedList.IDictionary/VB/source.vb" id="Snippet7"::: :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/SortedListTKey,TValue/System.Collections.IDictionary.Add/source.cs" id="Snippet32"::: -:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedList.IDictionary/VB/source.vb" id="Snippet32"::: - +:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedList.IDictionary/VB/source.vb" id="Snippet32"::: + ]]> @@ -2925,25 +2925,25 @@ finally { The key of the element to remove. Removes the element with the specified key from the . - . - - - -## Examples - The following code example shows how to use the of the interface with a . - - The code example is part of a larger example, including output, provided for the method. - + . + + + +## Examples + The following code example shows how to use the of the interface with a . + + The code example is part of a larger example, including output, provided for the method. + :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/SortedListTKey,TValue/System.Collections.IDictionary.Add/source.cs" id="Snippet31"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedList.IDictionary/VB/source.vb" id="Snippet31"::: + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedList.IDictionary/VB/source.vb" id="Snippet31"::: :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/SortedListTKey,TValue/System.Collections.IDictionary.Add/source.cs" id="Snippet10"::: -:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedList.IDictionary/VB/source.vb" id="Snippet10"::: +:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedList.IDictionary/VB/source.vb" id="Snippet10"::: :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/SortedListTKey,TValue/System.Collections.IDictionary.Add/source.cs" id="Snippet32"::: -:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedList.IDictionary/VB/source.vb" id="Snippet32"::: - +:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedList.IDictionary/VB/source.vb" id="Snippet32"::: + ]]> @@ -2999,29 +2999,29 @@ finally { Gets an containing the values in the . An containing the values in the . - is the same as the order in the . - - Retrieving the value of this property is an O(1) operation. - - - -## Examples - The following code example shows how to use the property of the interface with a , to list the values in the sorted list. The example also shows how to enumerate the key/value pairs in the sorted list; note that the enumerator for the interface returns objects rather than objects. - - The code example is part of a larger example, including output, provided for the method. - + is the same as the order in the . + + Retrieving the value of this property is an O(1) operation. + + + +## Examples + The following code example shows how to use the property of the interface with a , to list the values in the sorted list. The example also shows how to enumerate the key/value pairs in the sorted list; note that the enumerator for the interface returns objects rather than objects. + + The code example is part of a larger example, including output, provided for the method. + :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/SortedListTKey,TValue/System.Collections.IDictionary.Add/source.cs" id="Snippet31"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedList.IDictionary/VB/source.vb" id="Snippet31"::: + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedList.IDictionary/VB/source.vb" id="Snippet31"::: :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/SortedListTKey,TValue/System.Collections.IDictionary.Add/source.cs" id="Snippet8"::: -:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedList.IDictionary/VB/source.vb" id="Snippet8"::: +:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedList.IDictionary/VB/source.vb" id="Snippet8"::: :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/SortedListTKey,TValue/System.Collections.IDictionary.Add/source.cs" id="Snippet7"::: -:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedList.IDictionary/VB/source.vb" id="Snippet7"::: +:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedList.IDictionary/VB/source.vb" id="Snippet7"::: :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/SortedListTKey,TValue/System.Collections.IDictionary.Add/source.cs" id="Snippet32"::: -:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedList.IDictionary/VB/source.vb" id="Snippet32"::: - +:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedList.IDictionary/VB/source.vb" id="Snippet32"::: + ]]> @@ -3071,27 +3071,27 @@ finally { Returns an enumerator that iterates through a collection. An that can be used to iterate through the collection. - also brings the enumerator back to this position. At this position, is undefined. Therefore, you must call to advance the enumerator to the first element of the collection before reading the value of . - - returns the same object until either or is called. sets to the next element. - - If passes the end of the collection, the enumerator is positioned after the last element in the collection and returns `false`. When the enumerator is at this position, subsequent calls to also return `false`. If the last call to returned `false`, is undefined. To set to the first element of the collection again, you can call followed by . - - An enumerator remains valid as long as the collection remains unchanged. If changes are made to the collection, such as adding, modifying, or deleting elements, the enumerator is irrecoverably invalidated and the next call to or throws an . - - The enumerator does not have exclusive access to the collection; therefore, enumerating through a collection is intrinsically not a thread-safe procedure. To guarantee thread safety during enumeration, you can lock the collection during the entire enumeration. To allow the collection to be accessed by multiple threads for reading and writing, you must implement your own synchronization. - - Default implementations of collections in are not synchronized. - - This method is an O(1) operation. - + also brings the enumerator back to this position. At this position, is undefined. Therefore, you must call to advance the enumerator to the first element of the collection before reading the value of . + + returns the same object until either or is called. sets to the next element. + + If passes the end of the collection, the enumerator is positioned after the last element in the collection and returns `false`. When the enumerator is at this position, subsequent calls to also return `false`. If the last call to returned `false`, is undefined. To set to the first element of the collection again, you can call followed by . + + An enumerator remains valid as long as the collection remains unchanged. If changes are made to the collection, such as adding, modifying, or deleting elements, the enumerator is irrecoverably invalidated and the next call to or throws an . + + The enumerator does not have exclusive access to the collection; therefore, enumerating through a collection is intrinsically not a thread-safe procedure. To guarantee thread safety during enumeration, you can lock the collection during the entire enumeration. To allow the collection to be accessed by multiple threads for reading and writing, you must implement your own synchronization. + + Default implementations of collections in are not synchronized. + + This method is an O(1) operation. + ]]> @@ -3136,17 +3136,17 @@ finally { Sets the capacity to the actual number of elements in the , if that number is less than 90 percent of current capacity. - can be considerable, however, so the method does nothing if the list is at more than 90 percent of capacity. This avoids incurring a large reallocation cost for a relatively small gain. - - This method is an O(`n`) operation, where `n` is . - - To reset a to its initial state, call the method before calling method. Trimming an empty sets the capacity of the to the default capacity. - - The capacity can also be set using the property. - + can be considerable, however, so the method does nothing if the list is at more than 90 percent of capacity. This avoids incurring a large reallocation cost for a relatively small gain. + + This method is an O(`n`) operation, where `n` is . + + To reset a to its initial state, call the method before calling method. Trimming an empty sets the capacity of the to the default capacity. + + The capacity can also be set using the property. + ]]> @@ -3210,31 +3210,31 @@ finally { if the contains an element with the specified key; otherwise, . - method and the property. - - If the key is not found, then the `value` parameter gets the appropriate default value for the value type `TValue`; for example, zero (0) for integer types, `false` for Boolean types, and `null` for reference types. - - This method performs a binary search; therefore, this method is an O(log `n`) operation, where `n` is . - - - -## Examples - The example shows how to use the method as a more efficient way to retrieve values in a program that frequently tries keys that are not in the sorted list. For contrast, the example also shows how the property (the indexer in C#) throws exceptions when attempting to retrieve nonexistent keys. - - This code example is part of a larger example provided for the class. - + method and the property. + + If the key is not found, then the `value` parameter gets the appropriate default value for the value type `TValue`; for example, zero (0) for integer types, `false` for Boolean types, and `null` for reference types. + + This method performs a binary search; therefore, this method is an O(log `n`) operation, where `n` is . + + + +## Examples + The example shows how to use the method as a more efficient way to retrieve values in a program that frequently tries keys that are not in the sorted list. For contrast, the example also shows how the property (the indexer in C#) throws exceptions when attempting to retrieve nonexistent keys. + + This code example is part of a larger example provided for the class. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/Generic.SortedList/cpp/source.cpp" id="Snippet5"::: :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/SortedListTKey,TValue/Overview/source.cs" id="Snippet5"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedList/VB/source.vb" id="Snippet5"::: - :::code language="fsharp" source="~/snippets/fsharp/System.Collections.Generic/SortedListTKey,TValue/Overview/source.fs" id="Snippet5"::: + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedList/VB/source.vb" id="Snippet5"::: + :::code language="fsharp" source="~/snippets/fsharp/System.Collections.Generic/SortedListTKey,TValue/Overview/source.fs" id="Snippet5"::: :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/Generic.SortedList/cpp/source.cpp" id="Snippet4"::: :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/SortedListTKey,TValue/Overview/source.cs" id="Snippet4"::: -:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedList/VB/source.vb" id="Snippet4"::: -:::code language="fsharp" source="~/snippets/fsharp/System.Collections.Generic/SortedListTKey,TValue/Overview/source.fs" id="Snippet4"::: - +:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedList/VB/source.vb" id="Snippet4"::: +:::code language="fsharp" source="~/snippets/fsharp/System.Collections.Generic/SortedListTKey,TValue/Overview/source.fs" id="Snippet4"::: + ]]> @@ -3289,40 +3289,40 @@ finally { Gets a collection containing the values in the . A containing the values in the . - is the same as the order in the . - - The returned is not a static copy; instead, the refers back to the values in the original . Therefore, changes to the continue to be reflected in the . - - The collection returned by the property provides an efficient way to retrieve values by index. It is not necessary to regenerate the list when the property is accessed, because the list is just a wrapper for the internal array of values. The following code shows the use of the property for indexed retrieval of values from a sorted list of strings: - + is the same as the order in the . + + The returned is not a static copy; instead, the refers back to the values in the original . Therefore, changes to the continue to be reflected in the . + + The collection returned by the property provides an efficient way to retrieve values by index. It is not necessary to regenerate the list when the property is accessed, because the list is just a wrapper for the internal array of values. The following code shows the use of the property for indexed retrieval of values from a sorted list of strings: + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/Generic.SortedList/cpp/remarks.cpp" id="Snippet11"::: :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/SortedListTKey,TValue/Overview/remarks.cs" id="Snippet11"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedList/VB/remarks.vb" id="Snippet11"::: + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedList/VB/remarks.vb" id="Snippet11"::: :::code language="fsharp" source="~/snippets/fsharp/System.Collections.Generic/SortedListTKey,TValue/Overview/remarks.fs" id="Snippet11"::: - - Retrieving the value of this property is an O(1) operation. - - - -## Examples - This code example shows how to enumerate the values in the sorted list using the property, and how to enumerate the keys and values in the sorted list. - - The example also shows how to use the property for efficient indexed retrieval of values. - - This code example is part of a larger example provided for the class. - + + Retrieving the value of this property is an O(1) operation. + + + +## Examples + This code example shows how to enumerate the values in the sorted list using the property, and how to enumerate the keys and values in the sorted list. + + The example also shows how to use the property for efficient indexed retrieval of values. + + This code example is part of a larger example provided for the class. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/Generic.SortedList/cpp/source.cpp" id="Snippet8"::: :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/SortedListTKey,TValue/Overview/source.cs" id="Snippet8"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedList/VB/source.vb" id="Snippet8"::: - :::code language="fsharp" source="~/snippets/fsharp/System.Collections.Generic/SortedListTKey,TValue/Overview/source.fs" id="Snippet8"::: + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedList/VB/source.vb" id="Snippet8"::: + :::code language="fsharp" source="~/snippets/fsharp/System.Collections.Generic/SortedListTKey,TValue/Overview/source.fs" id="Snippet8"::: :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/Generic.SortedList/cpp/source.cpp" id="Snippet7"::: :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/SortedListTKey,TValue/Overview/source.cs" id="Snippet7"::: -:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedList/VB/source.vb" id="Snippet7"::: -:::code language="fsharp" source="~/snippets/fsharp/System.Collections.Generic/SortedListTKey,TValue/Overview/source.fs" id="Snippet7"::: - +:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedList/VB/source.vb" id="Snippet7"::: +:::code language="fsharp" source="~/snippets/fsharp/System.Collections.Generic/SortedListTKey,TValue/Overview/source.fs" id="Snippet7"::: + ]]> diff --git a/xml/System.Collections.Generic/SynchronizedKeyedCollection`2.xml b/xml/System.Collections.Generic/SynchronizedKeyedCollection`2.xml index 1bc29c00cf9..642235d3292 100644 --- a/xml/System.Collections.Generic/SynchronizedKeyedCollection`2.xml +++ b/xml/System.Collections.Generic/SynchronizedKeyedCollection`2.xml @@ -43,11 +43,11 @@ The type of items contained in the thread-safe, keyed collection. Provides a thread-safe collection that contains objects of a type specified by a generic parameter and that are grouped by keys. - for use hosting. - + for use hosting. + ]]> @@ -116,11 +116,11 @@ The object used to synchronize access to the thread-safe collection. Initializes a new instance of the class with access synchronized by an explicitly specified object. - are created using the same `syncRoot`, then access is protected across all instances. - + are created using the same `syncRoot`, then access is protected across all instances. + ]]> @@ -157,11 +157,11 @@ The of type used to compare key objects of type for equality. Initializes a new instance of the class with access synchronized by an explicitly specified object and with keys compared in a specified way. - input parameter is the first generic parameter for this class. This allows us to compare keys for equality in a customized way that can be used, for example, to optimize on the most critical aspects of the comparison. - + input parameter is the first generic parameter for this class. This allows us to compare keys for equality in a customized way that can be used, for example, to optimize on the most critical aspects of the comparison. + ]]> @@ -200,11 +200,11 @@ The number of items required to create a dictionary for the collection. Initializes a new instance of the class with access synchronized by an explicitly specified object and with keys compared in a specified way. - (2,147,483,647; hexadecimal 0x7FFFFFFF) to it. - + (2,147,483,647; hexadecimal 0x7FFFFFFF) to it. + ]]> @@ -377,9 +377,9 @@ - The item of type whose key is being retrieved. + The item of type T whose key is being retrieved. When overridden in a derived class, gets the key for a specified item. - The key of type K for the specified of type . + The key of type K for the specified of type T. To be added. @@ -413,7 +413,7 @@ The zero-based index that specifies the insertion location for the item in the collection. - The item of type to be inserted into the collection. + The item of type T to be inserted into the collection. Inserts an item into the collection at a specified location. To be added. @@ -550,7 +550,7 @@ The zero-based index that specifies the insertion location for the item in the collection. - The item of type to be inserted into the collection. + The item of type T to be inserted into the collection. Replaces an item at a specified location of the collection with a new item. To be added. diff --git a/xml/System.Collections.Immutable/IImmutableList`1.xml b/xml/System.Collections.Immutable/IImmutableList`1.xml index 8780434e6b6..39a70e3a9d4 100644 --- a/xml/System.Collections.Immutable/IImmutableList`1.xml +++ b/xml/System.Collections.Immutable/IImmutableList`1.xml @@ -55,18 +55,18 @@ The type of elements in the list. - Represents a list of elements that cannot be modified. - + Represents a list of elements that cannot be modified. + **NuGet package**: System.Collections.Immutable (about immutable collections and how to install) - , a copy of the original list is created, with the changes applied. Incremental changes to a list share as much memory as possible with earlier versions of a list and enable garbage collection to clean up any unique list data that is no longer being referenced. + +For information on creating an `IImmutableList` implementation, see . -When you add or remove items from an , a copy of the original list is created, with the changes applied. Incremental changes to a list share as much memory as possible with earlier versions of a list and enable garbage collection to clean up any unique list data that is no longer being referenced. - -For information on creating an `IImmutableList` implementation, see . - ]]> @@ -598,7 +598,7 @@ For information on creating an `IImmutableList` implementation, see The element to replace the first occurrence of with. The equality comparer to use for matching . Returns a new list with the first matching element in the list replaced with the specified element. - A new list that contains , even if is the same as . + A new list that contains , even if is the same as . To be added. does not exist in the list. diff --git a/xml/System.Collections.Immutable/ImmutableArray`1.xml b/xml/System.Collections.Immutable/ImmutableArray`1.xml index 6dd4f5b43c8..ea760a76a6b 100644 --- a/xml/System.Collections.Immutable/ImmutableArray`1.xml +++ b/xml/System.Collections.Immutable/ImmutableArray`1.xml @@ -973,7 +973,7 @@ This example shows how to create an immutable array using The array to copy to. - The index in where copying begins. + The index in where copying begins. Copies the contents of this array to the specified array starting at the specified destination index. To be added. @@ -1013,7 +1013,7 @@ This example shows how to create an immutable array using The index of this array where copying begins. The array to copy to. - The index in where copying begins. + The index in where copying begins. The number of elements to copy from this array. Copies the specified items in this array to the specified array at the specified starting index. To be added. @@ -4738,7 +4738,7 @@ This member is an explicit interface member implementation. It can be used only The index of the item to replace. The value to add to the list. Replaces the item at the specified index with the specified item. - The new array that contains at the specified index. + The new array that contains at the specified index. - Contains interlocked exchange mechanisms for immutable collections. - + Contains interlocked exchange mechanisms for immutable collections. + **NuGet package**: System.Collections.Immutable (about immutable collections and how to install) To be added. This type is thread safe. @@ -296,9 +296,9 @@ The type of the values contained in the collection. The variable or field to atomically update if the specified key is not in the dictionary. The key for the value to get or add. - The value to add to the dictionary the key is not found. + The value to add to the dictionary if the key isn't found. Gets the value for the specified key from the dictionary, or if the key was not found, adds a new value to the dictionary. - The value at the specified key or if the key was not present. + The value at the specified key, if present. To be added. diff --git a/xml/System.Collections.Immutable/ImmutableList`1+Builder.xml b/xml/System.Collections.Immutable/ImmutableList`1+Builder.xml index face941854d..0f3d3bff7af 100644 --- a/xml/System.Collections.Immutable/ImmutableList`1+Builder.xml +++ b/xml/System.Collections.Immutable/ImmutableList`1+Builder.xml @@ -75,15 +75,15 @@ - Represents a list that mutates with little or no memory allocations and that can produce or build on immutable list instances very efficiently. - + Represents a list that mutates with little or no memory allocations and that can produce or build on immutable list instances very efficiently. + **NuGet package**: System.Collections.Immutable (about immutable collections and how to install) - and other methods already provide fast bulk change operations on the list, the class allows multiple combinations of changes to be made to a list with equal efficiency. - + and other methods already provide fast bulk change operations on the list, the class allows multiple combinations of changes to be made to a list with equal efficiency. + ]]> @@ -198,11 +198,11 @@ Searches the entire for an element using the default comparer and returns the zero-based index of the element. The zero-based index of item in the , if item is found; otherwise, a negative number that is the bitwise complement of the index of the next element that is larger than . - does not contain the specified value, the method returns a negative integer. You can apply the bitwise complement operation (~) to this negative integer to get the index of the first element that is larger than the search value. When inserting the value into the , this index should be used as the insertion point to maintain the sort order. - + does not contain the specified value, the method returns a negative integer. You can apply the bitwise complement operation (~) to this negative integer to get the index of the first element that is larger than the search value. When inserting the value into the , this index should be used as the insertion point to maintain the sort order. + ]]> The default comparer cannot find an implementation of the generic interface or the interface for type T. @@ -255,11 +255,11 @@ Searches the entire for an element using the specified comparer and returns the zero-based index of the element. The zero-based index of item in the , if item is found; otherwise, a negative number that is the bitwise complement of the index of the next element that is larger than . - does not contain the specified value, the method returns a negative integer. You can apply the bitwise complement operation (~) to this negative integer to get the index of the first element that is larger than the search value. When inserting the value into the , this index should be used as the insertion point to maintain the sort order. - + does not contain the specified value, the method returns a negative integer. You can apply the bitwise complement operation (~) to this negative integer to get the index of the first element that is larger than the search value. When inserting the value into the , this index should be used as the insertion point to maintain the sort order. + ]]> @@ -318,11 +318,11 @@ Searches the specified range of the for an element using the specified comparer and returns the zero-based index of the element. The zero-based index of item in the , if item is found; otherwise, a negative number that is the bitwise complement of the index of the next element that is larger than . - does not contain the specified value, the method returns a negative integer. You can apply the bitwise complement operation (~) to this negative integer to get the index of the first element that is larger than the search value. When inserting the value into the , this index should be used as the insertion point to maintain the sort order. - + does not contain the specified value, the method returns a negative integer. You can apply the bitwise complement operation (~) to this negative integer to get the index of the first element that is larger than the search value. When inserting the value into the , this index should be used as the insertion point to maintain the sort order. + ]]> @@ -1528,7 +1528,7 @@ The object to locate in the immutable list. The value can be for reference types. The zero-based starting index of the backward search. Searches for the specified object and returns the zero-based index of the last occurrence within the range of elements in the immutable list that extends from the first element to the specified index. - The zero-based index of the last occurrence of within the range of elements in the immutable list that extends from the first element to , if found; otherwise, -1. + The zero-based index of the last occurrence of within the range of elements in the immutable list that extends from the first element to , if found; otherwise, -1. To be added. @@ -1568,7 +1568,7 @@ The zero-based starting index of the backward search. The number of elements in the section to search. Searches for the specified object and returns the zero-based index of the last occurrence within the range of elements in the immutable list that contains the specified number of elements and ends at the specified index. - The zero-based index of the last occurrence of within the range of elements in the immutable list that contains number of elements and ends at , if found; otherwise, -1. + The zero-based index of the last occurrence of within the range of elements in the immutable list that contains number of elements and ends at , if found; otherwise, -1. To be added. @@ -1618,7 +1618,7 @@ The number of elements to search. The value comparer to use for comparing elements for equality. Searches for the specified object and returns the zero-based index of the last occurrence within the range of elements in the immutable list that contains the specified number of elements and ends at the specified index. - The zero-based index of the first occurrence of item within the range of elements in the immutable list that starts at and contains number of elements, if found; otherwise, -1 + The zero-based index of the first occurrence of item within the range of elements in the immutable list that starts at and contains number of elements, if found; otherwise, -1 To be added. @@ -2229,11 +2229,11 @@ Returns an enumerator that iterates through the collection. An enumerator that can be used to iterate through the collection. - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -2276,11 +2276,11 @@ The zero-based index in at which copying begins. Copies the elements of the list to an array, starting at a particular array index. - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -2419,11 +2419,11 @@ This member is an explicit interface member implementation. It can be used only Returns an enumerator that iterates through the collection. An enumerator that can be used to iterate through the collection. - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -2465,11 +2465,11 @@ This member is an explicit interface member implementation. It can be used only Adds an item to the list. The position into which the new element was inserted, or -1 to indicate that the item was not inserted into the collection. - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -2508,11 +2508,11 @@ This member is an explicit interface member implementation. It can be used only Removes all items from the list. - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -2556,11 +2556,11 @@ This member is an explicit interface member implementation. It can be used only if the is found in the list; otherwise, . - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -2603,11 +2603,11 @@ This member is an explicit interface member implementation. It can be used only Determines the index of a specific item in the list. The index of if found in the list; otherwise, -1. - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -2651,11 +2651,11 @@ This member is an explicit interface member implementation. It can be used only The object to insert into the list. Inserts an item to the list at the specified index. - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -2831,11 +2831,11 @@ This member is an explicit interface member implementation. It can be used only The object to remove from the list. Removes the first occurrence of a specific object from the list. - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -2872,11 +2872,11 @@ This member is an explicit interface member implementation. It can be used only Creates an immutable list based on the contents of this instance. An immutable list. - diff --git a/xml/System.Collections.ObjectModel/Collection`1.xml b/xml/System.Collections.ObjectModel/Collection`1.xml index 560107ffe73..7b4b600a742 100644 --- a/xml/System.Collections.ObjectModel/Collection`1.xml +++ b/xml/System.Collections.ObjectModel/Collection`1.xml @@ -123,7 +123,7 @@ Most objects can be modified. However, a object that is initialized with a read-only object cannot be modified. See for a read-only version of this class. - Elements in this collection can be accessed using an integer index. Indexes in this collection are zero-based. + Elements in this collection can be accessed using an integer index. Indexes in this collection are zero-based. accepts `null` as a valid value for reference types and allows duplicate elements. @@ -155,7 +155,7 @@ Public static ( in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe. - A can support multiple readers concurrently, as long as the collection is not modified. Even so, enumerating through a collection is intrinsically not a thread-safe procedure. To guarantee thread safety during enumeration, you can lock the collection during the entire enumeration. To allow the collection to be accessed by multiple threads for reading and writing, you must implement your own synchronization. + A can support multiple readers concurrently, as long as the collection is not modified. Even so, enumerating through a collection is intrinsically not a thread-safe procedure. To guarantee thread safety during enumeration, you can lock the collection during the entire enumeration. To allow the collection to be accessed by multiple threads for reading and writing, you must implement your own synchronization. This base class is provided to make it easier for implementers to create a custom collection. Implementers are encouraged to extend this base class instead of creating their own. @@ -774,7 +774,7 @@ are not synchronized. @@ -1221,7 +1221,7 @@ The object to remove from the . The value can be for reference types. Removes the first occurrence of a specific object from the . - if is successfully removed; otherwise, . This method also returns if was not found in the original . + if is successfully removed; otherwise, . This method also returns if was not found in the original . Gets a value indicating whether the is read-only. - if the is read-only; otherwise, . In the default implementation of , this property always returns . + if the is read-only; otherwise, . In the default implementation of , this property always returns . Gets a value indicating whether access to the is synchronized (thread safe). - if access to the is synchronized (thread safe); otherwise, . In the default implementation of , this property always returns . + if access to the is synchronized (thread safe); otherwise, . In the default implementation of , this property always returns . Gets an object that can be used to synchronize access to the . - An object that can be used to synchronize access to the . In the default implementation of , this property always returns the current instance. + An object that can be used to synchronize access to the . In the default implementation of , this property always returns the current instance. are not synchronized. - Enumerating through a collection is intrinsically not a thread-safe procedure. To guarantee thread safety during enumeration, you can lock the collection during the entire enumeration. To allow the collection to be accessed by multiple threads for reading and writing, you must implement your own synchronization. + Enumerating through a collection is intrinsically not a thread-safe procedure. To guarantee thread safety during enumeration, you can lock the collection during the entire enumeration. To allow the collection to be accessed by multiple threads for reading and writing, you must implement your own synchronization. returns an object that can be used to synchronize access to the . Synchronization is effective only if all threads lock this object before accessing the collection. The following code shows the use of the property for C#, C++, and Visual Basic. @@ -1813,11 +1813,11 @@ finally { also brings the enumerator back to this position. At this position, is undefined. Therefore, you must call to advance the enumerator to the first element of the collection before reading the value of . + Initially, the enumerator is positioned before the first element in the collection. also brings the enumerator back to this position. At this position, is undefined. Therefore, you must call to advance the enumerator to the first element of the collection before reading the value of . returns the same object until either or is called. sets to the next element. @@ -1825,7 +1825,7 @@ finally { An enumerator remains valid as long as the collection remains unchanged. If changes are made to the collection, such as adding, modifying, or deleting elements, the enumerator is irrecoverably invalidated and its behavior is undefined. - The enumerator does not have exclusive access to the collection; therefore, enumerating through a collection is intrinsically not a thread-safe procedure. To guarantee thread safety during enumeration, you can lock the collection during the entire enumeration. To allow the collection to be accessed by multiple threads for reading and writing, you must implement your own synchronization. + The enumerator does not have exclusive access to the collection; therefore, enumerating through a collection is intrinsically not a thread-safe procedure. To guarantee thread safety during enumeration, you can lock the collection during the entire enumeration. To allow the collection to be accessed by multiple threads for reading and writing, you must implement your own synchronization. Default implementations of collections in are not synchronized. @@ -2008,7 +2008,7 @@ finally { . checks whether type `T` implements and uses that implementation, if available. If not, checks whether type `T` implements . If type `T` does not implement either interface, this method uses . + This method determines equality using the default comparer . checks whether type `T` implements and uses that implementation, if available. If not, checks whether type `T` implements . If type `T` does not implement either interface, this method uses . This method is an O(`n`) operation, where `n` is . @@ -2125,7 +2125,7 @@ finally { Gets a value indicating whether the has a fixed size. - if the has a fixed size; otherwise, . In the default implementation of , this property always returns . + if the has a fixed size; otherwise, . In the default implementation of , this property always returns . Gets a value indicating whether the is read-only. - if the is read-only; otherwise, . In the default implementation of , this property always returns . + if the is read-only; otherwise, . In the default implementation of , this property always returns . is not a valid index in the . - The property is set and is of a type that is not assignable to the . + The property is set and the value is of a type that is not assignable to the . @@ -2319,7 +2319,7 @@ finally { . checks whether type `T` implements and uses that implementation, if available. If not, checks whether type `T` implements . If type `T` does not implement either interface, this method uses . + This method determines equality using the default comparer . checks whether type `T` implements and uses that implementation, if available. If not, checks whether type `T` implements . If type `T` does not implement either interface, this method uses . This method is an O(`n`) operation, where `n` is . diff --git a/xml/System.Collections.ObjectModel/KeyedCollection`2.xml b/xml/System.Collections.ObjectModel/KeyedCollection`2.xml index 060a8c476b9..433d4ae0d18 100644 --- a/xml/System.Collections.ObjectModel/KeyedCollection`2.xml +++ b/xml/System.Collections.ObjectModel/KeyedCollection`2.xml @@ -415,13 +415,13 @@ In order to maintain the connection between a `MutableKey` object and the `Mutab -or- - is . + is . is not found. -or- - already exists in the . + already exists in the . diff --git a/xml/System.Collections.ObjectModel/ReadOnlyCollection`1.xml b/xml/System.Collections.ObjectModel/ReadOnlyCollection`1.xml index afc64600c11..29f4f5fcd3d 100644 --- a/xml/System.Collections.ObjectModel/ReadOnlyCollection`1.xml +++ b/xml/System.Collections.ObjectModel/ReadOnlyCollection`1.xml @@ -114,28 +114,28 @@ The type of elements in the collection. Provides the base class for a generic read-only collection. - generic class is always read-only. A collection that is read-only is simply a collection with a wrapper that prevents modifying the collection; therefore, if changes are made to the underlying collection, the read-only collection reflects those changes. See for a modifiable version of this class. - - - -## Examples - The following code example demonstrates several members of the class. The code example creates a of strings and adds four dinosaur names to it. The code example then wraps the list in a . - - After demonstrating the , , , and members, the code example shows that the is just a wrapper for the original by adding a new item to the and displaying the contents of the . - - Finally, the code example creates an array larger than the collection and uses the method to insert the elements of the collection into the middle of the array. - - :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/generic.ReadOnlyCollection/cpp/source.cpp" id="Snippet1"::: - :::code language="csharp" source="~/snippets/csharp/System.Collections.ObjectModel/ReadOnlyCollectionT/Overview/source.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/generic.ReadOnlyCollection/vb/source.vb" id="Snippet1"::: - + generic class is always read-only. A collection that is read-only is simply a collection with a wrapper that prevents modifying the collection; therefore, if changes are made to the underlying collection, the read-only collection reflects those changes. See for a modifiable version of this class. + + + +## Examples + The following code example demonstrates several members of the class. The code example creates a of strings and adds four dinosaur names to it. The code example then wraps the list in a . + + After demonstrating the , , , and members, the code example shows that the is just a wrapper for the original by adding a new item to the and displaying the contents of the . + + Finally, the code example creates an array larger than the collection and uses the method to insert the elements of the collection into the middle of the array. + + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/generic.ReadOnlyCollection/cpp/source.cpp" id="Snippet1"::: + :::code language="csharp" source="~/snippets/csharp/System.Collections.ObjectModel/ReadOnlyCollectionT/Overview/source.cs" id="Snippet1"::: + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/generic.ReadOnlyCollection/vb/source.vb" id="Snippet1"::: + ]]> - Public static ( in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe. - + Public static ( in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe. + A can support multiple readers concurrently, as long as the collection is not modified. Even so, enumerating through a collection is intrinsically not a thread-safe procedure. To guarantee thread safety during enumeration, you can lock the collection during the entire enumeration. To allow the collection to be accessed by multiple threads for reading and writing, you must implement your own synchronization. This base class is provided to make it easier for implementers to create a generic read-only custom collection. Implementers are encouraged to extend this base class instead of creating their own. @@ -184,30 +184,30 @@ The list to wrap. Initializes a new instance of the class that is a read-only wrapper around the specified list. - class. - - The code example creates a of strings and adds four dinosaur names to it. The code example then wraps the list in a by passing it to the constructor. - - After demonstrating the , , , and members, the code example shows that the is just a wrapper for the original by adding a new item to the and displaying the contents of the . - - Finally, the code example creates an array larger than the collection and uses the method to insert the elements of the collection into the middle of the array. - - :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/generic.ReadOnlyCollection/cpp/source.cpp" id="Snippet1"::: - :::code language="csharp" source="~/snippets/csharp/System.Collections.ObjectModel/ReadOnlyCollectionT/Overview/source.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/generic.ReadOnlyCollection/vb/source.vb" id="Snippet1"::: - + class. + + The code example creates a of strings and adds four dinosaur names to it. The code example then wraps the list in a by passing it to the constructor. + + After demonstrating the , , , and members, the code example shows that the is just a wrapper for the original by adding a new item to the and displaying the contents of the . + + Finally, the code example creates an array larger than the collection and uses the method to insert the elements of the collection into the middle of the array. + + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/generic.ReadOnlyCollection/cpp/source.cpp" id="Snippet1"::: + :::code language="csharp" source="~/snippets/csharp/System.Collections.ObjectModel/ReadOnlyCollectionT/Overview/source.cs" id="Snippet1"::: + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/generic.ReadOnlyCollection/vb/source.vb" id="Snippet1"::: + ]]> @@ -270,26 +270,26 @@ if is found in the ; otherwise, . - . - - This method performs a linear search; therefore, this method is an O(`n`) operation, where `n` is . - - - -## Examples - The following code example demonstrates several members of the class. The code example creates a of strings and adds four dinosaur names to it. The code example then wraps the list in a . - - After demonstrating the , , , and members, the code example shows that the is just a wrapper for the original by adding a new item to the and displaying the contents of the . - - Finally, the code example creates an array larger than the collection and uses the method to insert the elements of the collection into the middle of the array. - - :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/generic.ReadOnlyCollection/cpp/source.cpp" id="Snippet1"::: - :::code language="csharp" source="~/snippets/csharp/System.Collections.ObjectModel/ReadOnlyCollectionT/Overview/source.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/generic.ReadOnlyCollection/vb/source.vb" id="Snippet1"::: - + . + + This method performs a linear search; therefore, this method is an O(`n`) operation, where `n` is . + + + +## Examples + The following code example demonstrates several members of the class. The code example creates a of strings and adds four dinosaur names to it. The code example then wraps the list in a . + + After demonstrating the , , , and members, the code example shows that the is just a wrapper for the original by adding a new item to the and displaying the contents of the . + + Finally, the code example creates an array larger than the collection and uses the method to insert the elements of the collection into the middle of the array. + + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/generic.ReadOnlyCollection/cpp/source.cpp" id="Snippet1"::: + :::code language="csharp" source="~/snippets/csharp/System.Collections.ObjectModel/ReadOnlyCollectionT/Overview/source.cs" id="Snippet1"::: + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/generic.ReadOnlyCollection/vb/source.vb" id="Snippet1"::: + ]]> @@ -345,28 +345,28 @@ The zero-based index in at which copying begins. Copies the entire to a compatible one-dimensional , starting at the specified index of the target array. - to copy the elements. - - The elements are copied to the in the same order that the enumerator iterates through the . - - This method is an O(`n`) operation, where `n` is . - - - -## Examples - The following code example demonstrates several members of the class. The code example creates a of strings and adds four dinosaur names to it. The code example then wraps the list in a . - - After demonstrating the , , , and members, the code example shows that the is just a wrapper for the original by adding a new item to the and displaying the contents of the . - - Finally, the code example creates an array larger than the collection and uses the method to insert the elements of the collection into the middle of the array. - - :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/generic.ReadOnlyCollection/cpp/source.cpp" id="Snippet1"::: - :::code language="csharp" source="~/snippets/csharp/System.Collections.ObjectModel/ReadOnlyCollectionT/Overview/source.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/generic.ReadOnlyCollection/vb/source.vb" id="Snippet1"::: - + to copy the elements. + + The elements are copied to the in the same order that the enumerator iterates through the . + + This method is an O(`n`) operation, where `n` is . + + + +## Examples + The following code example demonstrates several members of the class. The code example creates a of strings and adds four dinosaur names to it. The code example then wraps the list in a . + + After demonstrating the , , , and members, the code example shows that the is just a wrapper for the original by adding a new item to the and displaying the contents of the . + + Finally, the code example creates an array larger than the collection and uses the method to insert the elements of the collection into the middle of the array. + + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/generic.ReadOnlyCollection/cpp/source.cpp" id="Snippet1"::: + :::code language="csharp" source="~/snippets/csharp/System.Collections.ObjectModel/ReadOnlyCollectionT/Overview/source.cs" id="Snippet1"::: + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/generic.ReadOnlyCollection/vb/source.vb" id="Snippet1"::: + ]]> @@ -428,24 +428,24 @@ Gets the number of elements contained in the instance. The number of elements contained in the instance. - class. The code example creates a of strings and adds four dinosaur names to it. The code example then wraps the list in a . - - After demonstrating the , , , and members, the code example shows that the is just a wrapper for the original by adding a new item to the and displaying the contents of the . - - Finally, the code example creates an array larger than the collection and uses the method to insert the elements of the collection into the middle of the array. - - :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/generic.ReadOnlyCollection/cpp/source.cpp" id="Snippet1"::: - :::code language="csharp" source="~/snippets/csharp/System.Collections.ObjectModel/ReadOnlyCollectionT/Overview/source.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/generic.ReadOnlyCollection/vb/source.vb" id="Snippet1"::: - + class. The code example creates a of strings and adds four dinosaur names to it. The code example then wraps the list in a . + + After demonstrating the , , , and members, the code example shows that the is just a wrapper for the original by adding a new item to the and displaying the contents of the . + + Finally, the code example creates an array larger than the collection and uses the method to insert the elements of the collection into the middle of the array. + + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/generic.ReadOnlyCollection/cpp/source.cpp" id="Snippet1"::: + :::code language="csharp" source="~/snippets/csharp/System.Collections.ObjectModel/ReadOnlyCollectionT/Overview/source.cs" id="Snippet1"::: + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/generic.ReadOnlyCollection/vb/source.vb" id="Snippet1"::: + ]]> @@ -529,36 +529,36 @@ Returns an enumerator that iterates through the . An for the . - is undefined. Therefore, you must call to advance the enumerator to the first element of the collection before reading the value of . - - returns the same object until is called. sets to the next element. - - If passes the end of the collection, the enumerator is positioned after the last element in the collection and returns `false`. When the enumerator is at this position, subsequent calls to also return `false`. If the last call to returned `false`, is undefined. You cannot set to the first element of the collection again; you must create a new enumerator instance instead. - - An enumerator remains valid as long as the collection remains unchanged. If changes are made to the collection, such as adding, modifying, or deleting elements, the enumerator is irrecoverably invalidated and its behavior is undefined. - - The enumerator does not have exclusive access to the collection; therefore, enumerating through a collection is intrinsically not a thread-safe procedure. To guarantee thread safety during enumeration, you can lock the collection during the entire enumeration. To allow the collection to be accessed by multiple threads for reading and writing, you must implement your own synchronization. - - Default implementations of collections in are not synchronized. - - This method is an O(1) operation. - - - -## Examples - The following code example uses the enumerator to display the contents of a that wraps a . The enumerator is concealed by the `foreach` statement (`For Each` in Visual Basic, `for each` in C++). - - :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/generic.ReadOnlyCollection/cpp/source.cpp" id="Snippet1"::: - :::code language="csharp" source="~/snippets/csharp/System.Collections.ObjectModel/ReadOnlyCollectionT/Overview/source.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/generic.ReadOnlyCollection/vb/source.vb" id="Snippet1"::: - + is undefined. Therefore, you must call to advance the enumerator to the first element of the collection before reading the value of . + + returns the same object until is called. sets to the next element. + + If passes the end of the collection, the enumerator is positioned after the last element in the collection and returns `false`. When the enumerator is at this position, subsequent calls to also return `false`. If the last call to returned `false`, is undefined. You cannot set to the first element of the collection again; you must create a new enumerator instance instead. + + An enumerator remains valid as long as the collection remains unchanged. If changes are made to the collection, such as adding, modifying, or deleting elements, the enumerator is irrecoverably invalidated and its behavior is undefined. + + The enumerator does not have exclusive access to the collection; therefore, enumerating through a collection is intrinsically not a thread-safe procedure. To guarantee thread safety during enumeration, you can lock the collection during the entire enumeration. To allow the collection to be accessed by multiple threads for reading and writing, you must implement your own synchronization. + + Default implementations of collections in are not synchronized. + + This method is an O(1) operation. + + + +## Examples + The following code example uses the enumerator to display the contents of a that wraps a . The enumerator is concealed by the `foreach` statement (`For Each` in Visual Basic, `for each` in C++). + + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/generic.ReadOnlyCollection/cpp/source.cpp" id="Snippet1"::: + :::code language="csharp" source="~/snippets/csharp/System.Collections.ObjectModel/ReadOnlyCollectionT/Overview/source.cs" id="Snippet1"::: + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/generic.ReadOnlyCollection/vb/source.vb" id="Snippet1"::: + ]]> @@ -610,17 +610,17 @@ The object to locate in the . The value can be for reference types. Searches for the specified object and returns the zero-based index of the first occurrence within the entire . - The zero-based index of the first occurrence of within the entire , if found; otherwise, -1. + The zero-based index of the first occurrence of within the entire , if found; otherwise, -1. - is searched forward starting at the first element and ending at the last element. - - This method determines equality using the default comparer . - - This method performs a linear search; therefore, this method is an O(`n`) operation, where `n` is . - + is searched forward starting at the first element and ending at the last element. + + This method determines equality using the default comparer . + + This method performs a linear search; therefore, this method is an O(`n`) operation, where `n` is . + ]]> @@ -681,35 +681,35 @@ Gets the element at the specified index. The element at the specified index. - property. Visual Basic implements as a default property, which provides the same indexing functionality. - - Retrieving the value of this property is an O(1) operation. - - - -## Examples - The following code example demonstrates several members of the class. The code example creates a of strings and adds four dinosaur names to it. The code example then wraps the list in a . - - After demonstrating the , , , and members, the code example shows that the is just a wrapper for the original by adding a new item to the and displaying the contents of the . - - Finally, the code example creates an array larger than the collection and uses the method to insert the elements of the collection into the middle of the array. - - :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/generic.ReadOnlyCollection/cpp/source.cpp" id="Snippet1"::: - :::code language="csharp" source="~/snippets/csharp/System.Collections.ObjectModel/ReadOnlyCollectionT/Overview/source.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/generic.ReadOnlyCollection/vb/source.vb" id="Snippet1"::: - + property. Visual Basic implements as a default property, which provides the same indexing functionality. + + Retrieving the value of this property is an O(1) operation. + + + +## Examples + The following code example demonstrates several members of the class. The code example creates a of strings and adds four dinosaur names to it. The code example then wraps the list in a . + + After demonstrating the , , , and members, the code example shows that the is just a wrapper for the original by adding a new item to the and displaying the contents of the . + + Finally, the code example creates an array larger than the collection and uses the method to insert the elements of the collection into the middle of the array. + + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/generic.ReadOnlyCollection/cpp/source.cpp" id="Snippet1"::: + :::code language="csharp" source="~/snippets/csharp/System.Collections.ObjectModel/ReadOnlyCollectionT/Overview/source.cs" id="Snippet1"::: + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/generic.ReadOnlyCollection/vb/source.vb" id="Snippet1"::: + ]]> - is less than zero. - - -or- - + is less than zero. + + -or- + is equal to or greater than . @@ -755,24 +755,24 @@ Returns the that the wraps. The that the wraps. - class. The code example creates a of strings and adds four dinosaur names to it. The code example then wraps the list in a . - - After demonstrating the , , , and members, the code example shows that the is just a wrapper for the original by adding a new item to the and displaying the contents of the . - - Finally, the code example creates an array larger than the collection and uses the method to insert the elements of the collection into the middle of the array. - - :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/generic.ReadOnlyCollection/cpp/source.cpp" id="Snippet1"::: - :::code language="csharp" source="~/snippets/csharp/System.Collections.ObjectModel/ReadOnlyCollectionT/Overview/source.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/generic.ReadOnlyCollection/vb/source.vb" id="Snippet1"::: - + class. The code example creates a of strings and adds four dinosaur names to it. The code example then wraps the list in a . + + After demonstrating the , , , and members, the code example shows that the is just a wrapper for the original by adding a new item to the and displaying the contents of the . + + Finally, the code example creates an array larger than the collection and uses the method to insert the elements of the collection into the middle of the array. + + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/generic.ReadOnlyCollection/cpp/source.cpp" id="Snippet1"::: + :::code language="csharp" source="~/snippets/csharp/System.Collections.ObjectModel/ReadOnlyCollectionT/Overview/source.cs" id="Snippet1"::: + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/generic.ReadOnlyCollection/vb/source.vb" id="Snippet1"::: + ]]> @@ -827,11 +827,11 @@ The object to add to the . Adds an item to the . This implementation always throws . - instance is cast to an interface. - + instance is cast to an interface. + ]]> Always thrown. @@ -881,11 +881,11 @@ Removes all items from the . This implementation always throws . - instance is cast to an interface. - + instance is cast to an interface. + ]]> Always thrown. @@ -936,17 +936,17 @@ if the is read-only; otherwise, . In the default implementation of , this property always returns . - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1000,11 +1000,11 @@ if was successfully removed from the ; otherwise, . - instance is cast to an interface. - + instance is cast to an interface. + ]]> Always thrown. @@ -1059,11 +1059,11 @@ The object to insert into the . Inserts an item to the at the specified index. This implementation always throws . - instance is cast to an interface. - + instance is cast to an interface. + ]]> Always thrown. @@ -1117,11 +1117,11 @@ Gets the element at the specified index. An occurs if you try to set the item at the specified index. The element at the specified index. - instance is cast to an interface. - + instance is cast to an interface. + ]]> Always thrown if the property is set. @@ -1174,11 +1174,11 @@ The zero-based index of the item to remove. Removes the item at the specified index. This implementation always throws . - instance is cast to an interface. - + instance is cast to an interface. + ]]> Always thrown. @@ -1233,17 +1233,17 @@ The zero-based index in at which copying begins. Copies the elements of the to an , starting at a particular index. - [!NOTE] -> If the type of the source cannot be cast automatically to the type of the destination `array`, the non-generic implementations of throw , whereas the generic implementations throw . - - This method is an O(`n`) operation, where `n` is . - - This member is an explicit interface member implementation. It can be used only when the instance is cast to an interface. - + [!NOTE] +> If the type of the source cannot be cast automatically to the type of the destination `array`, the non-generic implementations of throw , whereas the generic implementations throw . + + This method is an O(`n`) operation, where `n` is . + + This member is an explicit interface member implementation. It can be used only when the instance is cast to an interface. + ]]> @@ -1251,18 +1251,18 @@ is less than zero. - is multidimensional. - - -or- - - does not have zero-based indexing. - - -or- - - The number of elements in the source is greater than the available space from to the end of the destination . - - -or- - + is multidimensional. + + -or- + + does not have zero-based indexing. + + -or- + + The number of elements in the source is greater than the available space from to the end of the destination . + + -or- + The type of the source cannot be cast automatically to the type of the destination . @@ -1311,19 +1311,19 @@ if access to the is synchronized (thread safe); otherwise, . In the default implementation of , this property always returns . - are not synchronized. - - Enumerating through a collection is intrinsically not a thread-safe procedure. To guarantee thread safety during enumeration, you can lock the collection during the entire enumeration. To allow the collection to be accessed by multiple threads for reading and writing, you must implement your own synchronization. - - returns an object that can be used to synchronize access to the . - - Retrieving the value of this property is an O(1) operation. - - This member is an explicit interface member implementation. It can be used only when the instance is cast to an interface. - + are not synchronized. + + Enumerating through a collection is intrinsically not a thread-safe procedure. To guarantee thread safety during enumeration, you can lock the collection during the entire enumeration. To allow the collection to be accessed by multiple threads for reading and writing, you must implement your own synchronization. + + returns an object that can be used to synchronize access to the . + + Retrieving the value of this property is an O(1) operation. + + This member is an explicit interface member implementation. It can be used only when the instance is cast to an interface. + ]]> @@ -1373,44 +1373,44 @@ Gets an object that can be used to synchronize access to the . An object that can be used to synchronize access to the . In the default implementation of , this property always returns the current instance. - are not synchronized. - - Enumerating through a collection is intrinsically not a thread-safe procedure. To guarantee thread safety during enumeration, you can lock the collection during the entire enumeration. To allow the collection to be accessed by multiple threads for reading and writing, you must implement your own synchronization. - - returns an object that can be used to synchronize access to the . Synchronization is effective only if all threads lock this object before accessing the collection. The following code shows the use of the property for C#, Visual C++, and Visual Basic. - -```csharp -ICollection ic = ...; -lock (ic.SyncRoot) { - // Access the collection. -} -``` - -```vb -Dim ic As ICollection = ... -SyncLock ic.SyncRoot - ' Access the collection. -End SyncLock -``` - -```cpp -ICollection^ ic = ...; -try { - Monitor::Enter(ic->SyncRoot); - // Access the collection. -} -finally { - Monitor::Exit(ic->SyncRoot); -} -``` - - Retrieving the value of this property is an O(1) operation. - - This member is an explicit interface member implementation. It can be used only when the instance is cast to an interface. - + are not synchronized. + + Enumerating through a collection is intrinsically not a thread-safe procedure. To guarantee thread safety during enumeration, you can lock the collection during the entire enumeration. To allow the collection to be accessed by multiple threads for reading and writing, you must implement your own synchronization. + + returns an object that can be used to synchronize access to the . Synchronization is effective only if all threads lock this object before accessing the collection. The following code shows the use of the property for C#, Visual C++, and Visual Basic. + +```csharp +ICollection ic = ...; +lock (ic.SyncRoot) { + // Access the collection. +} +``` + +```vb +Dim ic As ICollection = ... +SyncLock ic.SyncRoot + ' Access the collection. +End SyncLock +``` + +```cpp +ICollection^ ic = ...; +try { + Monitor::Enter(ic->SyncRoot); + // Access the collection. +} +finally { + Monitor::Exit(ic->SyncRoot); +} +``` + + Retrieving the value of this property is an O(1) operation. + + This member is an explicit interface member implementation. It can be used only when the instance is cast to an interface. + ]]> @@ -1461,29 +1461,29 @@ finally { Returns an enumerator that iterates through a collection. An that can be used to iterate through the collection. - also brings the enumerator back to this position. At this position, is undefined. Therefore, you must call to advance the enumerator to the first element of the collection before reading the value of . - - returns the same object until either or is called. sets to the next element. - - If passes the end of the collection, the enumerator is positioned after the last element in the collection and returns `false`. When the enumerator is at this position, subsequent calls to also return `false`. If the last call to returned `false`, is undefined. To set to the first element of the collection again, you can call followed by . - - An enumerator remains valid as long as the collection remains unchanged. If changes are made to the collection, such as adding, modifying, or deleting elements, the enumerator is irrecoverably invalidated and its behavior is undefined. - - The enumerator does not have exclusive access to the collection; therefore, enumerating through a collection is intrinsically not a thread-safe procedure. To guarantee thread safety during enumeration, you can lock the collection during the entire enumeration. To allow the collection to be accessed by multiple threads for reading and writing, you must implement your own synchronization. - - Default implementations of collections in are not synchronized. - - This method is an O(1) operation. - - This member is an explicit interface member implementation. It can be used only when the instance is cast to an interface. - + also brings the enumerator back to this position. At this position, is undefined. Therefore, you must call to advance the enumerator to the first element of the collection before reading the value of . + + returns the same object until either or is called. sets to the next element. + + If passes the end of the collection, the enumerator is positioned after the last element in the collection and returns `false`. When the enumerator is at this position, subsequent calls to also return `false`. If the last call to returned `false`, is undefined. To set to the first element of the collection again, you can call followed by . + + An enumerator remains valid as long as the collection remains unchanged. If changes are made to the collection, such as adding, modifying, or deleting elements, the enumerator is irrecoverably invalidated and its behavior is undefined. + + The enumerator does not have exclusive access to the collection; therefore, enumerating through a collection is intrinsically not a thread-safe procedure. To guarantee thread safety during enumeration, you can lock the collection during the entire enumeration. To allow the collection to be accessed by multiple threads for reading and writing, you must implement your own synchronization. + + Default implementations of collections in are not synchronized. + + This method is an O(1) operation. + + This member is an explicit interface member implementation. It can be used only when the instance is cast to an interface. + ]]> @@ -1537,11 +1537,11 @@ finally { Adds an item to the . This implementation always throws . The position into which the new element was inserted. - instance is cast to an interface. - + instance is cast to an interface. + ]]> Always thrown. @@ -1591,11 +1591,11 @@ finally { Removes all items from the . This implementation always throws . - instance is cast to an interface. - + instance is cast to an interface. + ]]> Always thrown. @@ -1650,15 +1650,15 @@ finally { if the is found in the ; otherwise, . - . - - This method performs a linear search; therefore, this method is an O(`n`) operation, where `n` is . - - This member is an explicit interface member implementation. It can be used only when the instance is cast to an interface. - + . + + This method performs a linear search; therefore, this method is an O(`n`) operation, where `n` is . + + This member is an explicit interface member implementation. It can be used only when the instance is cast to an interface. + ]]> @@ -1713,15 +1713,15 @@ finally { Determines the index of a specific item in the . The index of if found in the list; otherwise, -1. - . - - This method performs a linear search; therefore, this method is an O(`n`) operation, where `n` is . - - This member is an explicit interface member implementation. It can be used only when the instance is cast to an interface. - + . + + This method performs a linear search; therefore, this method is an O(`n`) operation, where `n` is . + + This member is an explicit interface member implementation. It can be used only when the instance is cast to an interface. + ]]> @@ -1777,11 +1777,11 @@ finally { The to insert into the . Inserts an item to the at the specified index. This implementation always throws . - instance is cast to an interface. - + instance is cast to an interface. + ]]> Always thrown. @@ -1832,17 +1832,17 @@ finally { if the has a fixed size; otherwise, . In the default implementation of , this property always returns . - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1892,17 +1892,17 @@ finally { if the is read-only; otherwise, . In the default implementation of , this property always returns . - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1966,17 +1966,17 @@ finally { Gets the element at the specified index. A occurs if you try to set the item at the specified index. The element at the specified index. - property. Visual Basic implements as a default property, which provides the same indexing functionality. - - Retrieving the value of this property is an O(1) operation. - - This member is an explicit interface member implementation. It can be used only when the instance is cast to an interface. - + property. Visual Basic implements as a default property, which provides the same indexing functionality. + + Retrieving the value of this property is an O(1) operation. + + This member is an explicit interface member implementation. It can be used only when the instance is cast to an interface. + ]]> @@ -2031,11 +2031,11 @@ finally { The to remove from the . Removes the first occurrence of a specific object from the . This implementation always throws . - instance is cast to an interface. - + instance is cast to an interface. + ]]> Always thrown. @@ -2088,11 +2088,11 @@ finally { The zero-based index of the item to remove. Removes the item at the specified index. This implementation always throws . - instance is cast to an interface. - + instance is cast to an interface. + ]]> Always thrown. diff --git a/xml/System.Collections.Specialized/HybridDictionary.xml b/xml/System.Collections.Specialized/HybridDictionary.xml index 32f8308491b..320ce717bac 100644 --- a/xml/System.Collections.Specialized/HybridDictionary.xml +++ b/xml/System.Collections.Specialized/HybridDictionary.xml @@ -66,40 +66,40 @@ Implements by using a while the collection is small, and then switching to a when the collection gets large. - 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 . - - The constructor accepts a Boolean parameter that allows the user to specify whether the collection ignores the case when comparing strings. If the collection is case-sensitive, it uses the key's implementations of and . If the collection is case-insensitive, it performs a simple ordinal case-insensitive comparison, which obeys the casing rules of the invariant culture only. By default, the collection is case-sensitive. For more information on the invariant culture, see . - - A key cannot be null, but a value can. - - The `foreach` statement of the C# language (`For Each` in Visual Basic) returns an object of the type of the elements in the collection. Since each element of the is a key/value pair, the element type is not the type of the key or the type of the value. Instead, the element type is . For example: - + 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 . + + The constructor accepts a Boolean parameter that allows the user to specify whether the collection ignores the case when comparing strings. If the collection is case-sensitive, it uses the key's implementations of and . If the collection is case-insensitive, it performs a simple ordinal case-insensitive comparison, which obeys the casing rules of the invariant culture only. By default, the collection is case-sensitive. For more information on the invariant culture, see . + + A key cannot be null, but a value can. + + The `foreach` statement of the C# language (`For Each` in Visual Basic) returns an object of the type of the elements in the collection. Since each element of the is a key/value pair, the element type is not the type of the key or the type of the value. Instead, the element type is . For example: + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR_System/system.Collections.Specialized.HybridDictionary2/CPP/source2.cpp" id="Snippet2"::: :::code language="csharp" source="~/snippets/csharp/System.Collections.Specialized/HybridDictionary/Overview/source2.cs" id="Snippet2"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Collections.Specialized.HybridDictionary2/VB/source2.vb" id="Snippet2"::: - - The `foreach` statement is a wrapper around the enumerator, which only allows reading from, not writing to, the collection. - - - -## Examples - The following code example demonstrates several of the properties and methods of . - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Collections.Specialized.HybridDictionary2/VB/source2.vb" id="Snippet2"::: + + The `foreach` statement is a wrapper around the enumerator, which only allows reading from, not writing to, the collection. + + + +## Examples + The following code example demonstrates several of the properties and methods of . + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR_System/system.Collections.Specialized.HybridDictionary2/CPP/hybriddictionary.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Collections.Specialized/HybridDictionary/Overview/hybriddictionary.cs" interactive="try-dotnet" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Collections.Specialized.HybridDictionary2/VB/hybriddictionary.vb" id="Snippet1"::: - + ]]> - Public static ( in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe. - - This implementation does not provide a synchronized (thread safe) wrapper for a , but derived classes can create their own synchronized versions of the using the property. - + Public static ( in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe. + + This implementation does not provide a synchronized (thread safe) wrapper for a , but derived classes can create their own synchronized versions of the using the property. + Enumerating through a collection is intrinsically not a thread-safe procedure. Even when a collection is synchronized, other threads can still modify the collection, which causes the enumerator to throw an exception. To guarantee thread safety during enumeration, you can either lock the collection during the entire enumeration or catch the exceptions resulting from changes made by other threads. @@ -162,24 +162,24 @@ Creates an empty case-sensitive . - as the hash code provider and the key's implementation of as the comparer. - - The comparer determines whether two keys are equal. Every key in a must be unique. - - This constructor is an O(1) operation. - - - -## Examples - The following code example demonstrates several of the properties and methods of . - + as the hash code provider and the key's implementation of as the comparer. + + The comparer determines whether two keys are equal. Every key in a must be unique. + + This constructor is an O(1) operation. + + + +## Examples + The following code example demonstrates several of the properties and methods of . + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR_System/system.Collections.Specialized.HybridDictionary2/CPP/hybriddictionary.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Collections.Specialized/HybridDictionary/Overview/hybriddictionary.cs" interactive="try-dotnet" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Collections.Specialized.HybridDictionary2/VB/hybriddictionary.vb" id="Snippet1"::: - + ]]> Performing Culture-Insensitive String Operations @@ -231,13 +231,13 @@ A Boolean that denotes whether the is case-insensitive. Creates an empty with the specified case sensitivity. - and . If `caseInsensitive` is `true`, the collection performs a simple ordinal case-insensitive comparison, which obeys the casing rules of the invariant culture only. For more information on the invariant culture, see . - - This constructor is an O(1) operation. - + and . If `caseInsensitive` is `true`, the collection performs a simple ordinal case-insensitive comparison, which obeys the casing rules of the invariant culture only. For more information on the invariant culture, see . + + This constructor is an O(1) operation. + ]]> Performing Culture-Insensitive String Operations @@ -289,17 +289,17 @@ The approximate number of entries that the can initially contain. Creates a case-sensitive with the specified initial size. - , the collection is stored in a to avoid the overhead of copying elements from the to the . - - By default, the collection is case-sensitive and uses the key's implementation of as the hash code provider and the key's implementation of as the comparer. - - The comparer determines whether two keys are equal. Every key in a must be unique. - - This constructor is an O(`n`) operation, where `n` is `initialSize`. - + , the collection is stored in a to avoid the overhead of copying elements from the to the . + + By default, the collection is case-sensitive and uses the key's implementation of as the hash code provider and the key's implementation of as the comparer. + + The comparer determines whether two keys are equal. Every key in a must be unique. + + This constructor is an O(`n`) operation, where `n` is `initialSize`. + ]]> @@ -349,15 +349,15 @@ A Boolean that denotes whether the is case-insensitive. Creates a with the specified initial size and case sensitivity. - , the collection is stored in a to avoid the overhead of copying elements from the to the . - - If `caseInsensitive` is `false`, the collection uses the key's implementations of and . If `caseInsensitive` is `true`, the collection performs a simple ordinal case-insensitive comparison, which obeys the casing rules of the invariant culture only. For more information on the invariant culture, see . - - This constructor is an O(`n`) operation, where `n` is `initialSize`. - + , the collection is stored in a to avoid the overhead of copying elements from the to the . + + If `caseInsensitive` is `false`, the collection uses the key's implementations of and . If `caseInsensitive` is `true`, the collection performs a simple ordinal case-insensitive comparison, which obeys the casing rules of the invariant culture only. For more information on the invariant culture, see . + + This constructor is an O(`n`) operation, where `n` is `initialSize`. + ]]> Performing Culture-Insensitive String Operations @@ -419,28 +419,28 @@ The value of the entry to add. The value can be . Adds an entry with the specified key and value into the . - property to add new elements by setting the value of a key that does not exist in the ; for example, `myCollection["myNonexistentKey"] = myValue`. However, if the specified key already exists in the , setting the property overwrites the old value. In contrast, the method does not modify existing elements. - - When the number of elements becomes greater than the optimal size for a , the elements are copied from the to a . However, this only happens once. If the collection is already stored in a and the number of elements falls below the optimal size for a , the collection remains in the . - - This method is an O(1) operation. - - - -## Examples - The following code example adds to and removes elements from a . - + property to add new elements by setting the value of a key that does not exist in the ; for example, `myCollection["myNonexistentKey"] = myValue`. However, if the specified key already exists in the , setting the property overwrites the old value. In contrast, the method does not modify existing elements. + + When the number of elements becomes greater than the optimal size for a , the elements are copied from the to a . However, this only happens once. If the collection is already stored in a and the number of elements falls below the optimal size for a , the collection remains in the . + + This method is an O(1) operation. + + + +## Examples + The following code example adds to and removes elements from a . + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR_System/system.Collections.Specialized.HybridDictionary_AddRemove/CPP/hybriddictionary_addremove.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Collections.Specialized/HybridDictionary/Add/hybriddictionary_addremove.cs" interactive="try-dotnet" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Collections.Specialized.HybridDictionary_AddRemove/VB/hybriddictionary_addremove.vb" id="Snippet1"::: - + ]]> @@ -494,20 +494,20 @@ Removes all entries from the . - is set to zero, and references to other objects from elements of the collection are also released. - - If the collection is already stored in a , the collection remains in the . - - This method is an O(`n`) operation, where `n` is . - - - -## Examples - The following code example adds to and removes elements from a . - + is set to zero, and references to other objects from elements of the collection are also released. + + If the collection is already stored in a , the collection remains in the . + + This method is an O(`n`) operation, where `n` is . + + + +## Examples + The following code example adds to and removes elements from a . + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR_System/system.Collections.Specialized.HybridDictionary_AddRemove/CPP/hybriddictionary_addremove.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Collections.Specialized/HybridDictionary/Add/hybriddictionary_addremove.cs" interactive="try-dotnet" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Collections.Specialized.HybridDictionary_AddRemove/VB/hybriddictionary_addremove.vb" id="Snippet1"::: @@ -565,21 +565,21 @@ if the contains an entry with the specified key; otherwise, . - and methods on `key` to determine whether `item` exists. In the earlier versions of the .NET Framework, this determination was made by using the and methods of the `item` parameter on the objects in the collection. - - - -## Examples - The following code example searches for an element in a . - + and methods on `key` to determine whether `item` exists. In the earlier versions of the .NET Framework, this determination was made by using the and methods of the `item` parameter on the objects in the collection. + + + +## Examples + The following code example searches for an element in a . + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR_System/system.Collections.Specialized.HybridDictionary_Contains/CPP/hybriddictionary_contains.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Collections.Specialized/HybridDictionary/Contains/hybriddictionary_contains.cs" interactive="try-dotnet" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Collections.Specialized.HybridDictionary_Contains/VB/hybriddictionary_contains.vb" id="Snippet1"::: + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Collections.Specialized.HybridDictionary_Contains/VB/hybriddictionary_contains.vb" id="Snippet1"::: ]]> @@ -637,22 +637,20 @@ The zero-based index in at which copying begins. Copies the entries to a one-dimensional instance at the specified index. - in the same order in which the enumerator iterates through the . - - To copy only the keys in the , use `HybridDictionary.Keys.CopyTo`. - - To copy only the values in the , use `HybridDictionary.Values.CopyTo`. - - This method is an O(`n`) operation, where `n` is . - - - -## Examples - The following code example copies the elements of a to an array. - + in the same order in which the enumerator iterates through the . + + To copy only the keys in the , use `HybridDictionary.Keys.CopyTo`. + + To copy only the values in the , use `HybridDictionary.Values.CopyTo`. + + This method is an O(`n`) operation, where `n` is . + +## Examples + The following code example copies the elements of a to an array. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR_System/system.Collections.Specialized.HybridDictionary_CopyTo/CPP/hybriddictionary_copyto.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Collections.Specialized/HybridDictionary/CopyTo/hybriddictionary_copyto.cs" interactive="try-dotnet" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Collections.Specialized.HybridDictionary_CopyTo/VB/hybriddictionary_copyto.vb" id="Snippet1"::: @@ -664,11 +662,11 @@ is less than zero. - is multidimensional. - - -or- - - The number of elements in the source is greater than the available space from to the end of the destination . + is multidimensional. + + -or- + + The number of elements in the source is greater than the available space from to the end of the destination . The type of the source cannot be cast automatically to the type of the destination . @@ -716,19 +714,19 @@ Gets the number of key/value pairs contained in the . - The number of key/value pairs contained in the . - + The number of key/value pairs contained in the . + Retrieving the value of this property is an O(1) operation. - . - + . + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR_System/system.Collections.Specialized.HybridDictionary_Enumerator/CPP/hybriddictionary_enumerator.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Collections.Specialized/HybridDictionary/Count/hybriddictionary_enumerator.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Collections.Specialized.HybridDictionary_Enumerator/VB/hybriddictionary_enumerator.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Collections.Specialized.HybridDictionary_Enumerator/VB/hybriddictionary_enumerator.vb" id="Snippet1"::: + ]]> @@ -777,34 +775,34 @@ Returns an that iterates through the . An for the . - also brings the enumerator back to this position. At this position, is undefined. Therefore, you must call to advance the enumerator to the first element of the collection before reading the value of . - - returns the same object until either or is called. sets to the next element. - - If passes the end of the collection, the enumerator is positioned after the last element in the collection and returns `false`. When the enumerator is at this position, subsequent calls to also return `false`. If the last call to returned `false`, is undefined. To set to the first element of the collection again, you can call followed by . - - An enumerator remains valid as long as the collection remains unchanged. If changes are made to the collection, such as adding, modifying, or deleting elements, the enumerator is irrecoverably invalidated and its behavior is undefined. - - The enumerator does not have exclusive access to the collection; therefore, enumerating through a collection is intrinsically not a thread-safe procedure. To guarantee thread safety during enumeration, you can lock the collection during the entire enumeration. To allow the collection to be accessed by multiple threads for reading and writing, you must implement your own synchronization. - - This method is an O(1) operation. - - - -## Examples - The following code example enumerates the elements of a . - + also brings the enumerator back to this position. At this position, is undefined. Therefore, you must call to advance the enumerator to the first element of the collection before reading the value of . + + returns the same object until either or is called. sets to the next element. + + If passes the end of the collection, the enumerator is positioned after the last element in the collection and returns `false`. When the enumerator is at this position, subsequent calls to also return `false`. If the last call to returned `false`, is undefined. To set to the first element of the collection again, you can call followed by . + + An enumerator remains valid as long as the collection remains unchanged. If changes are made to the collection, such as adding, modifying, or deleting elements, the enumerator is irrecoverably invalidated and its behavior is undefined. + + The enumerator does not have exclusive access to the collection; therefore, enumerating through a collection is intrinsically not a thread-safe procedure. To guarantee thread safety during enumeration, you can lock the collection during the entire enumeration. To allow the collection to be accessed by multiple threads for reading and writing, you must implement your own synchronization. + + This method is an O(1) operation. + + + +## Examples + The following code example enumerates the elements of a . + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR_System/system.Collections.Specialized.HybridDictionary_Enumerator/CPP/hybriddictionary_enumerator.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Collections.Specialized/HybridDictionary/Count/hybriddictionary_enumerator.cs" interactive="try-dotnet" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Collections.Specialized.HybridDictionary_Enumerator/VB/hybriddictionary_enumerator.vb" id="Snippet1"::: - + ]]> @@ -854,17 +852,17 @@ Gets a value indicating whether the has a fixed size. This property always returns . - implements the property because it is required by the interface. - - A collection with a fixed size does not allow the addition or removal of elements after the collection is created, but it allows the modification of existing elements. - - A collection with a fixed size is simply a collection with a wrapper that prevents adding and removing elements; therefore, if changes are made to the underlying collection, including the addition or removal of elements, the fixed-size collection reflects those changes. - - Retrieving the value of this property is an O(1) operation. - + implements the property because it is required by the interface. + + A collection with a fixed size does not allow the addition or removal of elements after the collection is created, but it allows the modification of existing elements. + + A collection with a fixed size is simply a collection with a wrapper that prevents adding and removing elements; therefore, if changes are made to the underlying collection, including the addition or removal of elements, the fixed-size collection reflects those changes. + + Retrieving the value of this property is an O(1) operation. + ]]> @@ -912,17 +910,17 @@ Gets a value indicating whether the is read-only. This property always returns . - implements the property because it is required by the interface. - - A collection that is read-only does not allow the addition, removal, or modification of elements after the collection is created. - - A collection that is read-only is simply a collection with a wrapper that prevents modifying the collection; therefore, if changes are made to the underlying collection, the read-only collection reflects those changes. - - Retrieving the value of this property is an O(1) operation. - + implements the property because it is required by the interface. + + A collection that is read-only does not allow the addition, removal, or modification of elements after the collection is created. + + A collection that is read-only is simply a collection with a wrapper that prevents modifying the collection; therefore, if changes are made to the underlying collection, the read-only collection reflects those changes. + + Retrieving the value of this property is an O(1) operation. + ]]> @@ -970,26 +968,26 @@ Gets a value indicating whether the is synchronized (thread safe). This property always returns . - implements the property because it is required by the interface. - - Derived classes can provide a synchronized version of the using the property. - - Enumerating through a collection is intrinsically not a thread-safe procedure. Even when a collection is synchronized, other threads can still modify the collection, which causes the enumerator to throw an exception. To guarantee thread safety during enumeration, you can either lock the collection during the entire enumeration or catch the exceptions resulting from changes made by other threads. - - - -## Examples - The following code example shows how to lock the collection using the during the entire enumeration. - + implements the property because it is required by the interface. + + Derived classes can provide a synchronized version of the using the property. + + Enumerating through a collection is intrinsically not a thread-safe procedure. Even when a collection is synchronized, other threads can still modify the collection, which causes the enumerator to throw an exception. To guarantee thread safety during enumeration, you can either lock the collection during the entire enumeration or catch the exceptions resulting from changes made by other threads. + + + +## Examples + The following code example shows how to lock the collection using the during the entire enumeration. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR_System/system.Collections.Specialized.HybridDictionary2/CPP/source2.cpp" id="Snippet3"::: :::code language="csharp" source="~/snippets/csharp/System.Collections.Specialized/HybridDictionary/Overview/source2.cs" id="Snippet3"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Collections.Specialized.HybridDictionary2/VB/source2.vb" id="Snippet3"::: - - Retrieving the value of this property is an O(1) operation. - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Collections.Specialized.HybridDictionary2/VB/source2.vb" id="Snippet3"::: + + Retrieving the value of this property is an O(1) operation. + ]]> @@ -1049,28 +1047,28 @@ Gets or sets the value associated with the specified key. The value associated with the specified key. If the specified key is not found, attempting to get it returns , and attempting to set it creates a new entry using the specified key. - property to add new elements by setting the value of a key that does not exist in the ; for example, `myCollection["myNonexistentKey"] = myValue`. However, if the specified key already exists in the , setting the property overwrites the old value. In contrast, the method does not modify existing elements. - - A key cannot be `null`, but a value can. To distinguish between `null` that is returned because the specified key is not found and `null` that is returned because the value of the specified key is `null`, use the method to determine if the key exists in the list. - - The C# language uses the [this](/dotnet/csharp/language-reference/keywords/this) keyword to define the indexers instead of implementing the property. Visual Basic implements as a default property, which provides the same indexing functionality. - - Retrieving the value of this property is an O(1) operation; setting the property is also an O(1) operation. - - - -## Examples - The following code example enumerates the elements of a . - + property to add new elements by setting the value of a key that does not exist in the ; for example, `myCollection["myNonexistentKey"] = myValue`. However, if the specified key already exists in the , setting the property overwrites the old value. In contrast, the method does not modify existing elements. + + A key cannot be `null`, but a value can. To distinguish between `null` that is returned because the specified key is not found and `null` that is returned because the value of the specified key is `null`, use the method to determine if the key exists in the list. + + The C# language uses the [this](/dotnet/csharp/language-reference/keywords/this) keyword to define the indexers instead of implementing the property. Visual Basic implements as a default property, which provides the same indexing functionality. + + Retrieving the value of this property is an O(1) operation; setting the property is also an O(1) operation. + + + +## Examples + The following code example enumerates the elements of a . + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR_System/system.Collections.Specialized.HybridDictionary_Enumerator/CPP/hybriddictionary_enumerator.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Collections.Specialized/HybridDictionary/Count/hybriddictionary_enumerator.cs" interactive="try-dotnet" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Collections.Specialized.HybridDictionary_Enumerator/VB/hybriddictionary_enumerator.vb" id="Snippet1"::: - + ]]> @@ -1122,20 +1120,20 @@ Gets an containing the keys in the . An containing the keys in the . - is unspecified, but it is the same order as the associated values in the returned by the method. - - The returned is not a static copy; instead, the refers back to the keys in the original . Therefore, changes to the continue to be reflected in the . - - Retrieving the value of this property is an O(1) operation. - - - -## Examples - The following code example enumerates the elements of a . - + is unspecified, but it is the same order as the associated values in the returned by the method. + + The returned is not a static copy; instead, the refers back to the keys in the original . Therefore, changes to the continue to be reflected in the . + + Retrieving the value of this property is an O(1) operation. + + + +## Examples + The following code example enumerates the elements of a . + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR_System/system.Collections.Specialized.HybridDictionary_Enumerator/CPP/hybriddictionary_enumerator.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Collections.Specialized/HybridDictionary/Count/hybriddictionary_enumerator.cs" interactive="try-dotnet" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Collections.Specialized.HybridDictionary_Enumerator/VB/hybriddictionary_enumerator.vb" id="Snippet1"::: @@ -1192,24 +1190,24 @@ The key of the entry to remove. Removes the entry with the specified key from the . - does not contain an element with the specified key, the remains unchanged. No exception is thrown. - - If the collection is already stored in a and the number of elements falls below the optimal size for a , the collection remains in the to avoid the overhead of copying elements from the back to a . - - This method is an O(1) operation. - - - -## Examples - The following code example adds to and removes elements from a . - + does not contain an element with the specified key, the remains unchanged. No exception is thrown. + + If the collection is already stored in a and the number of elements falls below the optimal size for a , the collection remains in the to avoid the overhead of copying elements from the back to a . + + This method is an O(1) operation. + + + +## Examples + The following code example adds to and removes elements from a . + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR_System/system.Collections.Specialized.HybridDictionary_AddRemove/CPP/hybriddictionary_addremove.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Collections.Specialized/HybridDictionary/Add/hybriddictionary_addremove.cs" interactive="try-dotnet" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Collections.Specialized.HybridDictionary_AddRemove/VB/hybriddictionary_addremove.vb" id="Snippet1"::: - + ]]> @@ -1262,24 +1260,24 @@ Gets an object that can be used to synchronize access to the . An object that can be used to synchronize access to the . - using the property. The synchronizing code must perform operations on the of the , not directly on the . This ensures proper operation of collections that are derived from other objects. Specifically, it maintains proper synchronization with other threads that might be simultaneously modifying the object. - - Enumerating through a collection is intrinsically not a thread-safe procedure. Even when a collection is synchronized, other threads can still modify the collection, which causes the enumerator to throw an exception. To guarantee thread safety during enumeration, you can either lock the collection during the entire enumeration or catch the exceptions resulting from changes made by other threads. - - - -## Examples - The following code example shows how to lock the collection using the during the entire enumeration. - + using the property. The synchronizing code must perform operations on the of the , not directly on the . This ensures proper operation of collections that are derived from other objects. Specifically, it maintains proper synchronization with other threads that might be simultaneously modifying the object. + + Enumerating through a collection is intrinsically not a thread-safe procedure. Even when a collection is synchronized, other threads can still modify the collection, which causes the enumerator to throw an exception. To guarantee thread safety during enumeration, you can either lock the collection during the entire enumeration or catch the exceptions resulting from changes made by other threads. + + + +## Examples + The following code example shows how to lock the collection using the during the entire enumeration. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR_System/system.Collections.Specialized.HybridDictionary2/CPP/source2.cpp" id="Snippet3"::: :::code language="csharp" source="~/snippets/csharp/System.Collections.Specialized/HybridDictionary/Overview/source2.cs" id="Snippet3"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Collections.Specialized.HybridDictionary2/VB/source2.vb" id="Snippet3"::: - - Retrieving the value of this property is an O(1) operation. - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Collections.Specialized.HybridDictionary2/VB/source2.vb" id="Snippet3"::: + + Retrieving the value of this property is an O(1) operation. + ]]> @@ -1329,34 +1327,34 @@ Returns an that iterates through the . An for the . - also brings the enumerator back to this position. At this position, calling throws an exception. Therefore, you must call to advance the enumerator to the first element of the collection before reading the value of . - - returns the same object until either or is called. sets to the next element. - - If passes the end of the collection, the enumerator is positioned after the last element in the collection and returns `false`. When the enumerator is at this position, subsequent calls to also return `false`. If the last call to returned `false`, calling throws an exception. To set to the first element of the collection again, you can call followed by . - - An enumerator remains valid as long as the collection remains unchanged. If changes are made to the collection, such as adding, modifying, or deleting elements, the enumerator is irrecoverably invalidated and the next call to or throws an . If the collection is modified between and , returns the element that it is set to, even if the enumerator is already invalidated. - - The enumerator does not have exclusive access to the collection; therefore, enumerating through a collection is intrinsically not a thread-safe procedure. Even when a collection is synchronized, other threads can still modify the collection, which causes the enumerator to throw an exception. To guarantee thread safety during enumeration, you can either lock the collection during the entire enumeration or catch the exceptions resulting from changes made by other threads. - - This method is an O(1) operation. - - - -## Examples - The following code example enumerates the elements of a . - + also brings the enumerator back to this position. At this position, calling throws an exception. Therefore, you must call to advance the enumerator to the first element of the collection before reading the value of . + + returns the same object until either or is called. sets to the next element. + + If passes the end of the collection, the enumerator is positioned after the last element in the collection and returns `false`. When the enumerator is at this position, subsequent calls to also return `false`. If the last call to returned `false`, calling throws an exception. To set to the first element of the collection again, you can call followed by . + + An enumerator remains valid as long as the collection remains unchanged. If changes are made to the collection, such as adding, modifying, or deleting elements, the enumerator is irrecoverably invalidated and the next call to or throws an . If the collection is modified between and , returns the element that it is set to, even if the enumerator is already invalidated. + + The enumerator does not have exclusive access to the collection; therefore, enumerating through a collection is intrinsically not a thread-safe procedure. Even when a collection is synchronized, other threads can still modify the collection, which causes the enumerator to throw an exception. To guarantee thread safety during enumeration, you can either lock the collection during the entire enumeration or catch the exceptions resulting from changes made by other threads. + + This method is an O(1) operation. + + + +## Examples + The following code example enumerates the elements of a . + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR_System/system.Collections.Specialized.HybridDictionary_Enumerator/CPP/hybriddictionary_enumerator.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Collections.Specialized/HybridDictionary/Count/hybriddictionary_enumerator.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Collections.Specialized.HybridDictionary_Enumerator/VB/hybriddictionary_enumerator.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Collections.Specialized.HybridDictionary_Enumerator/VB/hybriddictionary_enumerator.vb" id="Snippet1"::: + ]]> @@ -1406,24 +1404,24 @@ Gets an containing the values in the . An containing the values in the . - is unspecified, but it is the same order as the associated keys in the returned by the method. - - The returned is not a static copy; instead, the refers back to the values in the original . Therefore, changes to the continue to be reflected in the . - - Retrieving the value of this property is an O(1) operation. - - - -## Examples - The following code example enumerates the elements of a . - + is unspecified, but it is the same order as the associated keys in the returned by the method. + + The returned is not a static copy; instead, the refers back to the values in the original . Therefore, changes to the continue to be reflected in the . + + Retrieving the value of this property is an O(1) operation. + + + +## Examples + The following code example enumerates the elements of a . + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR_System/system.Collections.Specialized.HybridDictionary_Enumerator/CPP/hybriddictionary_enumerator.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Collections.Specialized/HybridDictionary/Count/hybriddictionary_enumerator.cs" interactive="try-dotnet" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Collections.Specialized.HybridDictionary_Enumerator/VB/hybriddictionary_enumerator.vb" id="Snippet1"::: - + ]]> diff --git a/xml/System.Collections.Specialized/NotifyCollectionChangedEventArgs.xml b/xml/System.Collections.Specialized/NotifyCollectionChangedEventArgs.xml index 33cf7483ef1..e9f7b60f275 100644 --- a/xml/System.Collections.Specialized/NotifyCollectionChangedEventArgs.xml +++ b/xml/System.Collections.Specialized/NotifyCollectionChangedEventArgs.xml @@ -388,7 +388,7 @@ The index where the change occurred. Initializes a new instance of the class that describes a one-item change. To be added. - If is not Reset, Add, or Remove, or if is Reset and either is not null or is not -1. + If is not Reset, Add, or Remove, or if is Reset and either is not null or is not -1. diff --git a/xml/System.Collections/IEqualityComparer.xml b/xml/System.Collections/IEqualityComparer.xml index 55dacf16285..c963b72787b 100644 --- a/xml/System.Collections/IEqualityComparer.xml +++ b/xml/System.Collections/IEqualityComparer.xml @@ -51,16 +51,16 @@ Defines methods to support the comparison of objects for equality. - interface. In the .NET Framework, constructors of the , , and collection types accept this interface. +## Remarks + +This interface allows the implementation of customized equality comparison for collections. That is, you can create your own definition of equality, and specify that this definition be used with a collection type that accepts the interface. In the .NET Framework, constructors of the , , and collection types accept this interface. + +For the generic version of this interface, see . + +The `IEqualityComparer` interface supports only equality comparisons. Customization of comparisons for sorting and ordering is provided by the interface. -For the generic version of this interface, see . - -The `IEqualityComparer` interface supports only equality comparisons. Customization of comparisons for sorting and ordering is provided by the interface. - ]]> @@ -118,27 +118,27 @@ The `IEqualityComparer` interface supports only equality comparisons. Customizat if the specified objects are equal; otherwise, . - . In this example, the method is used to determine whether two objects are equal, based on the provided . - + . In this example, the method is used to determine whether two objects are equal, based on the provided . + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR_System/system.Collections.Hashtable_ctor/CPP/hashtable_ctor.cpp" id="Snippet2"::: :::code language="csharp" source="~/snippets/csharp/System.Collections/Hashtable/.ctor/hashtable_ctor.cs" id="Snippet2"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Collections.Hashtable_ctor/VB/hashtable_ctor.vb" id="Snippet2"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Collections.Hashtable_ctor/VB/hashtable_ctor.vb" id="Snippet2"::: + ]]> and are of different types and neither one can handle comparisons with the other. - The method is reflexive, symmetric, and transitive. That is, it returns if used to compare an object with itself; for two objects and if it is for and ; and for two objects and z if it is for and and also for and z. - + The method is reflexive, symmetric, and transitive. That is, it returns if used to compare an object with itself; for two objects and if it is for and ; and for two objects and z if it is for and and also for and z. + Implementations are required to ensure that if the method returns for two objects and , then the value returned by the method for must equal the value returned for . @@ -188,20 +188,18 @@ The `IEqualityComparer` interface supports only equality comparisons. Customizat Returns a hash code for the specified object. A hash code for the specified object. - method. - - - -## Examples - The following code example demonstrates the implementation of a case-insensitive . In this example, the method returns the hash code provided by the type. - + method. + +## Examples + The following code example demonstrates the implementation of a case-insensitive . In this example, the method returns the hash code provided by the type. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR_System/system.Collections.Hashtable_ctor/CPP/hashtable_ctor.cpp" id="Snippet2"::: :::code language="csharp" source="~/snippets/csharp/System.Collections/Hashtable/.ctor/hashtable_ctor.cs" id="Snippet2"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Collections.Hashtable_ctor/VB/hashtable_ctor.vb" id="Snippet2"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Collections.Hashtable_ctor/VB/hashtable_ctor.vb" id="Snippet2"::: + ]]> The type of is a reference type and is . diff --git a/xml/System.Runtime.Intrinsics.Arm/Sve.xml b/xml/System.Runtime.Intrinsics.Arm/Sve.xml index cba1fba02e8..f9ff47d3d49 100644 --- a/xml/System.Runtime.Intrinsics.Arm/Sve.xml +++ b/xml/System.Runtime.Intrinsics.Arm/Sve.xml @@ -232,7 +232,7 @@ To be added. To be added. - svbool_t svacgt[_f64](svbool_t pg, svfloat64_t op1, svfloat64_t op2) + svbool_t svacgt<see href="svbool_t pg, svfloat64_t op1, svfloat64_t op2">_f64</see> FACGT Presult.D, Pg/Z, Zop1.D, Zop2.D To be added. @@ -262,7 +262,7 @@ To be added. To be added. - svbool_t svacgt[_f32](svbool_t pg, svfloat32_t op1, svfloat32_t op2) + svbool_t svacgt<see href="svbool_t pg, svfloat32_t op1, svfloat32_t op2">_f32</see> FACGT Presult.S, Pg/Z, Zop1.S, Zop2.S To be added. @@ -292,7 +292,7 @@ To be added. To be added. - svbool_t svacge[_f64](svbool_t pg, svfloat64_t op1, svfloat64_t op2) + svbool_t svacge<see href="svbool_t pg, svfloat64_t op1, svfloat64_t op2">_f64</see> FACGE Presult.D, Pg/Z, Zop1.D, Zop2.D To be added. @@ -322,7 +322,7 @@ To be added. To be added. - svbool_t svacge[_f32](svbool_t pg, svfloat32_t op1, svfloat32_t op2) + svbool_t svacge<see href="svbool_t pg, svfloat32_t op1, svfloat32_t op2">_f32</see> FACGE Presult.S, Pg/Z, Zop1.S, Zop2.S To be added. @@ -352,7 +352,7 @@ To be added. To be added. - svbool_t svaclt[_f64](svbool_t pg, svfloat64_t op1, svfloat64_t op2) + svbool_t svaclt<see href="svbool_t pg, svfloat64_t op1, svfloat64_t op2">_f64</see> FACLT Presult.D, Pg/Z, Zop1.D, Zop2.D To be added. @@ -382,7 +382,7 @@ To be added. To be added. - svbool_t svaclt[_f32](svbool_t pg, svfloat32_t op1, svfloat32_t op2) + svbool_t svaclt<see href="svbool_t pg, svfloat32_t op1, svfloat32_t op2">_f32</see> FACLT Presult.S, Pg/Z, Zop1.S, Zop2.S To be added. @@ -412,7 +412,7 @@ To be added. To be added. - svbool_t svacle[_f64](svbool_t pg, svfloat64_t op1, svfloat64_t op2) + svbool_t svacle<see href="svbool_t pg, svfloat64_t op1, svfloat64_t op2">_f64</see> FACLE Presult.D, Pg/Z, Zop1.D, Zop2.D To be added. @@ -442,7 +442,7 @@ To be added. To be added. - svbool_t svacle[_f32](svbool_t pg, svfloat32_t op1, svfloat32_t op2) + svbool_t svacle<see href="svbool_t pg, svfloat32_t op1, svfloat32_t op2">_f32</see> FACLE Presult.S, Pg/Z, Zop1.S, Zop2.S To be added. @@ -1109,7 +1109,7 @@ To be added. - uint64_t svaddv[_u8](svbool_t pg, svuint8_t op) + uint64_t svaddv<see href="svbool_t pg, svuint8_t op">_u8</see> UADDV Dresult, Pg, Zop.B To be added. @@ -1137,7 +1137,7 @@ To be added. - float64_t svaddv[_f64](svbool_t pg, svfloat64_t op) + float64_t svaddv<see href="svbool_t pg, svfloat64_t op">_f64</see> FADDV Dresult, Pg, Zop.D To be added. @@ -1165,7 +1165,7 @@ To be added. - int64_t svaddv[_s16](svbool_t pg, svint16_t op) + int64_t svaddv<see href="svbool_t pg, svint16_t op">_s16</see> SADDV Dresult, Pg, Zop.H To be added. @@ -1193,7 +1193,7 @@ To be added. - int64_t svaddv[_s32](svbool_t pg, svint32_t op) + int64_t svaddv<see href="svbool_t pg, svint32_t op">_s32</see> SADDV Dresult, Pg, Zop.S To be added. @@ -1221,7 +1221,7 @@ To be added. - int64_t svaddv[_s64](svbool_t pg, svint64_t op) + int64_t svaddv<see href="svbool_t pg, svint64_t op">_s64</see> UADDV Dresult, Pg, Zop.D To be added. @@ -1249,7 +1249,7 @@ To be added. - int64_t svaddv[_s8](svbool_t pg, svint8_t op) + int64_t svaddv<see href="svbool_t pg, svint8_t op">_s8</see> SADDV Dresult, Pg, Zop.B To be added. @@ -1277,7 +1277,7 @@ To be added. - float32_t svaddv[_f32](svbool_t pg, svfloat32_t op) + float32_t svaddv<see href="svbool_t pg, svfloat32_t op">_f32</see> FADDV Sresult, Pg, Zop.S To be added. @@ -1305,7 +1305,7 @@ To be added. - uint64_t svaddv[_u16](svbool_t pg, svuint16_t op) + uint64_t svaddv<see href="svbool_t pg, svuint16_t op">_u16</see> UADDV Dresult, Pg, Zop.H To be added. @@ -1333,7 +1333,7 @@ To be added. - uint64_t svaddv[_u32](svbool_t pg, svuint32_t op) + uint64_t svaddv<see href="svbool_t pg, svuint32_t op">_u32</see> UADDV Dresult, Pg, Zop.S To be added. @@ -1361,7 +1361,7 @@ To be added. - uint64_t svaddv[_u64](svbool_t pg, svuint64_t op) + uint64_t svaddv<see href="svbool_t pg, svuint64_t op">_u64</see> UADDV Dresult, Pg, Zop.D To be added. @@ -1474,7 +1474,7 @@ To be added. To be added. - svuint8_t svqadd[_u8](svuint8_t op1, svuint8_t op2) + svuint8_t svqadd<see href="svuint8_t op1, svuint8_t op2">_u8</see> UQADD Zresult.B, Zop1.B, Zop2.B To be added. @@ -1504,7 +1504,7 @@ To be added. To be added. - svint16_t svqadd[_s16](svint16_t op1, svint16_t op2) + svint16_t svqadd<see href="svint16_t op1, svint16_t op2">_s16</see> SQADD Zresult.H, Zop1.H, Zop2.H To be added. @@ -1534,7 +1534,7 @@ To be added. To be added. - svint32_t svqadd[_s32](svint32_t op1, svint32_t op2) + svint32_t svqadd<see href="svint32_t op1, svint32_t op2">_s32</see> SQADD Zresult.S, Zop1.S, Zop2.S To be added. @@ -1564,7 +1564,7 @@ To be added. To be added. - svint64_t svqadd[_s64](svint64_t op1, svint64_t op2) + svint64_t svqadd<see href="svint64_t op1, svint64_t op2">_s64</see> SQADD Zresult.D, Zop1.D, Zop2.D To be added. @@ -1594,7 +1594,7 @@ To be added. To be added. - svint8_t svqadd[_s8](svint8_t op1, svint8_t op2) + svint8_t svqadd<see href="svint8_t op1, svint8_t op2">_s8</see> SQADD Zresult.B, Zop1.B, Zop2.B To be added. @@ -1624,7 +1624,7 @@ To be added. To be added. - svuint16_t svqadd[_u16](svuint16_t op1, svuint16_t op2) + svuint16_t svqadd<see href="svuint16_t op1, svuint16_t op2">_u16</see> UQADD Zresult.H, Zop1.H, Zop2.H To be added. @@ -1654,7 +1654,7 @@ To be added. To be added. - svuint32_t svqadd[_u32](svuint32_t op1, svuint32_t op2) + svuint32_t svqadd<see href="svuint32_t op1, svuint32_t op2">_u32</see> UQADD Zresult.S, Zop1.S, Zop2.S To be added. @@ -1684,7 +1684,7 @@ To be added. To be added. - svuint64_t svqadd[_u64](svuint64_t op1, svuint64_t op2) + svuint64_t svqadd<see href="svuint64_t op1, svuint64_t op2">_u64</see> UQADD Zresult.D, Zop1.D, Zop2.D To be added. @@ -1714,7 +1714,7 @@ To be added. To be added. - float64_t svadda[_f64](svbool_t pg, float64_t initial, svfloat64_t op) + float64_t svadda<see href="svbool_t pg, float64_t initial, svfloat64_t op">_f64</see> FADDA Dtied, Pg, Dtied, Zop.D To be added. @@ -1744,7 +1744,7 @@ To be added. To be added. - float32_t svadda[_f32](svbool_t pg, float32_t initial, svfloat32_t op) + float32_t svadda<see href="svbool_t pg, float32_t initial, svfloat32_t op">_f32</see> FADDA Stied, Pg, Stied, Zop.S To be added. @@ -2044,7 +2044,7 @@ To be added. - uint8_t svandv[_u8](svbool_t pg, svuint8_t op) + uint8_t svandv<see href="svbool_t pg, svuint8_t op">_u8</see> ANDV Bresult, Pg, Zop.B To be added. @@ -2072,7 +2072,7 @@ To be added. - int16_t svandv[_s16](svbool_t pg, svint16_t op) + int16_t svandv<see href="svbool_t pg, svint16_t op">_s16</see> ANDV Hresult, Pg, Zop.H To be added. @@ -2100,7 +2100,7 @@ To be added. - int32_t svandv[_s32](svbool_t pg, svint32_t op) + int32_t svandv<see href="svbool_t pg, svint32_t op">_s32</see> ANDV Sresult, Pg, Zop.S To be added. @@ -2128,7 +2128,7 @@ To be added. - int64_t svandv[_s64](svbool_t pg, svint64_t op) + int64_t svandv<see href="svbool_t pg, svint64_t op">_s64</see> ANDV Dresult, Pg, Zop.D To be added. @@ -2156,7 +2156,7 @@ To be added. - int8_t svandv[_s8](svbool_t pg, svint8_t op) + int8_t svandv<see href="svbool_t pg, svint8_t op">_s8</see> ANDV Bresult, Pg, Zop.B To be added. @@ -2184,7 +2184,7 @@ To be added. - uint16_t svandv[_u16](svbool_t pg, svuint16_t op) + uint16_t svandv<see href="svbool_t pg, svuint16_t op">_u16</see> ANDV Hresult, Pg, Zop.H To be added. @@ -2212,7 +2212,7 @@ To be added. - uint32_t svandv[_u32](svbool_t pg, svuint32_t op) + uint32_t svandv<see href="svbool_t pg, svuint32_t op">_u32</see> ANDV Sresult, Pg, Zop.S To be added. @@ -2240,7 +2240,7 @@ To be added. - uint64_t svandv[_u64](svbool_t pg, svuint64_t op) + uint64_t svandv<see href="svbool_t pg, svuint64_t op">_u64</see> ANDV Dresult, Pg, Zop.D To be added. @@ -2790,7 +2790,7 @@ To be added. To be added. - svfloat64_t svcompact[_f64](svbool_t pg, svfloat64_t op) + svfloat64_t svcompact<see href="svbool_t pg, svfloat64_t op">_f64</see> COMPACT Zresult.D, Pg, Zop.D To be added. @@ -2820,7 +2820,7 @@ To be added. To be added. - svint32_t svcompact[_s32](svbool_t pg, svint32_t op) + svint32_t svcompact<see href="svbool_t pg, svint32_t op">_s32</see> COMPACT Zresult.S, Pg, Zop.S To be added. @@ -2850,7 +2850,7 @@ To be added. To be added. - svint64_t svcompact[_s64](svbool_t pg, svint64_t op) + svint64_t svcompact<see href="svbool_t pg, svint64_t op">_s64</see> COMPACT Zresult.D, Pg, Zop.D To be added. @@ -2880,7 +2880,7 @@ To be added. To be added. - svfloat32_t svcompact[_f32](svbool_t pg, svfloat32_t op) + svfloat32_t svcompact<see href="svbool_t pg, svfloat32_t op">_f32</see> COMPACT Zresult.S, Pg, Zop.S To be added. @@ -2910,7 +2910,7 @@ To be added. To be added. - svuint32_t svcompact[_u32](svbool_t pg, svuint32_t op) + svuint32_t svcompact<see href="svbool_t pg, svuint32_t op">_u32</see> COMPACT Zresult.S, Pg, Zop.S To be added. @@ -2940,7 +2940,7 @@ To be added. To be added. - svuint64_t svcompact[_u64](svbool_t pg, svuint64_t op) + svuint64_t svcompact<see href="svbool_t pg, svuint64_t op">_u64</see> COMPACT Zresult.D, Pg, Zop.D To be added. @@ -2970,7 +2970,7 @@ To be added. To be added. - svbool_t svcmpeq[_u8](svbool_t pg, svuint8_t op1, svuint8_t op2) + svbool_t svcmpeq<see href="svbool_t pg, svuint8_t op1, svuint8_t op2">_u8</see> CMPEQ Presult.B, Pg/Z, Zop1.B, Zop2.B To be added. @@ -3000,7 +3000,7 @@ To be added. To be added. - svbool_t svcmpeq[_f64](svbool_t pg, svfloat64_t op1, svfloat64_t op2) + svbool_t svcmpeq<see href="svbool_t pg, svfloat64_t op1, svfloat64_t op2">_f64</see> FCMEQ Presult.D, Pg/Z, Zop1.D, Zop2.D To be added. @@ -3030,7 +3030,7 @@ To be added. To be added. - svbool_t svcmpeq[_s16](svbool_t pg, svint16_t op1, svint16_t op2) + svbool_t svcmpeq<see href="svbool_t pg, svint16_t op1, svint16_t op2">_s16</see> CMPEQ Presult.H, Pg/Z, Zop1.H, Zop2.H To be added. @@ -3060,7 +3060,7 @@ To be added. To be added. - svbool_t svcmpeq_wide[_s16](svbool_t pg, svint16_t op1, svint64_t op2) + svbool_t svcmpeq_wide<see href="svbool_t pg, svint16_t op1, svint64_t op2">_s16</see> CMPEQ Presult.H, Pg/Z, Zop1.H, Zop2.D To be added. @@ -3090,7 +3090,7 @@ To be added. To be added. - svbool_t svcmpeq[_s32](svbool_t pg, svint32_t op1, svint32_t op2) + svbool_t svcmpeq<see href="svbool_t pg, svint32_t op1, svint32_t op2">_s32</see> CMPEQ Presult.S, Pg/Z, Zop1.S, Zop2.S To be added. @@ -3120,7 +3120,7 @@ To be added. To be added. - svbool_t svcmpeq_wide[_s32](svbool_t pg, svint32_t op1, svint64_t op2) + svbool_t svcmpeq_wide<see href="svbool_t pg, svint32_t op1, svint64_t op2">_s32</see> CMPEQ Presult.S, Pg/Z, Zop1.S, Zop2.D To be added. @@ -3150,7 +3150,7 @@ To be added. To be added. - svbool_t svcmpeq[_s64](svbool_t pg, svint64_t op1, svint64_t op2) + svbool_t svcmpeq<see href="svbool_t pg, svint64_t op1, svint64_t op2">_s64</see> CMPEQ Presult.D, Pg/Z, Zop1.D, Zop2.D To be added. @@ -3180,7 +3180,7 @@ To be added. To be added. - svbool_t svcmpeq_wide[_s8](svbool_t pg, svint8_t op1, svint64_t op2) + svbool_t svcmpeq_wide<see href="svbool_t pg, svint8_t op1, svint64_t op2">_s8</see> CMPEQ Presult.B, Pg/Z, Zop1.B, Zop2.D To be added. @@ -3210,7 +3210,7 @@ To be added. To be added. - svbool_t svcmpeq[_s8](svbool_t pg, svint8_t op1, svint8_t op2) + svbool_t svcmpeq<see href="svbool_t pg, svint8_t op1, svint8_t op2">_s8</see> CMPEQ Presult.B, Pg/Z, Zop1.B, Zop2.B To be added. @@ -3240,7 +3240,7 @@ To be added. To be added. - svbool_t svcmpeq[_f32](svbool_t pg, svfloat32_t op1, svfloat32_t op2) + svbool_t svcmpeq<see href="svbool_t pg, svfloat32_t op1, svfloat32_t op2">_f32</see> FCMEQ Presult.S, Pg/Z, Zop1.S, Zop2.S To be added. @@ -3270,7 +3270,7 @@ To be added. To be added. - svbool_t svcmpeq[_u16](svbool_t pg, svuint16_t op1, svuint16_t op2) + svbool_t svcmpeq<see href="svbool_t pg, svuint16_t op1, svuint16_t op2">_u16</see> CMPEQ Presult.H, Pg/Z, Zop1.H, Zop2.H To be added. @@ -3300,7 +3300,7 @@ To be added. To be added. - svbool_t svcmpeq[_u32](svbool_t pg, svuint32_t op1, svuint32_t op2) + svbool_t svcmpeq<see href="svbool_t pg, svuint32_t op1, svuint32_t op2">_u32</see> CMPEQ Presult.S, Pg/Z, Zop1.S, Zop2.S To be added. @@ -3330,7 +3330,7 @@ To be added. To be added. - svbool_t svcmpeq[_u64](svbool_t pg, svuint64_t op1, svuint64_t op2) + svbool_t svcmpeq<see href="svbool_t pg, svuint64_t op1, svuint64_t op2">_u64</see> CMPEQ Presult.D, Pg/Z, Zop1.D, Zop2.D To be added. @@ -3360,7 +3360,7 @@ To be added. To be added. - svbool_t svcmpgt[_u8](svbool_t pg, svuint8_t op1, svuint8_t op2) + svbool_t svcmpgt<see href="svbool_t pg, svuint8_t op1, svuint8_t op2">_u8</see> CMPHI Presult.B, Pg/Z, Zop1.B, Zop2.B To be added. @@ -3390,7 +3390,7 @@ To be added. To be added. - svbool_t svcmpgt_wide[_u8](svbool_t pg, svuint8_t op1, svuint64_t op2) + svbool_t svcmpgt_wide<see href="svbool_t pg, svuint8_t op1, svuint64_t op2">_u8</see> CMPHI Presult.B, Pg/Z, Zop1.B, Zop2.D To be added. @@ -3420,7 +3420,7 @@ To be added. To be added. - svbool_t svcmpgt[_f64](svbool_t pg, svfloat64_t op1, svfloat64_t op2) + svbool_t svcmpgt<see href="svbool_t pg, svfloat64_t op1, svfloat64_t op2">_f64</see> FCMGT Presult.D, Pg/Z, Zop1.D, Zop2.D To be added. @@ -3450,7 +3450,7 @@ To be added. To be added. - svbool_t svcmpgt[_s16](svbool_t pg, svint16_t op1, svint16_t op2) + svbool_t svcmpgt<see href="svbool_t pg, svint16_t op1, svint16_t op2">_s16</see> CMPGT Presult.H, Pg/Z, Zop1.H, Zop2.H To be added. @@ -3480,7 +3480,7 @@ To be added. To be added. - svbool_t svcmpgt_wide[_s16](svbool_t pg, svint16_t op1, svint64_t op2) + svbool_t svcmpgt_wide<see href="svbool_t pg, svint16_t op1, svint64_t op2">_s16</see> CMPGT Presult.H, Pg/Z, Zop1.H, Zop2.D To be added. @@ -3510,7 +3510,7 @@ To be added. To be added. - svbool_t svcmpgt[_s32](svbool_t pg, svint32_t op1, svint32_t op2) + svbool_t svcmpgt<see href="svbool_t pg, svint32_t op1, svint32_t op2">_s32</see> CMPGT Presult.S, Pg/Z, Zop1.S, Zop2.S To be added. @@ -3540,7 +3540,7 @@ To be added. To be added. - svbool_t svcmpgt_wide[_s32](svbool_t pg, svint32_t op1, svint64_t op2) + svbool_t svcmpgt_wide<see href="svbool_t pg, svint32_t op1, svint64_t op2">_s32</see> CMPGT Presult.S, Pg/Z, Zop1.S, Zop2.D To be added. @@ -3570,7 +3570,7 @@ To be added. To be added. - svbool_t svcmpgt[_s64](svbool_t pg, svint64_t op1, svint64_t op2) + svbool_t svcmpgt<see href="svbool_t pg, svint64_t op1, svint64_t op2">_s64</see> CMPGT Presult.D, Pg/Z, Zop1.D, Zop2.D To be added. @@ -3600,7 +3600,7 @@ To be added. To be added. - svbool_t svcmpgt_wide[_s8](svbool_t pg, svint8_t op1, svint64_t op2) + svbool_t svcmpgt_wide<see href="svbool_t pg, svint8_t op1, svint64_t op2">_s8</see> CMPGT Presult.B, Pg/Z, Zop1.B, Zop2.D To be added. @@ -3630,7 +3630,7 @@ To be added. To be added. - svbool_t svcmpgt[_s8](svbool_t pg, svint8_t op1, svint8_t op2) + svbool_t svcmpgt<see href="svbool_t pg, svint8_t op1, svint8_t op2">_s8</see> CMPGT Presult.B, Pg/Z, Zop1.B, Zop2.B To be added. @@ -3660,7 +3660,7 @@ To be added. To be added. - svbool_t svcmpgt[_f32](svbool_t pg, svfloat32_t op1, svfloat32_t op2) + svbool_t svcmpgt<see href="svbool_t pg, svfloat32_t op1, svfloat32_t op2">_f32</see> FCMGT Presult.S, Pg/Z, Zop1.S, Zop2.S To be added. @@ -3690,7 +3690,7 @@ To be added. To be added. - svbool_t svcmpgt[_u16](svbool_t pg, svuint16_t op1, svuint16_t op2) + svbool_t svcmpgt<see href="svbool_t pg, svuint16_t op1, svuint16_t op2">_u16</see> CMPHI Presult.H, Pg/Z, Zop1.H, Zop2.H To be added. @@ -3720,7 +3720,7 @@ To be added. To be added. - svbool_t svcmpgt_wide[_u16](svbool_t pg, svuint16_t op1, svuint64_t op2) + svbool_t svcmpgt_wide<see href="svbool_t pg, svuint16_t op1, svuint64_t op2">_u16</see> CMPHI Presult.H, Pg/Z, Zop1.H, Zop2.D To be added. @@ -3750,7 +3750,7 @@ To be added. To be added. - svbool_t svcmpgt[_u32](svbool_t pg, svuint32_t op1, svuint32_t op2) + svbool_t svcmpgt<see href="svbool_t pg, svuint32_t op1, svuint32_t op2">_u32</see> CMPHI Presult.S, Pg/Z, Zop1.S, Zop2.S To be added. @@ -3780,7 +3780,7 @@ To be added. To be added. - svbool_t svcmpgt_wide[_u32](svbool_t pg, svuint32_t op1, svuint64_t op2) + svbool_t svcmpgt_wide<see href="svbool_t pg, svuint32_t op1, svuint64_t op2">_u32</see> CMPHI Presult.S, Pg/Z, Zop1.S, Zop2.D To be added. @@ -3810,7 +3810,7 @@ To be added. To be added. - svbool_t svcmpgt[_u64](svbool_t pg, svuint64_t op1, svuint64_t op2) + svbool_t svcmpgt<see href="svbool_t pg, svuint64_t op1, svuint64_t op2">_u64</see> CMPHI Presult.D, Pg/Z, Zop1.D, Zop2.D To be added. @@ -3840,7 +3840,7 @@ To be added. To be added. - svbool_t svcmpge[_u8](svbool_t pg, svuint8_t op1, svuint8_t op2) + svbool_t svcmpge<see href="svbool_t pg, svuint8_t op1, svuint8_t op2">_u8</see> CMPHS Presult.B, Pg/Z, Zop1.B, Zop2.B To be added. @@ -3870,7 +3870,7 @@ To be added. To be added. - svbool_t svcmpge_wide[_u8](svbool_t pg, svuint8_t op1, svuint64_t op2) + svbool_t svcmpge_wide<see href="svbool_t pg, svuint8_t op1, svuint64_t op2">_u8</see> CMPHS Presult.B, Pg/Z, Zop1.B, Zop2.D To be added. @@ -3900,7 +3900,7 @@ To be added. To be added. - svbool_t svcmpge[_f64](svbool_t pg, svfloat64_t op1, svfloat64_t op2) + svbool_t svcmpge<see href="svbool_t pg, svfloat64_t op1, svfloat64_t op2">_f64</see> FCMGE Presult.D, Pg/Z, Zop1.D, Zop2.D To be added. @@ -3930,7 +3930,7 @@ To be added. To be added. - svbool_t svcmpge[_s16](svbool_t pg, svint16_t op1, svint16_t op2) + svbool_t svcmpge<see href="svbool_t pg, svint16_t op1, svint16_t op2">_s16</see> CMPGE Presult.H, Pg/Z, Zop1.H, Zop2.H To be added. @@ -3960,7 +3960,7 @@ To be added. To be added. - svbool_t svcmpge_wide[_s16](svbool_t pg, svint16_t op1, svint64_t op2) + svbool_t svcmpge_wide<see href="svbool_t pg, svint16_t op1, svint64_t op2">_s16</see> CMPGE Presult.H, Pg/Z, Zop1.H, Zop2.D To be added. @@ -3990,7 +3990,7 @@ To be added. To be added. - svbool_t svcmpge[_s32](svbool_t pg, svint32_t op1, svint32_t op2) + svbool_t svcmpge<see href="svbool_t pg, svint32_t op1, svint32_t op2">_s32</see> CMPGE Presult.S, Pg/Z, Zop1.S, Zop2.S To be added. @@ -4020,7 +4020,7 @@ To be added. To be added. - svbool_t svcmpge_wide[_s32](svbool_t pg, svint32_t op1, svint64_t op2) + svbool_t svcmpge_wide<see href="svbool_t pg, svint32_t op1, svint64_t op2">_s32</see> CMPGE Presult.S, Pg/Z, Zop1.S, Zop2.D To be added. @@ -4050,7 +4050,7 @@ To be added. To be added. - svbool_t svcmpge[_s64](svbool_t pg, svint64_t op1, svint64_t op2) + svbool_t svcmpge<see href="svbool_t pg, svint64_t op1, svint64_t op2">_s64</see> CMPGE Presult.D, Pg/Z, Zop1.D, Zop2.D To be added. @@ -4080,7 +4080,7 @@ To be added. To be added. - svbool_t svcmpge_wide[_s8](svbool_t pg, svint8_t op1, svint64_t op2) + svbool_t svcmpge_wide<see href="svbool_t pg, svint8_t op1, svint64_t op2">_s8</see> CMPGE Presult.B, Pg/Z, Zop1.B, Zop2.D To be added. @@ -4110,7 +4110,7 @@ To be added. To be added. - svbool_t svcmpge[_s8](svbool_t pg, svint8_t op1, svint8_t op2) + svbool_t svcmpge<see href="svbool_t pg, svint8_t op1, svint8_t op2">_s8</see> CMPGE Presult.B, Pg/Z, Zop1.B, Zop2.B To be added. @@ -4140,7 +4140,7 @@ To be added. To be added. - svbool_t svcmpge[_f32](svbool_t pg, svfloat32_t op1, svfloat32_t op2) + svbool_t svcmpge<see href="svbool_t pg, svfloat32_t op1, svfloat32_t op2">_f32</see> FCMGE Presult.S, Pg/Z, Zop1.S, Zop2.S To be added. @@ -4170,7 +4170,7 @@ To be added. To be added. - svbool_t svcmpge[_u16](svbool_t pg, svuint16_t op1, svuint16_t op2) + svbool_t svcmpge<see href="svbool_t pg, svuint16_t op1, svuint16_t op2">_u16</see> CMPHS Presult.H, Pg/Z, Zop1.H, Zop2.H To be added. @@ -4200,7 +4200,7 @@ To be added. To be added. - svbool_t svcmpge_wide[_u16](svbool_t pg, svuint16_t op1, svuint64_t op2) + svbool_t svcmpge_wide<see href="svbool_t pg, svuint16_t op1, svuint64_t op2">_u16</see> CMPHS Presult.H, Pg/Z, Zop1.H, Zop2.D To be added. @@ -4230,7 +4230,7 @@ To be added. To be added. - svbool_t svcmpge[_u32](svbool_t pg, svuint32_t op1, svuint32_t op2) + svbool_t svcmpge<see href="svbool_t pg, svuint32_t op1, svuint32_t op2">_u32</see> CMPHS Presult.S, Pg/Z, Zop1.S, Zop2.S To be added. @@ -4260,7 +4260,7 @@ To be added. To be added. - svbool_t svcmpge_wide[_u32](svbool_t pg, svuint32_t op1, svuint64_t op2) + svbool_t svcmpge_wide<see href="svbool_t pg, svuint32_t op1, svuint64_t op2">_u32</see> CMPHS Presult.S, Pg/Z, Zop1.S, Zop2.D To be added. @@ -4290,7 +4290,7 @@ To be added. To be added. - svbool_t svcmpge[_u64](svbool_t pg, svuint64_t op1, svuint64_t op2) + svbool_t svcmpge<see href="svbool_t pg, svuint64_t op1, svuint64_t op2">_u64</see> CMPHS Presult.D, Pg/Z, Zop1.D, Zop2.D To be added. @@ -4320,7 +4320,7 @@ To be added. To be added. - svbool_t svcmplt[_u8](svbool_t pg, svuint8_t op1, svuint8_t op2) + svbool_t svcmplt<see href="svbool_t pg, svuint8_t op1, svuint8_t op2">_u8</see> CMPHI Presult.B, Pg/Z, Zop2.B, Zop1.B To be added. @@ -4350,7 +4350,7 @@ To be added. To be added. - svbool_t svcmplt_wide[_u8](svbool_t pg, svuint8_t op1, svuint64_t op2) + svbool_t svcmplt_wide<see href="svbool_t pg, svuint8_t op1, svuint64_t op2">_u8</see> CMPLO Presult.B, Pg/Z, Zop1.B, Zop2.D To be added. @@ -4380,7 +4380,7 @@ To be added. To be added. - svbool_t svcmplt[_f64](svbool_t pg, svfloat64_t op1, svfloat64_t op2) + svbool_t svcmplt<see href="svbool_t pg, svfloat64_t op1, svfloat64_t op2">_f64</see> FCMGT Presult.D, Pg/Z, Zop2.D, Zop1.D To be added. @@ -4410,7 +4410,7 @@ To be added. To be added. - svbool_t svcmplt[_s16](svbool_t pg, svint16_t op1, svint16_t op2) + svbool_t svcmplt<see href="svbool_t pg, svint16_t op1, svint16_t op2">_s16</see> CMPGT Presult.H, Pg/Z, Zop2.H, Zop1.H To be added. @@ -4440,7 +4440,7 @@ To be added. To be added. - svbool_t svcmplt_wide[_s16](svbool_t pg, svint16_t op1, svint64_t op2) + svbool_t svcmplt_wide<see href="svbool_t pg, svint16_t op1, svint64_t op2">_s16</see> CMPLT Presult.H, Pg/Z, Zop1.H, Zop2.D To be added. @@ -4470,7 +4470,7 @@ To be added. To be added. - svbool_t svcmplt[_s32](svbool_t pg, svint32_t op1, svint32_t op2) + svbool_t svcmplt<see href="svbool_t pg, svint32_t op1, svint32_t op2">_s32</see> CMPGT Presult.S, Pg/Z, Zop2.S, Zop1.S To be added. @@ -4500,7 +4500,7 @@ To be added. To be added. - svbool_t svcmplt_wide[_s32](svbool_t pg, svint32_t op1, svint64_t op2) + svbool_t svcmplt_wide<see href="svbool_t pg, svint32_t op1, svint64_t op2">_s32</see> CMPLT Presult.S, Pg/Z, Zop1.S, Zop2.D To be added. @@ -4530,7 +4530,7 @@ To be added. To be added. - svbool_t svcmplt[_s64](svbool_t pg, svint64_t op1, svint64_t op2) + svbool_t svcmplt<see href="svbool_t pg, svint64_t op1, svint64_t op2">_s64</see> CMPGT Presult.D, Pg/Z, Zop2.D, Zop1.D To be added. @@ -4560,7 +4560,7 @@ To be added. To be added. - svbool_t svcmplt_wide[_s8](svbool_t pg, svint8_t op1, svint64_t op2) + svbool_t svcmplt_wide<see href="svbool_t pg, svint8_t op1, svint64_t op2">_s8</see> CMPLT Presult.B, Pg/Z, Zop1.B, Zop2.D To be added. @@ -4590,7 +4590,7 @@ To be added. To be added. - svbool_t svcmplt[_s8](svbool_t pg, svint8_t op1, svint8_t op2) + svbool_t svcmplt<see href="svbool_t pg, svint8_t op1, svint8_t op2">_s8</see> CMPGT Presult.B, Pg/Z, Zop2.B, Zop1.B To be added. @@ -4620,7 +4620,7 @@ To be added. To be added. - svbool_t svcmplt[_f32](svbool_t pg, svfloat32_t op1, svfloat32_t op2) + svbool_t svcmplt<see href="svbool_t pg, svfloat32_t op1, svfloat32_t op2">_f32</see> FCMGT Presult.S, Pg/Z, Zop2.S, Zop1.S To be added. @@ -4650,7 +4650,7 @@ To be added. To be added. - svbool_t svcmplt[_u16](svbool_t pg, svuint16_t op1, svuint16_t op2) + svbool_t svcmplt<see href="svbool_t pg, svuint16_t op1, svuint16_t op2">_u16</see> CMPHI Presult.H, Pg/Z, Zop2.H, Zop1.H To be added. @@ -4680,7 +4680,7 @@ To be added. To be added. - svbool_t svcmplt_wide[_u16](svbool_t pg, svuint16_t op1, svuint64_t op2) + svbool_t svcmplt_wide<see href="svbool_t pg, svuint16_t op1, svuint64_t op2">_u16</see> CMPLO Presult.H, Pg/Z, Zop1.H, Zop2.D To be added. @@ -4710,7 +4710,7 @@ To be added. To be added. - svbool_t svcmplt[_u32](svbool_t pg, svuint32_t op1, svuint32_t op2) + svbool_t svcmplt<see href="svbool_t pg, svuint32_t op1, svuint32_t op2">_u32</see> CMPHI Presult.S, Pg/Z, Zop2.S, Zop1.S To be added. @@ -4740,7 +4740,7 @@ To be added. To be added. - svbool_t svcmplt_wide[_u32](svbool_t pg, svuint32_t op1, svuint64_t op2) + svbool_t svcmplt_wide<see href="svbool_t pg, svuint32_t op1, svuint64_t op2">_u32</see> CMPLO Presult.S, Pg/Z, Zop1.S, Zop2.D To be added. @@ -4770,7 +4770,7 @@ To be added. To be added. - svbool_t svcmplt[_u64](svbool_t pg, svuint64_t op1, svuint64_t op2) + svbool_t svcmplt<see href="svbool_t pg, svuint64_t op1, svuint64_t op2">_u64</see> CMPHI Presult.D, Pg/Z, Zop2.D, Zop1.D To be added. @@ -4800,7 +4800,7 @@ To be added. To be added. - svbool_t svcmple[_u8](svbool_t pg, svuint8_t op1, svuint8_t op2) + svbool_t svcmple<see href="svbool_t pg, svuint8_t op1, svuint8_t op2">_u8</see> CMPHS Presult.B, Pg/Z, Zop2.B, Zop1.B To be added. @@ -4830,7 +4830,7 @@ To be added. To be added. - svbool_t svcmple_wide[_u8](svbool_t pg, svuint8_t op1, svuint64_t op2) + svbool_t svcmple_wide<see href="svbool_t pg, svuint8_t op1, svuint64_t op2">_u8</see> CMPLS Presult.B, Pg/Z, Zop1.B, Zop2.D To be added. @@ -4860,7 +4860,7 @@ To be added. To be added. - svbool_t svcmple[_f64](svbool_t pg, svfloat64_t op1, svfloat64_t op2) + svbool_t svcmple<see href="svbool_t pg, svfloat64_t op1, svfloat64_t op2">_f64</see> FCMGE Presult.D, Pg/Z, Zop2.D, Zop1.D To be added. @@ -4890,7 +4890,7 @@ To be added. To be added. - svbool_t svcmple[_s16](svbool_t pg, svint16_t op1, svint16_t op2) + svbool_t svcmple<see href="svbool_t pg, svint16_t op1, svint16_t op2">_s16</see> CMPGE Presult.H, Pg/Z, Zop2.H, Zop1.H To be added. @@ -4920,7 +4920,7 @@ To be added. To be added. - svbool_t svcmple_wide[_s16](svbool_t pg, svint16_t op1, svint64_t op2) + svbool_t svcmple_wide<see href="svbool_t pg, svint16_t op1, svint64_t op2">_s16</see> CMPLE Presult.H, Pg/Z, Zop1.H, Zop2.D To be added. @@ -4950,7 +4950,7 @@ To be added. To be added. - svbool_t svcmple[_s32](svbool_t pg, svint32_t op1, svint32_t op2) + svbool_t svcmple<see href="svbool_t pg, svint32_t op1, svint32_t op2">_s32</see> CMPGE Presult.S, Pg/Z, Zop2.S, Zop1.S To be added. @@ -4980,7 +4980,7 @@ To be added. To be added. - svbool_t svcmple_wide[_s32](svbool_t pg, svint32_t op1, svint64_t op2) + svbool_t svcmple_wide<see href="svbool_t pg, svint32_t op1, svint64_t op2">_s32</see> CMPLE Presult.S, Pg/Z, Zop1.S, Zop2.D To be added. @@ -5010,7 +5010,7 @@ To be added. To be added. - svbool_t svcmple[_s64](svbool_t pg, svint64_t op1, svint64_t op2) + svbool_t svcmple<see href="svbool_t pg, svint64_t op1, svint64_t op2">_s64</see> CMPGE Presult.D, Pg/Z, Zop2.D, Zop1.D To be added. @@ -5040,7 +5040,7 @@ To be added. To be added. - svbool_t svcmple_wide[_s8](svbool_t pg, svint8_t op1, svint64_t op2) + svbool_t svcmple_wide<see href="svbool_t pg, svint8_t op1, svint64_t op2">_s8</see> CMPLE Presult.B, Pg/Z, Zop1.B, Zop2.D To be added. @@ -5070,7 +5070,7 @@ To be added. To be added. - svbool_t svcmple[_s8](svbool_t pg, svint8_t op1, svint8_t op2) + svbool_t svcmple<see href="svbool_t pg, svint8_t op1, svint8_t op2">_s8</see> CMPGE Presult.B, Pg/Z, Zop2.B, Zop1.B To be added. @@ -5100,7 +5100,7 @@ To be added. To be added. - svbool_t svcmple[_f32](svbool_t pg, svfloat32_t op1, svfloat32_t op2) + svbool_t svcmple<see href="svbool_t pg, svfloat32_t op1, svfloat32_t op2">_f32</see> FCMGE Presult.S, Pg/Z, Zop2.S, Zop1.S To be added. @@ -5130,7 +5130,7 @@ To be added. To be added. - svbool_t svcmple[_u16](svbool_t pg, svuint16_t op1, svuint16_t op2) + svbool_t svcmple<see href="svbool_t pg, svuint16_t op1, svuint16_t op2">_u16</see> CMPHS Presult.H, Pg/Z, Zop2.H, Zop1.H To be added. @@ -5160,7 +5160,7 @@ To be added. To be added. - svbool_t svcmple_wide[_u16](svbool_t pg, svuint16_t op1, svuint64_t op2) + svbool_t svcmple_wide<see href="svbool_t pg, svuint16_t op1, svuint64_t op2">_u16</see> CMPLS Presult.H, Pg/Z, Zop1.H, Zop2.D To be added. @@ -5190,7 +5190,7 @@ To be added. To be added. - svbool_t svcmple[_u32](svbool_t pg, svuint32_t op1, svuint32_t op2) + svbool_t svcmple<see href="svbool_t pg, svuint32_t op1, svuint32_t op2">_u32</see> CMPHS Presult.S, Pg/Z, Zop2.S, Zop1.S To be added. @@ -5220,7 +5220,7 @@ To be added. To be added. - svbool_t svcmple_wide[_u32](svbool_t pg, svuint32_t op1, svuint64_t op2) + svbool_t svcmple_wide<see href="svbool_t pg, svuint32_t op1, svuint64_t op2">_u32</see> CMPLS Presult.S, Pg/Z, Zop1.S, Zop2.D To be added. @@ -5250,7 +5250,7 @@ To be added. To be added. - svbool_t svcmple[_u64](svbool_t pg, svuint64_t op1, svuint64_t op2) + svbool_t svcmple<see href="svbool_t pg, svuint64_t op1, svuint64_t op2">_u64</see> CMPHS Presult.D, Pg/Z, Zop2.D, Zop1.D To be added. @@ -5280,7 +5280,7 @@ To be added. To be added. - svbool_t svcmpne[_u8](svbool_t pg, svuint8_t op1, svuint8_t op2) + svbool_t svcmpne<see href="svbool_t pg, svuint8_t op1, svuint8_t op2">_u8</see> CMPNE Presult.B, Pg/Z, Zop1.B, Zop2.B To be added. @@ -5310,7 +5310,7 @@ To be added. To be added. - svbool_t svcmpne[_f64](svbool_t pg, svfloat64_t op1, svfloat64_t op2) + svbool_t svcmpne<see href="svbool_t pg, svfloat64_t op1, svfloat64_t op2">_f64</see> FCMNE Presult.D, Pg/Z, Zop1.D, Zop2.D To be added. @@ -5340,7 +5340,7 @@ To be added. To be added. - svbool_t svcmpne[_s16](svbool_t pg, svint16_t op1, svint16_t op2) + svbool_t svcmpne<see href="svbool_t pg, svint16_t op1, svint16_t op2">_s16</see> CMPNE Presult.H, Pg/Z, Zop1.H, Zop2.H To be added. @@ -5370,7 +5370,7 @@ To be added. To be added. - svbool_t svcmpne_wide[_s16](svbool_t pg, svint16_t op1, svint64_t op2) + svbool_t svcmpne_wide<see href="svbool_t pg, svint16_t op1, svint64_t op2">_s16</see> CMPNE Presult.H, Pg/Z, Zop1.H, Zop2.D To be added. @@ -5400,7 +5400,7 @@ To be added. To be added. - svbool_t svcmpne[_s32](svbool_t pg, svint32_t op1, svint32_t op2) + svbool_t svcmpne<see href="svbool_t pg, svint32_t op1, svint32_t op2">_s32</see> CMPNE Presult.S, Pg/Z, Zop1.S, Zop2.S To be added. @@ -5430,7 +5430,7 @@ To be added. To be added. - svbool_t svcmpne_wide[_s32](svbool_t pg, svint32_t op1, svint64_t op2) + svbool_t svcmpne_wide<see href="svbool_t pg, svint32_t op1, svint64_t op2">_s32</see> CMPNE Presult.S, Pg/Z, Zop1.S, Zop2.D To be added. @@ -5460,7 +5460,7 @@ To be added. To be added. - svbool_t svcmpne[_s64](svbool_t pg, svint64_t op1, svint64_t op2) + svbool_t svcmpne<see href="svbool_t pg, svint64_t op1, svint64_t op2">_s64</see> CMPNE Presult.D, Pg/Z, Zop1.D, Zop2.D To be added. @@ -5490,7 +5490,7 @@ To be added. To be added. - svbool_t svcmpne_wide[_s8](svbool_t pg, svint8_t op1, svint64_t op2) + svbool_t svcmpne_wide<see href="svbool_t pg, svint8_t op1, svint64_t op2">_s8</see> CMPNE Presult.B, Pg/Z, Zop1.B, Zop2.D To be added. @@ -5520,7 +5520,7 @@ To be added. To be added. - svbool_t svcmpne[_s8](svbool_t pg, svint8_t op1, svint8_t op2) + svbool_t svcmpne<see href="svbool_t pg, svint8_t op1, svint8_t op2">_s8</see> CMPNE Presult.B, Pg/Z, Zop1.B, Zop2.B To be added. @@ -5550,7 +5550,7 @@ To be added. To be added. - svbool_t svcmpne[_f32](svbool_t pg, svfloat32_t op1, svfloat32_t op2) + svbool_t svcmpne<see href="svbool_t pg, svfloat32_t op1, svfloat32_t op2">_f32</see> FCMNE Presult.S, Pg/Z, Zop1.S, Zop2.S To be added. @@ -5580,7 +5580,7 @@ To be added. To be added. - svbool_t svcmpne[_u16](svbool_t pg, svuint16_t op1, svuint16_t op2) + svbool_t svcmpne<see href="svbool_t pg, svuint16_t op1, svuint16_t op2">_u16</see> CMPNE Presult.H, Pg/Z, Zop1.H, Zop2.H To be added. @@ -5610,7 +5610,7 @@ To be added. To be added. - svbool_t svcmpne[_u32](svbool_t pg, svuint32_t op1, svuint32_t op2) + svbool_t svcmpne<see href="svbool_t pg, svuint32_t op1, svuint32_t op2">_u32</see> CMPNE Presult.S, Pg/Z, Zop1.S, Zop2.S To be added. @@ -5640,7 +5640,7 @@ To be added. To be added. - svbool_t svcmpne[_u64](svbool_t pg, svuint64_t op1, svuint64_t op2) + svbool_t svcmpne<see href="svbool_t pg, svuint64_t op1, svuint64_t op2">_u64</see> CMPNE Presult.D, Pg/Z, Zop1.D, Zop2.D To be added. @@ -5670,7 +5670,7 @@ To be added. To be added. - svbool_t svcmpuo[_f64](svbool_t pg, svfloat64_t op1, svfloat64_t op2) + svbool_t svcmpuo<see href="svbool_t pg, svfloat64_t op1, svfloat64_t op2">_f64</see> FCMUO Presult.D, Pg/Z, Zop1.D, Zop2.D To be added. @@ -5700,7 +5700,7 @@ To be added. To be added. - svbool_t svcmpuo[_f32](svbool_t pg, svfloat32_t op1, svfloat32_t op2) + svbool_t svcmpuo<see href="svbool_t pg, svfloat32_t op1, svfloat32_t op2">_f32</see> FCMUO Presult.S, Pg/Z, Zop1.S, Zop2.S To be added. @@ -6212,7 +6212,7 @@ To be added. To be added. - uint8_t svclasta[_n_u8](svbool_t pg, uint8_t fallback, svuint8_t data) + uint8_t svclasta<see href="svbool_t pg, uint8_t fallback, svuint8_t data">_n_u8</see> CLASTA Wtied, Pg, Wtied, Zdata.B To be added. @@ -6244,7 +6244,7 @@ To be added. To be added. - svuint8_t svclasta[_u8](svbool_t pg, svuint8_t fallback, svuint8_t data) + svuint8_t svclasta<see href="svbool_t pg, svuint8_t fallback, svuint8_t data">_u8</see> CLASTA Btied, Pg, Btied, Zdata.B To be added. @@ -6276,7 +6276,7 @@ To be added. To be added. - float64_t svclasta[_n_f64](svbool_t pg, float64_t fallback, svfloat64_t data) + float64_t svclasta<see href="svbool_t pg, float64_t fallback, svfloat64_t data">_n_f64</see> CLASTA Dtied, Pg, Dtied, Zdata.D To be added. @@ -6308,7 +6308,7 @@ To be added. To be added. - svfloat64_t svclasta[_f64](svbool_t pg, svfloat64_t fallback, svfloat64_t data) + svfloat64_t svclasta<see href="svbool_t pg, svfloat64_t fallback, svfloat64_t data">_f64</see> CLASTA Dtied, Pg, Dtied, Zdata.D To be added. @@ -6340,7 +6340,7 @@ To be added. To be added. - int16_t svclasta[_n_s16](svbool_t pg, int16_t fallback, svint16_t data) + int16_t svclasta<see href="svbool_t pg, int16_t fallback, svint16_t data">_n_s16</see> CLASTA Wtied, Pg, Wtied, Zdata.H To be added. @@ -6372,7 +6372,7 @@ To be added. To be added. - svint16_t svclasta[_s16](svbool_t pg, svint16_t fallback, svint16_t data) + svint16_t svclasta<see href="svbool_t pg, svint16_t fallback, svint16_t data">_s16</see> CLASTA Htied, Pg, Htied, Zdata.H To be added. @@ -6404,7 +6404,7 @@ To be added. To be added. - int32_t svclasta[_n_s32](svbool_t pg, int32_t fallback, svint32_t data) + int32_t svclasta<see href="svbool_t pg, int32_t fallback, svint32_t data">_n_s32</see> CLASTA Wtied, Pg, Wtied, Zdata.S To be added. @@ -6436,7 +6436,7 @@ To be added. To be added. - svint32_t svclasta[_s32](svbool_t pg, svint32_t fallback, svint32_t data) + svint32_t svclasta<see href="svbool_t pg, svint32_t fallback, svint32_t data">_s32</see> CLASTA Stied, Pg, Stied, Zdata.S To be added. @@ -6468,7 +6468,7 @@ To be added. To be added. - int64_t svclasta[_n_s64](svbool_t pg, int64_t fallback, svint64_t data) + int64_t svclasta<see href="svbool_t pg, int64_t fallback, svint64_t data">_n_s64</see> CLASTA Xtied, Pg, Xtied, Zdata.D To be added. @@ -6500,7 +6500,7 @@ To be added. To be added. - svint64_t svclasta[_s64](svbool_t pg, svint64_t fallback, svint64_t data) + svint64_t svclasta<see href="svbool_t pg, svint64_t fallback, svint64_t data">_s64</see> CLASTA Dtied, Pg, Dtied, Zdata.D To be added. @@ -6532,7 +6532,7 @@ To be added. To be added. - svint8_t svclasta[_s8](svbool_t pg, svint8_t fallback, svint8_t data) + svint8_t svclasta<see href="svbool_t pg, svint8_t fallback, svint8_t data">_s8</see> CLASTA Btied, Pg, Btied, Zdata.B To be added. @@ -6564,7 +6564,7 @@ To be added. To be added. - int8_t svclasta[_n_s8](svbool_t pg, int8_t fallback, svint8_t data) + int8_t svclasta<see href="svbool_t pg, int8_t fallback, svint8_t data">_n_s8</see> CLASTA Wtied, Pg, Wtied, Zdata.B To be added. @@ -6596,7 +6596,7 @@ To be added. To be added. - svfloat32_t svclasta[_f32](svbool_t pg, svfloat32_t fallback, svfloat32_t data) + svfloat32_t svclasta<see href="svbool_t pg, svfloat32_t fallback, svfloat32_t data">_f32</see> CLASTA Stied, Pg, Stied, Zdata.S To be added. @@ -6628,7 +6628,7 @@ To be added. To be added. - float32_t svclasta[_n_f32](svbool_t pg, float32_t fallback, svfloat32_t data) + float32_t svclasta<see href="svbool_t pg, float32_t fallback, svfloat32_t data">_n_f32</see> CLASTA Stied, Pg, Stied, Zdata.S To be added. @@ -6660,7 +6660,7 @@ To be added. To be added. - svuint16_t svclasta[_u16](svbool_t pg, svuint16_t fallback, svuint16_t data) + svuint16_t svclasta<see href="svbool_t pg, svuint16_t fallback, svuint16_t data">_u16</see> CLASTA Htied, Pg, Htied, Zdata.H To be added. @@ -6692,7 +6692,7 @@ To be added. To be added. - uint16_t svclasta[_n_u16](svbool_t pg, uint16_t fallback, svuint16_t data) + uint16_t svclasta<see href="svbool_t pg, uint16_t fallback, svuint16_t data">_n_u16</see> CLASTA Wtied, Pg, Wtied, Zdata.H To be added. @@ -6724,7 +6724,7 @@ To be added. To be added. - svuint32_t svclasta[_u32](svbool_t pg, svuint32_t fallback, svuint32_t data) + svuint32_t svclasta<see href="svbool_t pg, svuint32_t fallback, svuint32_t data">_u32</see> CLASTA Stied, Pg, Stied, Zdata.S To be added. @@ -6756,7 +6756,7 @@ To be added. To be added. - uint32_t svclasta[_n_u32](svbool_t pg, uint32_t fallback, svuint32_t data) + uint32_t svclasta<see href="svbool_t pg, uint32_t fallback, svuint32_t data">_n_u32</see> CLASTA Wtied, Pg, Wtied, Zdata.S To be added. @@ -6788,7 +6788,7 @@ To be added. To be added. - svuint64_t svclasta[_u64](svbool_t pg, svuint64_t fallback, svuint64_t data) + svuint64_t svclasta<see href="svbool_t pg, svuint64_t fallback, svuint64_t data">_u64</see> CLASTA Dtied, Pg, Dtied, Zdata.D To be added. @@ -6820,7 +6820,7 @@ To be added. To be added. - uint64_t svclasta[_n_u64](svbool_t pg, uint64_t fallback, svuint64_t data) + uint64_t svclasta<see href="svbool_t pg, uint64_t fallback, svuint64_t data">_n_u64</see> CLASTA Xtied, Pg, Xtied, Zdata.D To be added. @@ -6852,7 +6852,7 @@ To be added. To be added. - svuint8_t svclasta[_u8](svbool_t pg, svuint8_t fallback, svuint8_t data) + svuint8_t svclasta<see href="svbool_t pg, svuint8_t fallback, svuint8_t data">_u8</see> CLASTA Ztied.B, Pg, Ztied.B, Zdata.B To be added. @@ -6884,7 +6884,7 @@ To be added. To be added. - svfloat64_t svclasta[_f64](svbool_t pg, svfloat64_t fallback, svfloat64_t data) + svfloat64_t svclasta<see href="svbool_t pg, svfloat64_t fallback, svfloat64_t data">_f64</see> CLASTA Ztied.D, Pg, Ztied.D, Zdata.D To be added. @@ -6916,7 +6916,7 @@ To be added. To be added. - svint16_t svclasta[_s16](svbool_t pg, svint16_t fallback, svint16_t data) + svint16_t svclasta<see href="svbool_t pg, svint16_t fallback, svint16_t data">_s16</see> CLASTA Ztied.H, Pg, Ztied.H, Zdata.H To be added. @@ -6948,7 +6948,7 @@ To be added. To be added. - svint32_t svclasta[_s32](svbool_t pg, svint32_t fallback, svint32_t data) + svint32_t svclasta<see href="svbool_t pg, svint32_t fallback, svint32_t data">_s32</see> CLASTA Ztied.S, Pg, Ztied.S, Zdata.S To be added. @@ -6980,7 +6980,7 @@ To be added. To be added. - svint64_t svclasta[_s64](svbool_t pg, svint64_t fallback, svint64_t data) + svint64_t svclasta<see href="svbool_t pg, svint64_t fallback, svint64_t data">_s64</see> CLASTA Ztied.D, Pg, Ztied.D, Zdata.D To be added. @@ -7012,7 +7012,7 @@ To be added. To be added. - svint8_t svclasta[_s8](svbool_t pg, svint8_t fallback, svint8_t data) + svint8_t svclasta<see href="svbool_t pg, svint8_t fallback, svint8_t data">_s8</see> CLASTA Ztied.B, Pg, Ztied.B, Zdata.B To be added. @@ -7044,7 +7044,7 @@ To be added. To be added. - svfloat32_t svclasta[_f32](svbool_t pg, svfloat32_t fallback, svfloat32_t data) + svfloat32_t svclasta<see href="svbool_t pg, svfloat32_t fallback, svfloat32_t data">_f32</see> CLASTA Ztied.S, Pg, Ztied.S, Zdata.S To be added. @@ -7076,7 +7076,7 @@ To be added. To be added. - svuint16_t svclasta[_u16](svbool_t pg, svuint16_t fallback, svuint16_t data) + svuint16_t svclasta<see href="svbool_t pg, svuint16_t fallback, svuint16_t data">_u16</see> CLASTA Ztied.H, Pg, Ztied.H, Zdata.H To be added. @@ -7108,7 +7108,7 @@ To be added. To be added. - svuint32_t svclasta[_u32](svbool_t pg, svuint32_t fallback, svuint32_t data) + svuint32_t svclasta<see href="svbool_t pg, svuint32_t fallback, svuint32_t data">_u32</see> CLASTA Ztied.S, Pg, Ztied.S, Zdata.S To be added. @@ -7140,7 +7140,7 @@ To be added. To be added. - svuint64_t svclasta[_u64](svbool_t pg, svuint64_t fallback, svuint64_t data) + svuint64_t svclasta<see href="svbool_t pg, svuint64_t fallback, svuint64_t data">_u64</see> CLASTA Ztied.D, Pg, Ztied.D, Zdata.D To be added. @@ -7172,7 +7172,7 @@ To be added. To be added. - uint8_t svclastb[_n_u8](svbool_t pg, uint8_t fallback, svuint8_t data) + uint8_t svclastb<see href="svbool_t pg, uint8_t fallback, svuint8_t data">_n_u8</see> CLASTB Wtied, Pg, Wtied, Zdata.B To be added. @@ -7204,7 +7204,7 @@ To be added. To be added. - svuint8_t svclastb[_u8](svbool_t pg, svuint8_t fallback, svuint8_t data) + svuint8_t svclastb<see href="svbool_t pg, svuint8_t fallback, svuint8_t data">_u8</see> CLASTB Btied, Pg, Btied, Zdata.B To be added. @@ -7236,7 +7236,7 @@ To be added. To be added. - float64_t svclastb[_n_f64](svbool_t pg, float64_t fallback, svfloat64_t data) + float64_t svclastb<see href="svbool_t pg, float64_t fallback, svfloat64_t data">_n_f64</see> CLASTB Dtied, Pg, Dtied, Zdata.D To be added. @@ -7268,7 +7268,7 @@ To be added. To be added. - svfloat64_t svclastb[_f64](svbool_t pg, svfloat64_t fallback, svfloat64_t data) + svfloat64_t svclastb<see href="svbool_t pg, svfloat64_t fallback, svfloat64_t data">_f64</see> CLASTB Dtied, Pg, Dtied, Zdata.D To be added. @@ -7300,7 +7300,7 @@ To be added. To be added. - int16_t svclastb[_n_s16](svbool_t pg, int16_t fallback, svint16_t data) + int16_t svclastb<see href="svbool_t pg, int16_t fallback, svint16_t data">_n_s16</see> CLASTB Wtied, Pg, Wtied, Zdata.H To be added. @@ -7332,7 +7332,7 @@ To be added. To be added. - svint16_t svclastb[_s16](svbool_t pg, svint16_t fallback, svint16_t data) + svint16_t svclastb<see href="svbool_t pg, svint16_t fallback, svint16_t data">_s16</see> CLASTB Htied, Pg, Htied, Zdata.H To be added. @@ -7364,7 +7364,7 @@ To be added. To be added. - int32_t svclastb[_n_s32](svbool_t pg, int32_t fallback, svint32_t data) + int32_t svclastb<see href="svbool_t pg, int32_t fallback, svint32_t data">_n_s32</see> CLASTB Wtied, Pg, Wtied, Zdata.S To be added. @@ -7396,7 +7396,7 @@ To be added. To be added. - svint32_t svclastb[_s32](svbool_t pg, svint32_t fallback, svint32_t data) + svint32_t svclastb<see href="svbool_t pg, svint32_t fallback, svint32_t data">_s32</see> CLASTB Stied, Pg, Stied, Zdata.S To be added. @@ -7428,7 +7428,7 @@ To be added. To be added. - int64_t svclastb[_n_s64](svbool_t pg, int64_t fallback, svint64_t data) + int64_t svclastb<see href="svbool_t pg, int64_t fallback, svint64_t data">_n_s64</see> CLASTB Xtied, Pg, Xtied, Zdata.D To be added. @@ -7460,7 +7460,7 @@ To be added. To be added. - svint64_t svclastb[_s64](svbool_t pg, svint64_t fallback, svint64_t data) + svint64_t svclastb<see href="svbool_t pg, svint64_t fallback, svint64_t data">_s64</see> CLASTB Dtied, Pg, Dtied, Zdata.D To be added. @@ -7492,7 +7492,7 @@ To be added. To be added. - svint8_t svclastb[_s8](svbool_t pg, svint8_t fallback, svint8_t data) + svint8_t svclastb<see href="svbool_t pg, svint8_t fallback, svint8_t data">_s8</see> CLASTB Btied, Pg, Btied, Zdata.B To be added. @@ -7524,7 +7524,7 @@ To be added. To be added. - int8_t svclastb[_n_s8](svbool_t pg, int8_t fallback, svint8_t data) + int8_t svclastb<see href="svbool_t pg, int8_t fallback, svint8_t data">_n_s8</see> CLASTB Wtied, Pg, Wtied, Zdata.B To be added. @@ -7556,7 +7556,7 @@ To be added. To be added. - svfloat32_t svclastb[_f32](svbool_t pg, svfloat32_t fallback, svfloat32_t data) + svfloat32_t svclastb<see href="svbool_t pg, svfloat32_t fallback, svfloat32_t data">_f32</see> CLASTB Stied, Pg, Stied, Zdata.S To be added. @@ -7588,7 +7588,7 @@ To be added. To be added. - float32_t svclastb[_n_f32](svbool_t pg, float32_t fallback, svfloat32_t data) + float32_t svclastb<see href="svbool_t pg, float32_t fallback, svfloat32_t data">_n_f32</see> CLASTB Stied, Pg, Stied, Zdata.S To be added. @@ -7620,7 +7620,7 @@ To be added. To be added. - svuint16_t svclastb[_u16](svbool_t pg, svuint16_t fallback, svuint16_t data) + svuint16_t svclastb<see href="svbool_t pg, svuint16_t fallback, svuint16_t data">_u16</see> CLASTB Htied, Pg, Htied, Zdata.H To be added. @@ -7652,7 +7652,7 @@ To be added. To be added. - uint16_t svclastb[_n_u16](svbool_t pg, uint16_t fallback, svuint16_t data) + uint16_t svclastb<see href="svbool_t pg, uint16_t fallback, svuint16_t data">_n_u16</see> CLASTB Wtied, Pg, Wtied, Zdata.H To be added. @@ -7684,7 +7684,7 @@ To be added. To be added. - svuint32_t svclastb[_u32](svbool_t pg, svuint32_t fallback, svuint32_t data) + svuint32_t svclastb<see href="svbool_t pg, svuint32_t fallback, svuint32_t data">_u32</see> CLASTB Stied, Pg, Stied, Zdata.S To be added. @@ -7716,7 +7716,7 @@ To be added. To be added. - uint32_t svclastb[_n_u32](svbool_t pg, uint32_t fallback, svuint32_t data) + uint32_t svclastb<see href="svbool_t pg, uint32_t fallback, svuint32_t data">_n_u32</see> CLASTB Wtied, Pg, Wtied, Zdata.S To be added. @@ -7748,7 +7748,7 @@ To be added. To be added. - svuint64_t svclastb[_u64](svbool_t pg, svuint64_t fallback, svuint64_t data) + svuint64_t svclastb<see href="svbool_t pg, svuint64_t fallback, svuint64_t data">_u64</see> CLASTB Dtied, Pg, Dtied, Zdata.D To be added. @@ -7780,7 +7780,7 @@ To be added. To be added. - uint64_t svclastb[_n_u64](svbool_t pg, uint64_t fallback, svuint64_t data) + uint64_t svclastb<see href="svbool_t pg, uint64_t fallback, svuint64_t data">_n_u64</see> CLASTB Xtied, Pg, Xtied, Zdata.D To be added. @@ -7812,7 +7812,7 @@ To be added. To be added. - svuint8_t svclastb[_u8](svbool_t pg, svuint8_t fallback, svuint8_t data) + svuint8_t svclastb<see href="svbool_t pg, svuint8_t fallback, svuint8_t data">_u8</see> CLASTB Ztied.B, Pg, Ztied.B, Zdata.B To be added. @@ -7844,7 +7844,7 @@ To be added. To be added. - svfloat64_t svclastb[_f64](svbool_t pg, svfloat64_t fallback, svfloat64_t data) + svfloat64_t svclastb<see href="svbool_t pg, svfloat64_t fallback, svfloat64_t data">_f64</see> CLASTB Ztied.D, Pg, Ztied.D, Zdata.D To be added. @@ -7876,7 +7876,7 @@ To be added. To be added. - svint16_t svclastb[_s16](svbool_t pg, svint16_t fallback, svint16_t data) + svint16_t svclastb<see href="svbool_t pg, svint16_t fallback, svint16_t data">_s16</see> CLASTB Ztied.H, Pg, Ztied.H, Zdata.H To be added. @@ -7908,7 +7908,7 @@ To be added. To be added. - svint32_t svclastb[_s32](svbool_t pg, svint32_t fallback, svint32_t data) + svint32_t svclastb<see href="svbool_t pg, svint32_t fallback, svint32_t data">_s32</see> CLASTB Ztied.S, Pg, Ztied.S, Zdata.S To be added. @@ -7940,7 +7940,7 @@ To be added. To be added. - svint64_t svclastb[_s64](svbool_t pg, svint64_t fallback, svint64_t data) + svint64_t svclastb<see href="svbool_t pg, svint64_t fallback, svint64_t data">_s64</see> CLASTB Ztied.D, Pg, Ztied.D, Zdata.D To be added. @@ -7972,7 +7972,7 @@ To be added. To be added. - svint8_t svclastb[_s8](svbool_t pg, svint8_t fallback, svint8_t data) + svint8_t svclastb<see href="svbool_t pg, svint8_t fallback, svint8_t data">_s8</see> CLASTB Ztied.B, Pg, Ztied.B, Zdata.B To be added. @@ -8004,7 +8004,7 @@ To be added. To be added. - svfloat32_t svclastb[_f32](svbool_t pg, svfloat32_t fallback, svfloat32_t data) + svfloat32_t svclastb<see href="svbool_t pg, svfloat32_t fallback, svfloat32_t data">_f32</see> CLASTB Ztied.S, Pg, Ztied.S, Zdata.S To be added. @@ -8036,7 +8036,7 @@ To be added. To be added. - svuint16_t svclastb[_u16](svbool_t pg, svuint16_t fallback, svuint16_t data) + svuint16_t svclastb<see href="svbool_t pg, svuint16_t fallback, svuint16_t data">_u16</see> CLASTB Ztied.H, Pg, Ztied.H, Zdata.H To be added. @@ -8068,7 +8068,7 @@ To be added. To be added. - svuint32_t svclastb[_u32](svbool_t pg, svuint32_t fallback, svuint32_t data) + svuint32_t svclastb<see href="svbool_t pg, svuint32_t fallback, svuint32_t data">_u32</see> CLASTB Ztied.S, Pg, Ztied.S, Zdata.S To be added. @@ -8100,7 +8100,7 @@ To be added. To be added. - svuint64_t svclastb[_u64](svbool_t pg, svuint64_t fallback, svuint64_t data) + svuint64_t svclastb<see href="svbool_t pg, svuint64_t fallback, svuint64_t data">_u64</see> CLASTB Ztied.D, Pg, Ztied.D, Zdata.D To be added. @@ -8132,8 +8132,8 @@ To be added. To be added. - svuint8_t svsel[_u8](svbool_t pg, svuint8_t op1, svuint8_t op2) - svbool_t svsel[_b](svbool_t pg, svbool_t op1, svbool_t op2) + svuint8_t svsel<see href="svbool_t pg, svuint8_t op1, svuint8_t op2">_u8</see> + svbool_t svsel<see href="svbool_t pg, svbool_t op1, svbool_t op2">_b</see> SEL Zresult.B, Pg, Zop1.B, Zop2.B To be added. @@ -8165,7 +8165,7 @@ To be added. To be added. - svfloat64_t svsel[_f64](svbool_t pg, svfloat64_t op1, svfloat64_t op2) + svfloat64_t svsel<see href="svbool_t pg, svfloat64_t op1, svfloat64_t op2">_f64</see> SEL Zresult.D, Pg, Zop1.D, Zop2.D To be added. @@ -8197,8 +8197,8 @@ To be added. To be added. - svint16_t svsel[_s16](svbool_t pg, svint16_t op1, svint16_t op2) - svbool_t svsel[_b](svbool_t pg, svbool_t op1, svbool_t op2) + svint16_t svsel<see href="svbool_t pg, svint16_t op1, svint16_t op2">_s16</see> + svbool_t svsel<see href="svbool_t pg, svbool_t op1, svbool_t op2">_b</see> SEL Zresult.H, Pg, Zop1.H, Zop2.H To be added. @@ -8230,8 +8230,8 @@ To be added. To be added. - svint32_t svsel[_s32](svbool_t pg, svint32_t op1, svint32_t op2) - svbool_t svsel[_b](svbool_t pg, svbool_t op1, svbool_t op2) + svint32_t svsel<see href="svbool_t pg, svint32_t op1, svint32_t op2">_s32</see> + svbool_t svsel<see href="svbool_t pg, svbool_t op1, svbool_t op2">_b</see> SEL Zresult.S, Pg, Zop1.S, Zop2.S To be added. @@ -8263,8 +8263,8 @@ To be added. To be added. - svint64_t svsel[_s64](svbool_t pg, svint64_t op1, svint64_t op2) - svbool_t svsel[_b](svbool_t pg, svbool_t op1, svbool_t op2) + svint64_t svsel<see href="svbool_t pg, svint64_t op1, svint64_t op2">_s64</see> + svbool_t svsel<see href="svbool_t pg, svbool_t op1, svbool_t op2">_b</see> SEL Zresult.D, Pg, Zop1.D, Zop2.D To be added. @@ -8296,8 +8296,8 @@ To be added. To be added. - svint8_t svsel[_s8](svbool_t pg, svint8_t op1, svint8_t op2) - svbool_t svsel[_b](svbool_t pg, svbool_t op1, svbool_t op2) + svint8_t svsel<see href="svbool_t pg, svint8_t op1, svint8_t op2">_s8</see> + svbool_t svsel<see href="svbool_t pg, svbool_t op1, svbool_t op2">_b</see> SEL Zresult.B, Pg, Zop1.B, Zop2.B To be added. @@ -8329,7 +8329,7 @@ To be added. To be added. - svfloat32_t svsel[_f32](svbool_t pg, svfloat32_t op1, svfloat32_t op2) + svfloat32_t svsel<see href="svbool_t pg, svfloat32_t op1, svfloat32_t op2">_f32</see> SEL Zresult.S, Pg, Zop1.S, Zop2.S To be added. @@ -8361,8 +8361,8 @@ To be added. To be added. - svuint16_t svsel[_u16](svbool_t pg, svuint16_t op1, svuint16_t op2) - svbool_t svsel[_b](svbool_t pg, svbool_t op1, svbool_t op2) + svuint16_t svsel<see href="svbool_t pg, svuint16_t op1, svuint16_t op2">_u16</see> + svbool_t svsel<see href="svbool_t pg, svbool_t op1, svbool_t op2">_b</see> SEL Zresult.H, Pg, Zop1.H, Zop2.H To be added. @@ -8394,8 +8394,8 @@ To be added. To be added. - svuint32_t svsel[_u32](svbool_t pg, svuint32_t op1, svuint32_t op2) - svbool_t svsel[_b](svbool_t pg, svbool_t op1, svbool_t op2) + svuint32_t svsel<see href="svbool_t pg, svuint32_t op1, svuint32_t op2">_u32</see> + svbool_t svsel<see href="svbool_t pg, svbool_t op1, svbool_t op2">_b</see> SEL Zresult.S, Pg, Zop1.S, Zop2.S To be added. @@ -8427,8 +8427,8 @@ To be added. To be added. - svuint64_t svsel[_u64](svbool_t pg, svuint64_t op1, svuint64_t op2) - svbool_t svsel[_b](svbool_t pg, svbool_t op1, svbool_t op2) + svuint64_t svsel<see href="svbool_t pg, svuint64_t op1, svuint64_t op2">_u64</see> + svbool_t svsel<see href="svbool_t pg, svbool_t op1, svbool_t op2">_b</see> SEL Zresult.D, Pg, Zop1.D, Zop2.D To be added. @@ -10361,7 +10361,7 @@ - svbool_t svpfalse[_b]() + svbool_t svpfalse<see href="">_b</see> PFALSE Presult.B To be added. @@ -10386,7 +10386,7 @@ - svbool_t svpfalse[_b]() + svbool_t svpfalse<see href="">_b</see> PFALSE Presult.B To be added. @@ -10411,7 +10411,7 @@ - svbool_t svpfalse[_b]() + svbool_t svpfalse<see href="">_b</see> PFALSE Presult.B To be added. @@ -10436,7 +10436,7 @@ - svbool_t svpfalse[_b]() + svbool_t svpfalse<see href="">_b</see> PFALSE Presult.B To be added. @@ -10461,7 +10461,7 @@ - svbool_t svpfalse[_b]() + svbool_t svpfalse<see href="">_b</see> PFALSE Presult.B To be added. @@ -10486,7 +10486,7 @@ - svbool_t svpfalse[_b]() + svbool_t svpfalse<see href="">_b</see> PFALSE Presult.B To be added. @@ -10511,7 +10511,7 @@ - svbool_t svpfalse[_b]() + svbool_t svpfalse<see href="">_b</see> PFALSE Presult.B To be added. @@ -10536,7 +10536,7 @@ - svbool_t svpfalse[_b]() + svbool_t svpfalse<see href="">_b</see> PFALSE Presult.B To be added. @@ -10561,7 +10561,7 @@ - svbool_t svpfalse[_b]() + svbool_t svpfalse<see href="">_b</see> PFALSE Presult.B To be added. @@ -10586,7 +10586,7 @@ - svbool_t svpfalse[_b]() + svbool_t svpfalse<see href="">_b</see> PFALSE Presult.B To be added. @@ -10616,7 +10616,7 @@ To be added. To be added. - svbool_t svpfirst[_b](svbool_t pg, svbool_t op) + svbool_t svpfirst<see href="svbool_t pg, svbool_t op">_b</see> PFIRST Ptied.B, Pg, Ptied.B To be added. @@ -10646,7 +10646,7 @@ To be added. To be added. - svbool_t svpfirst[_b](svbool_t pg, svbool_t op) + svbool_t svpfirst<see href="svbool_t pg, svbool_t op">_b</see> PFIRST Ptied.B, Pg, Ptied.B To be added. @@ -10676,7 +10676,7 @@ To be added. To be added. - svbool_t svpfirst[_b](svbool_t pg, svbool_t op) + svbool_t svpfirst<see href="svbool_t pg, svbool_t op">_b</see> PFIRST Ptied.B, Pg, Ptied.B To be added. @@ -10706,7 +10706,7 @@ To be added. To be added. - svbool_t svpfirst[_b](svbool_t pg, svbool_t op) + svbool_t svpfirst<see href="svbool_t pg, svbool_t op">_b</see> PFIRST Ptied.B, Pg, Ptied.B To be added. @@ -10736,7 +10736,7 @@ To be added. To be added. - svbool_t svpfirst[_b](svbool_t pg, svbool_t op) + svbool_t svpfirst<see href="svbool_t pg, svbool_t op">_b</see> PFIRST Ptied.B, Pg, Ptied.B To be added. @@ -10766,7 +10766,7 @@ To be added. To be added. - svbool_t svpfirst[_b](svbool_t pg, svbool_t op) + svbool_t svpfirst<see href="svbool_t pg, svbool_t op">_b</see> PFIRST Ptied.B, Pg, Ptied.B To be added. @@ -10796,7 +10796,7 @@ To be added. To be added. - svbool_t svpfirst[_b](svbool_t pg, svbool_t op) + svbool_t svpfirst<see href="svbool_t pg, svbool_t op">_b</see> PFIRST Ptied.B, Pg, Ptied.B To be added. @@ -10826,7 +10826,7 @@ To be added. To be added. - svbool_t svpfirst[_b](svbool_t pg, svbool_t op) + svbool_t svpfirst<see href="svbool_t pg, svbool_t op">_b</see> PFIRST Ptied.B, Pg, Ptied.B To be added. @@ -11316,7 +11316,7 @@ To be added. To be added. - svbool_t svwhilelt_b16[_s32](int32_t op1, int32_t op2) + svbool_t svwhilelt_b16<see href="int32_t op1, int32_t op2">_s32</see> WHILELT Presult.H, Wop1, Wop2 To be added. @@ -11346,7 +11346,7 @@ To be added. To be added. - svbool_t svwhilelt_b16[_s64](int64_t op1, int64_t op2) + svbool_t svwhilelt_b16<see href="int64_t op1, int64_t op2">_s64</see> WHILELT Presult.H, Xop1, Xop2 To be added. @@ -11376,7 +11376,7 @@ To be added. To be added. - svbool_t svwhilelt_b16[_u32](uint32_t op1, uint32_t op2) + svbool_t svwhilelt_b16<see href="uint32_t op1, uint32_t op2">_u32</see> WHILELO Presult.H, Wop1, Wop2 To be added. @@ -11406,7 +11406,7 @@ To be added. To be added. - svbool_t svwhilelt_b16[_u64](uint64_t op1, uint64_t op2) + svbool_t svwhilelt_b16<see href="uint64_t op1, uint64_t op2">_u64</see> WHILELO Presult.H, Xop1, Xop2 To be added. @@ -11436,7 +11436,7 @@ To be added. To be added. - svbool_t svwhilelt_b32[_s32](int32_t op1, int32_t op2) + svbool_t svwhilelt_b32<see href="int32_t op1, int32_t op2">_s32</see> WHILELT Presult.S, Wop1, Wop2 To be added. @@ -11466,7 +11466,7 @@ To be added. To be added. - svbool_t svwhilelt_b32[_s64](int64_t op1, int64_t op2) + svbool_t svwhilelt_b32<see href="int64_t op1, int64_t op2">_s64</see> WHILELT Presult.S, Xop1, Xop2 To be added. @@ -11496,7 +11496,7 @@ To be added. To be added. - svbool_t svwhilelt_b32[_u32](uint32_t op1, uint32_t op2) + svbool_t svwhilelt_b32<see href="uint32_t op1, uint32_t op2">_u32</see> WHILELO Presult.S, Wop1, Wop2 To be added. @@ -11526,7 +11526,7 @@ To be added. To be added. - svbool_t svwhilelt_b32[_u64](uint64_t op1, uint64_t op2) + svbool_t svwhilelt_b32<see href="uint64_t op1, uint64_t op2">_u64</see> WHILELO Presult.S, Xop1, Xop2 To be added. @@ -11556,7 +11556,7 @@ To be added. To be added. - svbool_t svwhilelt_b64[_s32](int32_t op1, int32_t op2) + svbool_t svwhilelt_b64<see href="int32_t op1, int32_t op2">_s32</see> WHILELT Presult.D, Wop1, Wop2 To be added. @@ -11586,7 +11586,7 @@ To be added. To be added. - svbool_t svwhilelt_b64[_s64](int64_t op1, int64_t op2) + svbool_t svwhilelt_b64<see href="int64_t op1, int64_t op2">_s64</see> WHILELT Presult.D, Xop1, Xop2 To be added. @@ -11616,7 +11616,7 @@ To be added. To be added. - svbool_t svwhilelt_b64[_u32](uint32_t op1, uint32_t op2) + svbool_t svwhilelt_b64<see href="uint32_t op1, uint32_t op2">_u32</see> WHILELO Presult.D, Wop1, Wop2 To be added. @@ -11646,7 +11646,7 @@ To be added. To be added. - svbool_t svwhilelt_b64[_u64](uint64_t op1, uint64_t op2) + svbool_t svwhilelt_b64<see href="uint64_t op1, uint64_t op2">_u64</see> WHILELO Presult.D, Xop1, Xop2 To be added. @@ -11676,7 +11676,7 @@ To be added. To be added. - svbool_t svwhilelt_b8[_s32](int32_t op1, int32_t op2) + svbool_t svwhilelt_b8<see href="int32_t op1, int32_t op2">_s32</see> WHILELT Presult.B, Wop1, Wop2 To be added. @@ -11706,7 +11706,7 @@ To be added. To be added. - svbool_t svwhilelt_b8[_s64](int64_t op1, int64_t op2) + svbool_t svwhilelt_b8<see href="int64_t op1, int64_t op2">_s64</see> WHILELT Presult.B, Xop1, Xop2 To be added. @@ -11736,7 +11736,7 @@ To be added. To be added. - svbool_t svwhilelt_b8[_u32](uint32_t op1, uint32_t op2) + svbool_t svwhilelt_b8<see href="uint32_t op1, uint32_t op2">_u32</see> WHILELO Presult.B, Wop1, Wop2 To be added. @@ -11766,7 +11766,7 @@ To be added. To be added. - svbool_t svwhilelt_b8[_u64](uint64_t op1, uint64_t op2) + svbool_t svwhilelt_b8<see href="uint64_t op1, uint64_t op2">_u64</see> WHILELO Presult.B, Xop1, Xop2 To be added. @@ -11796,7 +11796,7 @@ To be added. To be added. - svbool_t svwhilele_b16[_s32](int32_t op1, int32_t op2) + svbool_t svwhilele_b16<see href="int32_t op1, int32_t op2">_s32</see> WHILELE Presult.H, Wop1, Wop2 To be added. @@ -11826,7 +11826,7 @@ To be added. To be added. - svbool_t svwhilele_b16[_s64](int64_t op1, int64_t op2) + svbool_t svwhilele_b16<see href="int64_t op1, int64_t op2">_s64</see> WHILELE Presult.H, Xop1, Xop2 To be added. @@ -11856,7 +11856,7 @@ To be added. To be added. - svbool_t svwhilele_b16[_u32](uint32_t op1, uint32_t op2) + svbool_t svwhilele_b16<see href="uint32_t op1, uint32_t op2">_u32</see> WHILELS Presult.H, Wop1, Wop2 To be added. @@ -11886,7 +11886,7 @@ To be added. To be added. - svbool_t svwhilele_b16[_u64](uint64_t op1, uint64_t op2) + svbool_t svwhilele_b16<see href="uint64_t op1, uint64_t op2">_u64</see> WHILELS Presult.H, Xop1, Xop2 To be added. @@ -11916,7 +11916,7 @@ To be added. To be added. - svbool_t svwhilele_b32[_s32](int32_t op1, int32_t op2) + svbool_t svwhilele_b32<see href="int32_t op1, int32_t op2">_s32</see> WHILELE Presult.S, Wop1, Wop2 To be added. @@ -11946,7 +11946,7 @@ To be added. To be added. - svbool_t svwhilele_b32[_s64](int64_t op1, int64_t op2) + svbool_t svwhilele_b32<see href="int64_t op1, int64_t op2">_s64</see> WHILELE Presult.S, Xop1, Xop2 To be added. @@ -11976,7 +11976,7 @@ To be added. To be added. - svbool_t svwhilele_b32[_u32](uint32_t op1, uint32_t op2) + svbool_t svwhilele_b32<see href="uint32_t op1, uint32_t op2">_u32</see> WHILELS Presult.S, Wop1, Wop2 To be added. @@ -12006,7 +12006,7 @@ To be added. To be added. - svbool_t svwhilele_b32[_u64](uint64_t op1, uint64_t op2) + svbool_t svwhilele_b32<see href="uint64_t op1, uint64_t op2">_u64</see> WHILELS Presult.S, Xop1, Xop2 To be added. @@ -12036,7 +12036,7 @@ To be added. To be added. - svbool_t svwhilele_b64[_s32](int32_t op1, int32_t op2) + svbool_t svwhilele_b64<see href="int32_t op1, int32_t op2">_s32</see> WHILELE Presult.D, Wop1, Wop2 To be added. @@ -12066,7 +12066,7 @@ To be added. To be added. - svbool_t svwhilele_b64[_s64](int64_t op1, int64_t op2) + svbool_t svwhilele_b64<see href="int64_t op1, int64_t op2">_s64</see> WHILELE Presult.D, Xop1, Xop2 To be added. @@ -12096,7 +12096,7 @@ To be added. To be added. - svbool_t svwhilele_b64[_u32](uint32_t op1, uint32_t op2) + svbool_t svwhilele_b64<see href="uint32_t op1, uint32_t op2">_u32</see> WHILELS Presult.D, Wop1, Wop2 To be added. @@ -12126,7 +12126,7 @@ To be added. To be added. - svbool_t svwhilele_b64[_u64](uint64_t op1, uint64_t op2) + svbool_t svwhilele_b64<see href="uint64_t op1, uint64_t op2">_u64</see> WHILELS Presult.D, Xop1, Xop2 To be added. @@ -12156,7 +12156,7 @@ To be added. To be added. - svbool_t svwhilele_b8[_s32](int32_t op1, int32_t op2) + svbool_t svwhilele_b8<see href="int32_t op1, int32_t op2">_s32</see> WHILELE Presult.B, Wop1, Wop2 To be added. @@ -12186,7 +12186,7 @@ To be added. To be added. - svbool_t svwhilele_b8[_s64](int64_t op1, int64_t op2) + svbool_t svwhilele_b8<see href="int64_t op1, int64_t op2">_s64</see> WHILELE Presult.B, Xop1, Xop2 To be added. @@ -12216,7 +12216,7 @@ To be added. To be added. - svbool_t svwhilele_b8[_u32](uint32_t op1, uint32_t op2) + svbool_t svwhilele_b8<see href="uint32_t op1, uint32_t op2">_u32</see> WHILELS Presult.B, Wop1, Wop2 To be added. @@ -12246,7 +12246,7 @@ To be added. To be added. - svbool_t svwhilele_b8[_u64](uint64_t op1, uint64_t op2) + svbool_t svwhilele_b8<see href="uint64_t op1, uint64_t op2">_u64</see> WHILELS Presult.B, Xop1, Xop2 To be added. @@ -12342,7 +12342,7 @@ To be added. To be added. - svint32_t svdot[_s32](svint32_t op1, svint8_t op2, svint8_t op3) + svint32_t svdot<see href="svint32_t op1, svint8_t op2, svint8_t op3">_s32</see> SDOT Ztied1.S, Zop2.B, Zop3.B To be added. @@ -12374,7 +12374,7 @@ To be added. To be added. - svint64_t svdot[_s64](svint64_t op1, svint16_t op2, svint16_t op3) + svint64_t svdot<see href="svint64_t op1, svint16_t op2, svint16_t op3">_s64</see> SDOT Ztied1.D, Zop2.H, Zop3.H To be added. @@ -12406,7 +12406,7 @@ To be added. To be added. - svuint32_t svdot[_u32](svuint32_t op1, svuint8_t op2, svuint8_t op3) + svuint32_t svdot<see href="svuint32_t op1, svuint8_t op2, svuint8_t op3">_u32</see> UDOT Ztied1.S, Zop2.B, Zop3.B To be added. @@ -12438,7 +12438,7 @@ To be added. To be added. - svuint64_t svdot[_u64](svuint64_t op1, svuint16_t op2, svuint16_t op3) + svuint64_t svdot<see href="svuint64_t op1, svuint16_t op2, svuint16_t op3">_u64</see> UDOT Ztied1.D, Zop2.H, Zop3.H To be added. @@ -12479,7 +12479,7 @@ To be added. To be added. - svint32_t svdot_lane[_s32](svint32_t op1, svint8_t op2, svint8_t op3, uint64_t imm_index) + svint32_t svdot_lane<see href="svint32_t op1, svint8_t op2, svint8_t op3, uint64_t imm_index">_s32</see> SDOT Ztied1.S, Zop2.B, Zop3.B[imm_index] To be added. @@ -12520,7 +12520,7 @@ To be added. To be added. - svint64_t svdot_lane[_s64](svint64_t op1, svint16_t op2, svint16_t op3, uint64_t imm_index) + svint64_t svdot_lane<see href="svint64_t op1, svint16_t op2, svint16_t op3, uint64_t imm_index">_s64</see> SDOT Ztied1.D, Zop2.H, Zop3.H[imm_index] To be added. @@ -12561,7 +12561,7 @@ To be added. To be added. - svuint32_t svdot_lane[_u32](svuint32_t op1, svuint8_t op2, svuint8_t op3, uint64_t imm_index) + svuint32_t svdot_lane<see href="svuint32_t op1, svuint8_t op2, svuint8_t op3, uint64_t imm_index">_u32</see> UDOT Ztied1.S, Zop2.B, Zop3.B[imm_index] To be added. @@ -12602,7 +12602,7 @@ To be added. To be added. - svuint64_t svdot_lane[_u64](svuint64_t op1, svuint16_t op2, svuint16_t op3, uint64_t imm_index) + svuint64_t svdot_lane<see href="svuint64_t op1, svuint16_t op2, svuint16_t op3, uint64_t imm_index">_u64</see> UDOT Ztied1.D, Zop2.H, Zop3.H[imm_index] To be added. @@ -12639,7 +12639,7 @@ To be added. To be added. - svuint8_t svdup_lane[_u8](svuint8_t data, uint8_t index) + svuint8_t svdup_lane<see href="svuint8_t data, uint8_t index">_u8</see> DUP Zresult.B, Zdata.B[index] To be added. @@ -12676,7 +12676,7 @@ To be added. To be added. - svfloat64_t svdup_lane[_f64](svfloat64_t data, uint64_t index) + svfloat64_t svdup_lane<see href="svfloat64_t data, uint64_t index">_f64</see> DUP Zresult.D, Zdata.D[index] To be added. @@ -12713,7 +12713,7 @@ To be added. To be added. - svint16_t svdup_lane[_s16](svint16_t data, uint16_t index) + svint16_t svdup_lane<see href="svint16_t data, uint16_t index">_s16</see> DUP Zresult.H, Zdata.H[index] To be added. @@ -12750,7 +12750,7 @@ To be added. To be added. - svint32_t svdup_lane[_s32](svint32_t data, uint32_t index) + svint32_t svdup_lane<see href="svint32_t data, uint32_t index">_s32</see> DUP Zresult.S, Zdata.S[index] To be added. @@ -12787,7 +12787,7 @@ To be added. To be added. - svint64_t svdup_lane[_s64](svint64_t data, uint64_t index) + svint64_t svdup_lane<see href="svint64_t data, uint64_t index">_s64</see> DUP Zresult.D, Zdata.D[index] To be added. @@ -12824,7 +12824,7 @@ To be added. To be added. - svint8_t svdup_lane[_s8](svint8_t data, uint8_t index) + svint8_t svdup_lane<see href="svint8_t data, uint8_t index">_s8</see> DUP Zresult.B, Zdata.B[index] To be added. @@ -12861,7 +12861,7 @@ To be added. To be added. - svfloat32_t svdup_lane[_f32](svfloat32_t data, uint32_t index) + svfloat32_t svdup_lane<see href="svfloat32_t data, uint32_t index">_f32</see> DUP Zresult.S, Zdata.S[index] To be added. @@ -12898,7 +12898,7 @@ To be added. To be added. - svuint16_t svdup_lane[_u16](svuint16_t data, uint16_t index) + svuint16_t svdup_lane<see href="svuint16_t data, uint16_t index">_u16</see> DUP Zresult.H, Zdata.H[index] To be added. @@ -12935,7 +12935,7 @@ To be added. To be added. - svuint32_t svdup_lane[_u32](svuint32_t data, uint32_t index) + svuint32_t svdup_lane<see href="svuint32_t data, uint32_t index">_u32</see> DUP Zresult.S, Zdata.S[index] To be added. @@ -12972,7 +12972,7 @@ To be added. To be added. - svuint64_t svdup_lane[_u64](svuint64_t data, uint64_t index) + svuint64_t svdup_lane<see href="svuint64_t data, uint64_t index">_u64</see> DUP Zresult.D, Zdata.D[index] To be added. @@ -13011,7 +13011,7 @@ To be added. To be added. - svuint8_t svext[_u8](svuint8_t op1, svuint8_t op2, uint64_t imm3) + svuint8_t svext<see href="svuint8_t op1, svuint8_t op2, uint64_t imm3">_u8</see> EXT Ztied1.B, Ztied1.B, Zop2.B, #imm3 To be added. @@ -13050,7 +13050,7 @@ To be added. To be added. - svfloat64_t svext[_f64](svfloat64_t op1, svfloat64_t op2, uint64_t imm3) + svfloat64_t svext<see href="svfloat64_t op1, svfloat64_t op2, uint64_t imm3">_f64</see> EXT Ztied1.B, Ztied1.B, Zop2.B, #imm3 * 8 To be added. @@ -13089,7 +13089,7 @@ To be added. To be added. - svint16_t svext[_s16](svint16_t op1, svint16_t op2, uint64_t imm3) + svint16_t svext<see href="svint16_t op1, svint16_t op2, uint64_t imm3">_s16</see> EXT Ztied1.B, Ztied1.B, Zop2.B, #imm3 * 2 To be added. @@ -13128,7 +13128,7 @@ To be added. To be added. - svint32_t svext[_s32](svint32_t op1, svint32_t op2, uint64_t imm3) + svint32_t svext<see href="svint32_t op1, svint32_t op2, uint64_t imm3">_s32</see> EXT Ztied1.B, Ztied1.B, Zop2.B, #imm3 * 4 To be added. @@ -13167,7 +13167,7 @@ To be added. To be added. - svint64_t svext[_s64](svint64_t op1, svint64_t op2, uint64_t imm3) + svint64_t svext<see href="svint64_t op1, svint64_t op2, uint64_t imm3">_s64</see> EXT Ztied1.B, Ztied1.B, Zop2.B, #imm3 * 8 To be added. @@ -13206,7 +13206,7 @@ To be added. To be added. - svint8_t svext[_s8](svint8_t op1, svint8_t op2, uint64_t imm3) + svint8_t svext<see href="svint8_t op1, svint8_t op2, uint64_t imm3">_s8</see> EXT Ztied1.B, Ztied1.B, Zop2.B, #imm3 To be added. @@ -13245,7 +13245,7 @@ To be added. To be added. - svfloat32_t svext[_f32](svfloat32_t op1, svfloat32_t op2, uint64_t imm3) + svfloat32_t svext<see href="svfloat32_t op1, svfloat32_t op2, uint64_t imm3">_f32</see> EXT Ztied1.B, Ztied1.B, Zop2.B, #imm3 * 4 To be added. @@ -13284,7 +13284,7 @@ To be added. To be added. - svuint16_t svext[_u16](svuint16_t op1, svuint16_t op2, uint64_t imm3) + svuint16_t svext<see href="svuint16_t op1, svuint16_t op2, uint64_t imm3">_u16</see> EXT Ztied1.B, Ztied1.B, Zop2.B, #imm3 * 2 To be added. @@ -13323,7 +13323,7 @@ To be added. To be added. - svuint32_t svext[_u32](svuint32_t op1, svuint32_t op2, uint64_t imm3) + svuint32_t svext<see href="svuint32_t op1, svuint32_t op2, uint64_t imm3">_u32</see> EXT Ztied1.B, Ztied1.B, Zop2.B, #imm3 * 4 To be added. @@ -13362,7 +13362,7 @@ To be added. To be added. - svuint64_t svext[_u64](svuint64_t op1, svuint64_t op2, uint64_t imm3) + svuint64_t svext<see href="svuint64_t op1, svuint64_t op2, uint64_t imm3">_u64</see> EXT Ztied1.B, Ztied1.B, Zop2.B, #imm3 * 8 To be added. @@ -13390,7 +13390,7 @@ To be added. - svfloat32_t svexpa[_f32](svuint32_t op) + svfloat32_t svexpa<see href="svuint32_t op">_f32</see> FEXPA Zresult.S, Zop.S To be added. @@ -13418,7 +13418,7 @@ To be added. - svfloat64_t svexpa[_f64](svuint64_t op) + svfloat64_t svexpa<see href="svuint64_t op">_f64</see> FEXPA Zresult.D, Zop.D To be added. @@ -13527,7 +13527,7 @@ To be added. To be added. - svfloat64_t svmla_lane[_f64](svfloat64_t op1, svfloat64_t op2, svfloat64_t op3, uint64_t imm_index) + svfloat64_t svmla_lane<see href="svfloat64_t op1, svfloat64_t op2, svfloat64_t op3, uint64_t imm_index">_f64</see> FMLA Ztied1.D, Zop2.D, Zop3.D[imm_index] To be added. @@ -13568,7 +13568,7 @@ To be added. To be added. - svfloat32_t svmla_lane[_f32](svfloat32_t op1, svfloat32_t op2, svfloat32_t op3, uint64_t imm_index) + svfloat32_t svmla_lane<see href="svfloat32_t op1, svfloat32_t op2, svfloat32_t op3, uint64_t imm_index">_f32</see> FMLA Ztied1.S, Zop2.S, Zop3.S[imm_index] To be added. @@ -13745,7 +13745,7 @@ To be added. To be added. - svfloat64_t svmls_lane[_f64](svfloat64_t op1, svfloat64_t op2, svfloat64_t op3, uint64_t imm_index) + svfloat64_t svmls_lane<see href="svfloat64_t op1, svfloat64_t op2, svfloat64_t op3, uint64_t imm_index">_f64</see> FMLS Ztied1.D, Zop2.D, Zop3.D[imm_index] To be added. @@ -13786,7 +13786,7 @@ To be added. To be added. - svfloat32_t svmls_lane[_f32](svfloat32_t op1, svfloat32_t op2, svfloat32_t op3, uint64_t imm_index) + svfloat32_t svmls_lane<see href="svfloat32_t op1, svfloat32_t op2, svfloat32_t op3, uint64_t imm_index">_f32</see> FMLS Ztied1.S, Zop2.S, Zop3.S[imm_index] To be added. @@ -13893,7 +13893,7 @@ To be added. To be added. - void svprfh_gather[_u64base](svbool_t pg, svuint64_t bases, enum svprfop op) + void svprfh_gather<see href="svbool_t pg, svuint64_t bases, enum svprfop op">_u64base</see> PRFH op, Pg, [Zbases.D, #0] To be added. @@ -13931,7 +13931,7 @@ To be added. To be added. - void svprfh_gather[_u64base](svbool_t pg, svuint64_t bases, enum svprfop op) + void svprfh_gather<see href="svbool_t pg, svuint64_t bases, enum svprfop op">_u64base</see> PRFH op, Pg, [Zbases.D, #0] To be added. @@ -14281,7 +14281,7 @@ To be added. To be added. - void svprfw_gather[_u64base](svbool_t pg, svuint64_t bases, enum svprfop op) + void svprfw_gather<see href="svbool_t pg, svuint64_t bases, enum svprfop op">_u64base</see> PRFW op, Pg, [Zbases.D, #0] To be added. @@ -14319,7 +14319,7 @@ To be added. To be added. - void svprfw_gather[_u64base](svbool_t pg, svuint64_t bases, enum svprfop op) + void svprfw_gather<see href="svbool_t pg, svuint64_t bases, enum svprfop op">_u64base</see> PRFW op, Pg, [Zbases.D, #0] To be added. @@ -14669,7 +14669,7 @@ To be added. To be added. - void svprfd_gather[_u64base](svbool_t pg, svuint64_t bases, enum svprfop op) + void svprfd_gather<see href="svbool_t pg, svuint64_t bases, enum svprfop op">_u64base</see> PRFD op, Pg, [Zbases.D, #0] To be added. @@ -14707,7 +14707,7 @@ To be added. To be added. - void svprfd_gather[_u64base](svbool_t pg, svuint64_t bases, enum svprfop op) + void svprfd_gather<see href="svbool_t pg, svuint64_t bases, enum svprfop op">_u64base</see> PRFD op, Pg, [Zbases.D, #0] To be added. @@ -15057,7 +15057,7 @@ To be added. To be added. - void svprfb_gather[_u64base](svbool_t pg, svuint64_t bases, enum svprfop op) + void svprfb_gather<see href="svbool_t pg, svuint64_t bases, enum svprfop op">_u64base</see> PRFB op, Pg, [Zbases.D, #0] To be added. @@ -15095,7 +15095,7 @@ To be added. To be added. - void svprfb_gather[_u64base](svbool_t pg, svuint64_t bases, enum svprfop op) + void svprfb_gather<see href="svbool_t pg, svuint64_t bases, enum svprfop op">_u64base</see> PRFB op, Pg, [Zbases.D, #0] To be added. @@ -15527,7 +15527,7 @@ To be added. To be added. - svfloat64_t svld1_gather_[s64]index[_f64](svbool_t pg, const float64_t *base, svint64_t indices) + svfloat64_t svld1_gather_<see href="svbool_t pg, const float64_t *base, svint64_t indices">s64]index[_f64</see> LD1D Zresult.D, Pg/Z, [Xbase, Zindices.D, LSL #3] To be added. @@ -15558,7 +15558,7 @@ To be added. To be added. - svfloat64_t svld1_gather_[u64]index[_f64](svbool_t pg, const float64_t *base, svuint64_t indices) + svfloat64_t svld1_gather_<see href="svbool_t pg, const float64_t *base, svuint64_t indices">u64]index[_f64</see> LD1D Zresult.D, Pg/Z, [Xbase, Zindices.D, LSL #3] To be added. @@ -15589,7 +15589,7 @@ To be added. To be added. - svint32_t svld1_gather_[s32]index[_s32](svbool_t pg, const int32_t *base, svint32_t indices) + svint32_t svld1_gather_<see href="svbool_t pg, const int32_t *base, svint32_t indices">s32]index[_s32</see> LD1W Zresult.S, Pg/Z, [Xbase, Zindices.S, SXTW #2] To be added. @@ -15620,7 +15620,7 @@ To be added. To be added. - svint32_t svld1_gather_[u32]index[_s32](svbool_t pg, const int32_t *base, svuint32_t indices) + svint32_t svld1_gather_<see href="svbool_t pg, const int32_t *base, svuint32_t indices">u32]index[_s32</see> LD1W Zresult.S, Pg/Z, [Xbase, Zindices.S, UXTW #2] To be added. @@ -15651,7 +15651,7 @@ To be added. To be added. - svint64_t svld1_gather_[s64]index[_s64](svbool_t pg, const int64_t *base, svint64_t indices) + svint64_t svld1_gather_<see href="svbool_t pg, const int64_t *base, svint64_t indices">s64]index[_s64</see> LD1D Zresult.D, Pg/Z, [Xbase, Zindices.D, LSL #3] To be added. @@ -15682,7 +15682,7 @@ To be added. To be added. - svint64_t svld1_gather_[u64]index[_s64](svbool_t pg, const int64_t *base, svuint64_t indices) + svint64_t svld1_gather_<see href="svbool_t pg, const int64_t *base, svuint64_t indices">u64]index[_s64</see> LD1D Zresult.D, Pg/Z, [Xbase, Zindices.D, LSL #3] To be added. @@ -15713,7 +15713,7 @@ To be added. To be added. - svfloat32_t svld1_gather_[s32]index[_f32](svbool_t pg, const float32_t *base, svint32_t indices) + svfloat32_t svld1_gather_<see href="svbool_t pg, const float32_t *base, svint32_t indices">s32]index[_f32</see> LD1W Zresult.S, Pg/Z, [Xbase, Zindices.S, SXTW #2] To be added. @@ -15744,7 +15744,7 @@ To be added. To be added. - svfloat32_t svld1_gather_[u32]index[_f32](svbool_t pg, const float32_t *base, svuint32_t indices) + svfloat32_t svld1_gather_<see href="svbool_t pg, const float32_t *base, svuint32_t indices">u32]index[_f32</see> LD1W Zresult.S, Pg/Z, [Xbase, Zindices.S, UXTW #2] To be added. @@ -15775,7 +15775,7 @@ To be added. To be added. - svuint32_t svld1_gather_[s32]index[_u32](svbool_t pg, const uint32_t *base, svint32_t indices) + svuint32_t svld1_gather_<see href="svbool_t pg, const uint32_t *base, svint32_t indices">s32]index[_u32</see> LD1W Zresult.S, Pg/Z, [Xbase, Zindices.S, SXTW #2] To be added. @@ -15806,7 +15806,7 @@ To be added. To be added. - svuint32_t svld1_gather_[u32]index[_u32](svbool_t pg, const uint32_t *base, svuint32_t indices) + svuint32_t svld1_gather_<see href="svbool_t pg, const uint32_t *base, svuint32_t indices">u32]index[_u32</see> LD1W Zresult.S, Pg/Z, [Xbase, Zindices.S, UXTW #2] To be added. @@ -15837,7 +15837,7 @@ To be added. To be added. - svuint64_t svld1_gather_[s64]index[_u64](svbool_t pg, const uint64_t *base, svint64_t indices) + svuint64_t svld1_gather_<see href="svbool_t pg, const uint64_t *base, svint64_t indices">s64]index[_u64</see> LD1D Zresult.D, Pg/Z, [Xbase, Zindices.D, LSL #3] To be added. @@ -15868,7 +15868,7 @@ To be added. To be added. - svuint64_t svld1_gather_[u64]index[_u64](svbool_t pg, const uint64_t *base, svuint64_t indices) + svuint64_t svld1_gather_<see href="svbool_t pg, const uint64_t *base, svuint64_t indices">u64]index[_u64</see> LD1D Zresult.D, Pg/Z, [Xbase, Zindices.D, LSL #3] To be added. @@ -21584,7 +21584,7 @@ To be added. To be added. - svfloat64_t svld1_gather_[s64]offset[_f64](svbool_t pg, const float64_t *base, svint64_t offsets) + svfloat64_t svld1_gather_<see href="svbool_t pg, const float64_t *base, svint64_t offsets">s64]offset[_f64</see> LD1D Zresult.D, Pg/Z, [Xbase, Zoffsets.D] To be added. @@ -21615,7 +21615,7 @@ To be added. To be added. - svfloat64_t svld1_gather_[u64]offset[_f64](svbool_t pg, const float64_t *base, svuint64_t offsets) + svfloat64_t svld1_gather_<see href="svbool_t pg, const float64_t *base, svuint64_t offsets">u64]offset[_f64</see> LD1D Zresult.D, Pg/Z, [Xbase, Zoffsets.D] To be added. @@ -21646,7 +21646,7 @@ To be added. To be added. - svint32_t svld1_gather_[s32]offset[_s32](svbool_t pg, const int32_t *base, svint32_t offsets) + svint32_t svld1_gather_<see href="svbool_t pg, const int32_t *base, svint32_t offsets">s32]offset[_s32</see> LD1W Zresult.S, Pg/Z, [Xbase, Zoffsets.S, SXTW] To be added. @@ -21677,7 +21677,7 @@ To be added. To be added. - svint32_t svld1_gather_[u32]offset[_s32](svbool_t pg, const int32_t *base, svuint32_t offsets) + svint32_t svld1_gather_<see href="svbool_t pg, const int32_t *base, svuint32_t offsets">u32]offset[_s32</see> LD1W Zresult.S, Pg/Z, [Xbase, Zoffsets.S, UXTW] To be added. @@ -21708,7 +21708,7 @@ To be added. To be added. - svint64_t svld1_gather_[s64]offset[_s64](svbool_t pg, const int64_t *base, svint64_t offsets) + svint64_t svld1_gather_<see href="svbool_t pg, const int64_t *base, svint64_t offsets">s64]offset[_s64</see> LD1D Zresult.D, Pg/Z, [Xbase, Zoffsets.D] To be added. @@ -21739,7 +21739,7 @@ To be added. To be added. - svint64_t svld1_gather_[u64]offset[_s64](svbool_t pg, const int64_t *base, svuint64_t offsets) + svint64_t svld1_gather_<see href="svbool_t pg, const int64_t *base, svuint64_t offsets">u64]offset[_s64</see> LD1D Zresult.D, Pg/Z, [Xbase, Zoffsets.D] To be added. @@ -21770,7 +21770,7 @@ To be added. To be added. - svfloat32_t svld1_gather_[s32]offset[_f32](svbool_t pg, const float32_t *base, svint32_t offsets) + svfloat32_t svld1_gather_<see href="svbool_t pg, const float32_t *base, svint32_t offsets">s32]offset[_f32</see> LD1W Zresult.S, Pg/Z, [Xbase, Zoffsets.S, SXTW] To be added. @@ -21801,7 +21801,7 @@ To be added. To be added. - svfloat32_t svld1_gather_[u32]offset[_f32](svbool_t pg, const float32_t *base, svuint32_t offsets) + svfloat32_t svld1_gather_<see href="svbool_t pg, const float32_t *base, svuint32_t offsets">u32]offset[_f32</see> LD1W Zresult.S, Pg/Z, [Xbase, Zoffsets.S, UXTW] To be added. @@ -21832,7 +21832,7 @@ To be added. To be added. - svuint32_t svld1_gather_[s32]offset[_u32](svbool_t pg, const uint32_t *base, svint32_t offsets) + svuint32_t svld1_gather_<see href="svbool_t pg, const uint32_t *base, svint32_t offsets">s32]offset[_u32</see> LD1W Zresult.S, Pg/Z, [Xbase, Zoffsets.S, SXTW] To be added. @@ -21863,7 +21863,7 @@ To be added. To be added. - svuint32_t svld1_gather_[u32]offset[_u32](svbool_t pg, const uint32_t *base, svuint32_t offsets) + svuint32_t svld1_gather_<see href="svbool_t pg, const uint32_t *base, svuint32_t offsets">u32]offset[_u32</see> LD1W Zresult.S, Pg/Z, [Xbase, Zoffsets.S, UXTW] To be added. @@ -21894,7 +21894,7 @@ To be added. To be added. - svuint64_t svld1_gather_[s64]offset[_u64](svbool_t pg, const uint64_t *base, svint64_t offsets) + svuint64_t svld1_gather_<see href="svbool_t pg, const uint64_t *base, svint64_t offsets">s64]offset[_u64</see> LD1D Zresult.D, Pg/Z, [Xbase, Zoffsets.D] To be added. @@ -21925,7 +21925,7 @@ To be added. To be added. - svuint64_t svld1_gather_[u64]offset[_u64](svbool_t pg, const uint64_t *base, svuint64_t offsets) + svuint64_t svld1_gather_<see href="svbool_t pg, const uint64_t *base, svuint64_t offsets">u64]offset[_u64</see> LD1D Zresult.D, Pg/Z, [Xbase, Zoffsets.D] To be added. @@ -22431,7 +22431,7 @@ To be added. To be added. - svuint8_t svinsr[_n_u8](svuint8_t op1, uint8_t op2) + svuint8_t svinsr<see href="svuint8_t op1, uint8_t op2">_n_u8</see> INSR Ztied1.B, Wop2 INSR Ztied1.B, Bop2 @@ -22462,7 +22462,7 @@ To be added. To be added. - svfloat64_t svinsr[_n_f64](svfloat64_t op1, float64_t op2) + svfloat64_t svinsr<see href="svfloat64_t op1, float64_t op2">_n_f64</see> INSR Ztied1.D, Xop2 INSR Ztied1.D, Dop2 @@ -22493,7 +22493,7 @@ To be added. To be added. - svint16_t svinsr[_n_s16](svint16_t op1, int16_t op2) + svint16_t svinsr<see href="svint16_t op1, int16_t op2">_n_s16</see> INSR Ztied1.H, Wop2 INSR Ztied1.H, Hop2 @@ -22524,7 +22524,7 @@ To be added. To be added. - svint32_t svinsr[_n_s32](svint32_t op1, int32_t op2) + svint32_t svinsr<see href="svint32_t op1, int32_t op2">_n_s32</see> INSR Ztied1.S, Wop2 INSR Ztied1.S, Sop2 @@ -22555,7 +22555,7 @@ To be added. To be added. - svint64_t svinsr[_n_s64](svint64_t op1, int64_t op2) + svint64_t svinsr<see href="svint64_t op1, int64_t op2">_n_s64</see> INSR Ztied1.D, Xop2 INSR Ztied1.D, Dop2 @@ -22586,7 +22586,7 @@ To be added. To be added. - svint8_t svinsr[_n_s8](svint8_t op1, int8_t op2) + svint8_t svinsr<see href="svint8_t op1, int8_t op2">_n_s8</see> INSR Ztied1.B, Wop2 INSR Ztied1.B, Bop2 @@ -22617,7 +22617,7 @@ To be added. To be added. - svfloat32_t svinsr[_n_f32](svfloat32_t op1, float32_t op2) + svfloat32_t svinsr<see href="svfloat32_t op1, float32_t op2">_n_f32</see> INSR Ztied1.S, Wop2 INSR Ztied1.S, Sop2 @@ -22648,7 +22648,7 @@ To be added. To be added. - svuint16_t svinsr[_n_u16](svuint16_t op1, uint16_t op2) + svuint16_t svinsr<see href="svuint16_t op1, uint16_t op2">_n_u16</see> INSR Ztied1.H, Wop2 INSR Ztied1.H, Hop2 @@ -22679,7 +22679,7 @@ To be added. To be added. - svuint32_t svinsr[_n_u32](svuint32_t op1, uint32_t op2) + svuint32_t svinsr<see href="svuint32_t op1, uint32_t op2">_n_u32</see> INSR Ztied1.S, Wop2 INSR Ztied1.S, Sop2 @@ -22710,7 +22710,7 @@ To be added. To be added. - svuint64_t svinsr[_n_u64](svuint64_t op1, uint64_t op2) + svuint64_t svinsr<see href="svuint64_t op1, uint64_t op2">_n_u64</see> INSR Ztied1.D, Xop2 INSR Ztied1.D, Dop2 @@ -23122,7 +23122,7 @@ To be added. To be added. - svuint8x2_t svld2[_u8](svbool_t pg, const uint8_t *base) + svuint8x2_t svld2<see href="svbool_t pg, const uint8_t *base">_u8</see> LD2B {Zresult0.B, Zresult1.B}, Pg/Z, [Xbase, #0, MUL VL] To be added. @@ -23151,7 +23151,7 @@ To be added. To be added. - svfloat64x2_t svld2[_f64](svbool_t pg, const float64_t *base) + svfloat64x2_t svld2<see href="svbool_t pg, const float64_t *base">_f64</see> LD2D {Zresult0.D, Zresult1.D}, Pg/Z, [Xbase, #0, MUL VL] To be added. @@ -23180,7 +23180,7 @@ To be added. To be added. - svint16x2_t svld2[_s16](svbool_t pg, const int16_t *base) + svint16x2_t svld2<see href="svbool_t pg, const int16_t *base">_s16</see> LD2H {Zresult0.H, Zresult1.H}, Pg/Z, [Xbase, #0, MUL VL] To be added. @@ -23209,7 +23209,7 @@ To be added. To be added. - svint32x2_t svld2[_s32](svbool_t pg, const int32_t *base) + svint32x2_t svld2<see href="svbool_t pg, const int32_t *base">_s32</see> LD2W {Zresult0.S, Zresult1.S}, Pg/Z, [Xbase, #0, MUL VL] To be added. @@ -23238,7 +23238,7 @@ To be added. To be added. - svint64x2_t svld2[_s64](svbool_t pg, const int64_t *base) + svint64x2_t svld2<see href="svbool_t pg, const int64_t *base">_s64</see> LD2D {Zresult0.D, Zresult1.D}, Pg/Z, [Xbase, #0, MUL VL] To be added. @@ -23267,7 +23267,7 @@ To be added. To be added. - svint8x2_t svld2[_s8](svbool_t pg, const int8_t *base) + svint8x2_t svld2<see href="svbool_t pg, const int8_t *base">_s8</see> LD2B {Zresult0.B, Zresult1.B}, Pg/Z, [Xbase, #0, MUL VL] To be added. @@ -23296,7 +23296,7 @@ To be added. To be added. - svfloat32x2_t svld2[_f32](svbool_t pg, const float32_t *base) + svfloat32x2_t svld2<see href="svbool_t pg, const float32_t *base">_f32</see> LD2W {Zresult0.S, Zresult1.S}, Pg/Z, [Xbase, #0, MUL VL] To be added. @@ -23325,7 +23325,7 @@ To be added. To be added. - svuint16x2_t svld2[_u16](svbool_t pg, const uint16_t *base) + svuint16x2_t svld2<see href="svbool_t pg, const uint16_t *base">_u16</see> LD2H {Zresult0.H, Zresult1.H}, Pg/Z, [Xbase, #0, MUL VL] To be added. @@ -23354,7 +23354,7 @@ To be added. To be added. - svuint32x2_t svld2[_u32](svbool_t pg, const uint32_t *base) + svuint32x2_t svld2<see href="svbool_t pg, const uint32_t *base">_u32</see> LD2W {Zresult0.S, Zresult1.S}, Pg/Z, [Xbase, #0, MUL VL] To be added. @@ -23383,7 +23383,7 @@ To be added. To be added. - svuint64x2_t svld2[_u64](svbool_t pg, const uint64_t *base) + svuint64x2_t svld2<see href="svbool_t pg, const uint64_t *base">_u64</see> LD2D {Zresult0.D, Zresult1.D}, Pg/Z, [Xbase, #0, MUL VL] To be added. @@ -23412,7 +23412,7 @@ To be added. To be added. - svuint8x3_t svld3[_u8](svbool_t pg, const uint8_t *base) + svuint8x3_t svld3<see href="svbool_t pg, const uint8_t *base">_u8</see> LD3B {Zresult0.B - Zresult2.B}, Pg/Z, [Xbase, #0, MUL VL] To be added. @@ -23441,7 +23441,7 @@ To be added. To be added. - svfloat64x3_t svld3[_f64](svbool_t pg, const float64_t *base) + svfloat64x3_t svld3<see href="svbool_t pg, const float64_t *base">_f64</see> LD3D {Zresult0.D - Zresult2.D}, Pg/Z, [Xbase, #0, MUL VL] To be added. @@ -23470,7 +23470,7 @@ To be added. To be added. - svint16x3_t svld3[_s16](svbool_t pg, const int16_t *base) + svint16x3_t svld3<see href="svbool_t pg, const int16_t *base">_s16</see> LD3H {Zresult0.H - Zresult2.H}, Pg/Z, [Xbase, #0, MUL VL] To be added. @@ -23499,7 +23499,7 @@ To be added. To be added. - svint32x3_t svld3[_s32](svbool_t pg, const int32_t *base) + svint32x3_t svld3<see href="svbool_t pg, const int32_t *base">_s32</see> LD3W {Zresult0.S - Zresult2.S}, Pg/Z, [Xbase, #0, MUL VL] To be added. @@ -23528,7 +23528,7 @@ To be added. To be added. - svint64x3_t svld3[_s64](svbool_t pg, const int64_t *base) + svint64x3_t svld3<see href="svbool_t pg, const int64_t *base">_s64</see> LD3D {Zresult0.D - Zresult2.D}, Pg/Z, [Xbase, #0, MUL VL] To be added. @@ -23557,7 +23557,7 @@ To be added. To be added. - svint8x3_t svld3[_s8](svbool_t pg, const int8_t *base) + svint8x3_t svld3<see href="svbool_t pg, const int8_t *base">_s8</see> LD3B {Zresult0.B - Zresult2.B}, Pg/Z, [Xbase, #0, MUL VL] To be added. @@ -23586,7 +23586,7 @@ To be added. To be added. - svfloat32x3_t svld3[_f32](svbool_t pg, const float32_t *base) + svfloat32x3_t svld3<see href="svbool_t pg, const float32_t *base">_f32</see> LD3W {Zresult0.S - Zresult2.S}, Pg/Z, [Xbase, #0, MUL VL] To be added. @@ -23615,7 +23615,7 @@ To be added. To be added. - svuint16x3_t svld3[_u16](svbool_t pg, const uint16_t *base) + svuint16x3_t svld3<see href="svbool_t pg, const uint16_t *base">_u16</see> LD3H {Zresult0.H - Zresult2.H}, Pg/Z, [Xbase, #0, MUL VL] To be added. @@ -23644,7 +23644,7 @@ To be added. To be added. - svuint32x3_t svld3[_u32](svbool_t pg, const uint32_t *base) + svuint32x3_t svld3<see href="svbool_t pg, const uint32_t *base">_u32</see> LD3W {Zresult0.S - Zresult2.S}, Pg/Z, [Xbase, #0, MUL VL] To be added. @@ -23673,7 +23673,7 @@ To be added. To be added. - svuint64x3_t svld3[_u64](svbool_t pg, const uint64_t *base) + svuint64x3_t svld3<see href="svbool_t pg, const uint64_t *base">_u64</see> LD3D {Zresult0.D - Zresult2.D}, Pg/Z, [Xbase, #0, MUL VL] To be added. @@ -23702,7 +23702,7 @@ To be added. To be added. - svuint8x4_t svld4[_u8](svbool_t pg, const uint8_t *base) + svuint8x4_t svld4<see href="svbool_t pg, const uint8_t *base">_u8</see> LD4B {Zresult0.B - Zresult3.B}, Pg/Z, [Xbase, #0, MUL VL] To be added. @@ -23731,7 +23731,7 @@ To be added. To be added. - svfloat64x4_t svld4[_f64](svbool_t pg, const float64_t *base) + svfloat64x4_t svld4<see href="svbool_t pg, const float64_t *base">_f64</see> LD4D {Zresult0.D - Zresult3.D}, Pg/Z, [Xbase, #0, MUL VL] To be added. @@ -23760,7 +23760,7 @@ To be added. To be added. - svint16x4_t svld4[_s16](svbool_t pg, const int16_t *base) + svint16x4_t svld4<see href="svbool_t pg, const int16_t *base">_s16</see> LD4H {Zresult0.H - Zresult3.H}, Pg/Z, [Xbase, #0, MUL VL] To be added. @@ -23789,7 +23789,7 @@ To be added. To be added. - svint32x4_t svld4[_s32](svbool_t pg, const int32_t *base) + svint32x4_t svld4<see href="svbool_t pg, const int32_t *base">_s32</see> LD4W {Zresult0.S - Zresult3.S}, Pg/Z, [Xbase, #0, MUL VL] To be added. @@ -23818,7 +23818,7 @@ To be added. To be added. - svint64x4_t svld4[_s64](svbool_t pg, const int64_t *base) + svint64x4_t svld4<see href="svbool_t pg, const int64_t *base">_s64</see> LD4D {Zresult0.D - Zresult3.D}, Pg/Z, [Xbase, #0, MUL VL] To be added. @@ -23847,7 +23847,7 @@ To be added. To be added. - svint8x4_t svld4[_s8](svbool_t pg, const int8_t *base) + svint8x4_t svld4<see href="svbool_t pg, const int8_t *base">_s8</see> LD4B {Zresult0.B - Zresult3.B}, Pg/Z, [Xbase, #0, MUL VL] To be added. @@ -23876,7 +23876,7 @@ To be added. To be added. - svfloat32x4_t svld4[_f32](svbool_t pg, const float32_t *base) + svfloat32x4_t svld4<see href="svbool_t pg, const float32_t *base">_f32</see> LD4W {Zresult0.S - Zresult3.S}, Pg/Z, [Xbase, #0, MUL VL] To be added. @@ -23905,7 +23905,7 @@ To be added. To be added. - svuint16x4_t svld4[_u16](svbool_t pg, const uint16_t *base) + svuint16x4_t svld4<see href="svbool_t pg, const uint16_t *base">_u16</see> LD4H {Zresult0.H - Zresult3.H}, Pg/Z, [Xbase, #0, MUL VL] To be added. @@ -23934,7 +23934,7 @@ To be added. To be added. - svuint32x4_t svld4[_u32](svbool_t pg, const uint32_t *base) + svuint32x4_t svld4<see href="svbool_t pg, const uint32_t *base">_u32</see> LD4W {Zresult0.S - Zresult3.S}, Pg/Z, [Xbase, #0, MUL VL] To be added. @@ -23963,7 +23963,7 @@ To be added. To be added. - svuint64x4_t svld4[_u64](svbool_t pg, const uint64_t *base) + svuint64x4_t svld4<see href="svbool_t pg, const uint64_t *base">_u64</see> LD4D {Zresult0.D - Zresult3.D}, Pg/Z, [Xbase, #0, MUL VL] To be added. @@ -23992,7 +23992,7 @@ To be added. To be added. - svuint8_t svld1[_u8](svbool_t pg, const uint8_t *base) + svuint8_t svld1<see href="svbool_t pg, const uint8_t *base">_u8</see> LD1B Zresult.B, Pg/Z, [Xarray, Xindex] LD1B Zresult.B, Pg/Z, [Xbase, #0, MUL VL] @@ -24022,7 +24022,7 @@ To be added. To be added. - svfloat64_t svld1[_f64](svbool_t pg, const float64_t *base) + svfloat64_t svld1<see href="svbool_t pg, const float64_t *base">_f64</see> LD1D Zresult.D, Pg/Z, [Xarray, Xindex, LSL #3] LD1D Zresult.D, Pg/Z, [Xbase, #0, MUL VL] @@ -24052,7 +24052,7 @@ To be added. To be added. - svint16_t svld1[_s16](svbool_t pg, const int16_t *base) + svint16_t svld1<see href="svbool_t pg, const int16_t *base">_s16</see> LD1H Zresult.H, Pg/Z, [Xarray, Xindex, LSL #1] LD1H Zresult.H, Pg/Z, [Xbase, #0, MUL VL] @@ -24082,7 +24082,7 @@ To be added. To be added. - svint32_t svld1[_s32](svbool_t pg, const int32_t *base) + svint32_t svld1<see href="svbool_t pg, const int32_t *base">_s32</see> LD1W Zresult.S, Pg/Z, [Xarray, Xindex, LSL #2] LD1W Zresult.S, Pg/Z, [Xbase, #0, MUL VL] @@ -24112,7 +24112,7 @@ To be added. To be added. - svint64_t svld1[_s64](svbool_t pg, const int64_t *base) + svint64_t svld1<see href="svbool_t pg, const int64_t *base">_s64</see> LD1D Zresult.D, Pg/Z, [Xarray, Xindex, LSL #3] LD1D Zresult.D, Pg/Z, [Xbase, #0, MUL VL] @@ -24142,7 +24142,7 @@ To be added. To be added. - svint8_t svld1[_s8](svbool_t pg, const int8_t *base) + svint8_t svld1<see href="svbool_t pg, const int8_t *base">_s8</see> LD1B Zresult.B, Pg/Z, [Xarray, Xindex] LD1B Zresult.B, Pg/Z, [Xbase, #0, MUL VL] @@ -24172,7 +24172,7 @@ To be added. To be added. - svfloat32_t svld1[_f32](svbool_t pg, const float32_t *base) + svfloat32_t svld1<see href="svbool_t pg, const float32_t *base">_f32</see> LD1W Zresult.S, Pg/Z, [Xarray, Xindex, LSL #2] LD1W Zresult.S, Pg/Z, [Xbase, #0, MUL VL] @@ -24202,7 +24202,7 @@ To be added. To be added. - svuint16_t svld1[_u16](svbool_t pg, const uint16_t *base) + svuint16_t svld1<see href="svbool_t pg, const uint16_t *base">_u16</see> LD1H Zresult.H, Pg/Z, [Xarray, Xindex, LSL #1] LD1H Zresult.H, Pg/Z, [Xbase, #0, MUL VL] @@ -24232,7 +24232,7 @@ To be added. To be added. - svuint32_t svld1[_u32](svbool_t pg, const uint32_t *base) + svuint32_t svld1<see href="svbool_t pg, const uint32_t *base">_u32</see> LD1W Zresult.S, Pg/Z, [Xarray, Xindex, LSL #2] LD1W Zresult.S, Pg/Z, [Xbase, #0, MUL VL] @@ -24262,7 +24262,7 @@ To be added. To be added. - svuint64_t svld1[_u64](svbool_t pg, const uint64_t *base) + svuint64_t svld1<see href="svbool_t pg, const uint64_t *base">_u64</see> LD1D Zresult.D, Pg/Z, [Xarray, Xindex, LSL #3] LD1D Zresult.D, Pg/Z, [Xbase, #0, MUL VL] @@ -24292,7 +24292,7 @@ To be added. To be added. - svuint8_t svld1rq[_u8](svbool_t pg, const uint8_t *base) + svuint8_t svld1rq<see href="svbool_t pg, const uint8_t *base">_u8</see> LD1RQB Zresult.B, Pg/Z, [Xbase, #0] To be added. @@ -24321,7 +24321,7 @@ To be added. To be added. - svfloat64_t svld1rq[_f64](svbool_t pg, const float64_t *base) + svfloat64_t svld1rq<see href="svbool_t pg, const float64_t *base">_f64</see> LD1RQD Zresult.D, Pg/Z, [Xbase, #0] To be added. @@ -24350,7 +24350,7 @@ To be added. To be added. - svint16_t svld1rq[_s16](svbool_t pg, const int16_t *base) + svint16_t svld1rq<see href="svbool_t pg, const int16_t *base">_s16</see> LD1RQH Zresult.H, Pg/Z, [Xbase, #0] To be added. @@ -24379,7 +24379,7 @@ To be added. To be added. - svint32_t svld1rq[_s32](svbool_t pg, const int32_t *base) + svint32_t svld1rq<see href="svbool_t pg, const int32_t *base">_s32</see> LD1RQW Zresult.S, Pg/Z, [Xbase, #0] To be added. @@ -24408,7 +24408,7 @@ To be added. To be added. - svint64_t svld1rq[_s64](svbool_t pg, const int64_t *base) + svint64_t svld1rq<see href="svbool_t pg, const int64_t *base">_s64</see> LD1RQD Zresult.D, Pg/Z, [Xbase, #0] To be added. @@ -24437,7 +24437,7 @@ To be added. To be added. - svint8_t svld1rq[_s8](svbool_t pg, const int8_t *base) + svint8_t svld1rq<see href="svbool_t pg, const int8_t *base">_s8</see> LD1RQB Zresult.B, Pg/Z, [Xbase, #0] To be added. @@ -24466,7 +24466,7 @@ To be added. To be added. - svfloat32_t svld1rq[_f32](svbool_t pg, const float32_t *base) + svfloat32_t svld1rq<see href="svbool_t pg, const float32_t *base">_f32</see> LD1RQW Zresult.S, Pg/Z, [Xbase, #0] To be added. @@ -24495,7 +24495,7 @@ To be added. To be added. - svuint16_t svld1rq[_u16](svbool_t pg, const uint16_t *base) + svuint16_t svld1rq<see href="svbool_t pg, const uint16_t *base">_u16</see> LD1RQH Zresult.H, Pg/Z, [Xbase, #0] To be added. @@ -24524,7 +24524,7 @@ To be added. To be added. - svuint32_t svld1rq[_u32](svbool_t pg, const uint32_t *base) + svuint32_t svld1rq<see href="svbool_t pg, const uint32_t *base">_u32</see> LD1RQW Zresult.S, Pg/Z, [Xbase, #0] To be added. @@ -24553,7 +24553,7 @@ To be added. To be added. - svuint64_t svld1rq[_u64](svbool_t pg, const uint64_t *base) + svuint64_t svld1rq<see href="svbool_t pg, const uint64_t *base">_u64</see> LD1RQD Zresult.D, Pg/Z, [Xbase, #0] To be added. @@ -25824,7 +25824,7 @@ To be added. - svuint8_t svldnf1[_u8](svbool_t pg, const uint8_t *base) + svuint8_t svldnf1<see href="svbool_t pg, const uint8_t *base">_u8</see> LDNF1B Zresult.B, Pg/Z, [Xbase, #0, MUL VL] To be added. @@ -25851,7 +25851,7 @@ To be added. - svfloat64_t svldnf1[_f64](svbool_t pg, const float64_t *base) + svfloat64_t svldnf1<see href="svbool_t pg, const float64_t *base">_f64</see> LDNF1D Zresult.D, Pg/Z, [Xbase, #0, MUL VL] To be added. @@ -25878,7 +25878,7 @@ To be added. - svint16_t svldnf1[_s16](svbool_t pg, const int16_t *base) + svint16_t svldnf1<see href="svbool_t pg, const int16_t *base">_s16</see> LDNF1H Zresult.H, Pg/Z, [Xbase, #0, MUL VL] To be added. @@ -25905,7 +25905,7 @@ To be added. - svint32_t svldnf1[_s32](svbool_t pg, const int32_t *base) + svint32_t svldnf1<see href="svbool_t pg, const int32_t *base">_s32</see> LDNF1W Zresult.S, Pg/Z, [Xbase, #0, MUL VL] To be added. @@ -25932,7 +25932,7 @@ To be added. - svint64_t svldnf1[_s64](svbool_t pg, const int64_t *base) + svint64_t svldnf1<see href="svbool_t pg, const int64_t *base">_s64</see> LDNF1D Zresult.D, Pg/Z, [Xbase, #0, MUL VL] To be added. @@ -25959,7 +25959,7 @@ To be added. - svint8_t svldnf1[_s8](svbool_t pg, const int8_t *base) + svint8_t svldnf1<see href="svbool_t pg, const int8_t *base">_s8</see> LDNF1B Zresult.B, Pg/Z, [Xbase, #0, MUL VL] To be added. @@ -25986,7 +25986,7 @@ To be added. - svfloat32_t svldnf1[_f32](svbool_t pg, const float32_t *base) + svfloat32_t svldnf1<see href="svbool_t pg, const float32_t *base">_f32</see> LDNF1W Zresult.S, Pg/Z, [Xbase, #0, MUL VL] To be added. @@ -26013,7 +26013,7 @@ To be added. - svuint16_t svldnf1[_u16](svbool_t pg, const uint16_t *base) + svuint16_t svldnf1<see href="svbool_t pg, const uint16_t *base">_u16</see> LDNF1H Zresult.H, Pg/Z, [Xbase, #0, MUL VL] To be added. @@ -26040,7 +26040,7 @@ To be added. - svuint32_t svldnf1[_u32](svbool_t pg, const uint32_t *base) + svuint32_t svldnf1<see href="svbool_t pg, const uint32_t *base">_u32</see> LDNF1W Zresult.S, Pg/Z, [Xbase, #0, MUL VL] To be added. @@ -26067,7 +26067,7 @@ To be added. - svuint64_t svldnf1[_u64](svbool_t pg, const uint64_t *base) + svuint64_t svldnf1<see href="svbool_t pg, const uint64_t *base">_u64</see> LDNF1D Zresult.D, Pg/Z, [Xbase, #0, MUL VL] To be added. @@ -26096,7 +26096,7 @@ To be added. To be added. - svuint8_t svldnt1[_u8](svbool_t pg, const uint8_t *base) + svuint8_t svldnt1<see href="svbool_t pg, const uint8_t *base">_u8</see> LDNT1B Zresult.B, Pg/Z, [Xbase, #0, MUL VL] To be added. @@ -26125,7 +26125,7 @@ To be added. To be added. - svfloat64_t svldnt1[_f64](svbool_t pg, const float64_t *base) + svfloat64_t svldnt1<see href="svbool_t pg, const float64_t *base">_f64</see> LDNT1D Zresult.D, Pg/Z, [Xbase, #0, MUL VL] To be added. @@ -26154,7 +26154,7 @@ To be added. To be added. - svint16_t svldnt1[_s16](svbool_t pg, const int16_t *base) + svint16_t svldnt1<see href="svbool_t pg, const int16_t *base">_s16</see> LDNT1H Zresult.H, Pg/Z, [Xbase, #0, MUL VL] To be added. @@ -26183,7 +26183,7 @@ To be added. To be added. - svint32_t svldnt1[_s32](svbool_t pg, const int32_t *base) + svint32_t svldnt1<see href="svbool_t pg, const int32_t *base">_s32</see> LDNT1W Zresult.S, Pg/Z, [Xbase, #0, MUL VL] To be added. @@ -26212,7 +26212,7 @@ To be added. To be added. - svint64_t svldnt1[_s64](svbool_t pg, const int64_t *base) + svint64_t svldnt1<see href="svbool_t pg, const int64_t *base">_s64</see> LDNT1D Zresult.D, Pg/Z, [Xbase, #0, MUL VL] To be added. @@ -26241,7 +26241,7 @@ To be added. To be added. - svint8_t svldnt1[_s8](svbool_t pg, const int8_t *base) + svint8_t svldnt1<see href="svbool_t pg, const int8_t *base">_s8</see> LDNT1B Zresult.B, Pg/Z, [Xbase, #0, MUL VL] To be added. @@ -26270,7 +26270,7 @@ To be added. To be added. - svfloat32_t svldnt1[_f32](svbool_t pg, const float32_t *base) + svfloat32_t svldnt1<see href="svbool_t pg, const float32_t *base">_f32</see> LDNT1W Zresult.S, Pg/Z, [Xbase, #0, MUL VL] To be added. @@ -26299,7 +26299,7 @@ To be added. To be added. - svuint16_t svldnt1[_u16](svbool_t pg, const uint16_t *base) + svuint16_t svldnt1<see href="svbool_t pg, const uint16_t *base">_u16</see> LDNT1H Zresult.H, Pg/Z, [Xbase, #0, MUL VL] To be added. @@ -26328,7 +26328,7 @@ To be added. To be added. - svuint32_t svldnt1[_u32](svbool_t pg, const uint32_t *base) + svuint32_t svldnt1<see href="svbool_t pg, const uint32_t *base">_u32</see> LDNT1W Zresult.S, Pg/Z, [Xbase, #0, MUL VL] To be added. @@ -26357,7 +26357,7 @@ To be added. To be added. - svuint64_t svldnt1[_u64](svbool_t pg, const uint64_t *base) + svuint64_t svldnt1<see href="svbool_t pg, const uint64_t *base">_u64</see> LDNT1D Zresult.D, Pg/Z, [Xbase, #0, MUL VL] To be added. @@ -27699,7 +27699,7 @@ To be added. - uint8_t svmaxv[_u8](svbool_t pg, svuint8_t op) + uint8_t svmaxv<see href="svbool_t pg, svuint8_t op">_u8</see> UMAXV Bresult, Pg, Zop.B To be added. @@ -27727,7 +27727,7 @@ To be added. - float64_t svmaxv[_f64](svbool_t pg, svfloat64_t op) + float64_t svmaxv<see href="svbool_t pg, svfloat64_t op">_f64</see> FMAXV Dresult, Pg, Zop.D To be added. @@ -27755,7 +27755,7 @@ To be added. - int16_t svmaxv[_s16](svbool_t pg, svint16_t op) + int16_t svmaxv<see href="svbool_t pg, svint16_t op">_s16</see> SMAXV Hresult, Pg, Zop.H To be added. @@ -27783,7 +27783,7 @@ To be added. - int32_t svmaxv[_s32](svbool_t pg, svint32_t op) + int32_t svmaxv<see href="svbool_t pg, svint32_t op">_s32</see> SMAXV Sresult, Pg, Zop.S To be added. @@ -27811,7 +27811,7 @@ To be added. - int64_t svmaxv[_s64](svbool_t pg, svint64_t op) + int64_t svmaxv<see href="svbool_t pg, svint64_t op">_s64</see> SMAXV Dresult, Pg, Zop.D To be added. @@ -27839,7 +27839,7 @@ To be added. - int8_t svmaxv[_s8](svbool_t pg, svint8_t op) + int8_t svmaxv<see href="svbool_t pg, svint8_t op">_s8</see> SMAXV Bresult, Pg, Zop.B To be added. @@ -27867,7 +27867,7 @@ To be added. - float32_t svmaxv[_f32](svbool_t pg, svfloat32_t op) + float32_t svmaxv<see href="svbool_t pg, svfloat32_t op">_f32</see> FMAXV Sresult, Pg, Zop.S To be added. @@ -27895,7 +27895,7 @@ To be added. - uint16_t svmaxv[_u16](svbool_t pg, svuint16_t op) + uint16_t svmaxv<see href="svbool_t pg, svuint16_t op">_u16</see> UMAXV Hresult, Pg, Zop.H To be added. @@ -27923,7 +27923,7 @@ To be added. - uint32_t svmaxv[_u32](svbool_t pg, svuint32_t op) + uint32_t svmaxv<see href="svbool_t pg, svuint32_t op">_u32</see> UMAXV Sresult, Pg, Zop.S To be added. @@ -27951,7 +27951,7 @@ To be added. - uint64_t svmaxv[_u64](svbool_t pg, svuint64_t op) + uint64_t svmaxv<see href="svbool_t pg, svuint64_t op">_u64</see> UMAXV Dresult, Pg, Zop.D To be added. @@ -28045,7 +28045,7 @@ To be added. - float64_t svmaxnmv[_f64](svbool_t pg, svfloat64_t op) + float64_t svmaxnmv<see href="svbool_t pg, svfloat64_t op">_f64</see> FMAXNMV Dresult, Pg, Zop.D To be added. @@ -28073,7 +28073,7 @@ To be added. - float32_t svmaxnmv[_f32](svbool_t pg, svfloat32_t op) + float32_t svmaxnmv<see href="svbool_t pg, svfloat32_t op">_f32</see> FMAXNMV Sresult, Pg, Zop.S To be added. @@ -28431,7 +28431,7 @@ To be added. - uint8_t svminv[_u8](svbool_t pg, svuint8_t op) + uint8_t svminv<see href="svbool_t pg, svuint8_t op">_u8</see> UMINV Bresult, Pg, Zop.B To be added. @@ -28459,7 +28459,7 @@ To be added. - float64_t svminv[_f64](svbool_t pg, svfloat64_t op) + float64_t svminv<see href="svbool_t pg, svfloat64_t op">_f64</see> FMINV Dresult, Pg, Zop.D To be added. @@ -28487,7 +28487,7 @@ To be added. - int16_t svminv[_s16](svbool_t pg, svint16_t op) + int16_t svminv<see href="svbool_t pg, svint16_t op">_s16</see> SMINV Hresult, Pg, Zop.H To be added. @@ -28515,7 +28515,7 @@ To be added. - int32_t svminv[_s32](svbool_t pg, svint32_t op) + int32_t svminv<see href="svbool_t pg, svint32_t op">_s32</see> SMINV Sresult, Pg, Zop.S To be added. @@ -28543,7 +28543,7 @@ To be added. - int64_t svminv[_s64](svbool_t pg, svint64_t op) + int64_t svminv<see href="svbool_t pg, svint64_t op">_s64</see> SMINV Dresult, Pg, Zop.D To be added. @@ -28571,7 +28571,7 @@ To be added. - int8_t svminv[_s8](svbool_t pg, svint8_t op) + int8_t svminv<see href="svbool_t pg, svint8_t op">_s8</see> SMINV Bresult, Pg, Zop.B To be added. @@ -28599,7 +28599,7 @@ To be added. - float32_t svminv[_f32](svbool_t pg, svfloat32_t op) + float32_t svminv<see href="svbool_t pg, svfloat32_t op">_f32</see> FMINV Sresult, Pg, Zop.S To be added. @@ -28627,7 +28627,7 @@ To be added. - uint16_t svminv[_u16](svbool_t pg, svuint16_t op) + uint16_t svminv<see href="svbool_t pg, svuint16_t op">_u16</see> UMINV Hresult, Pg, Zop.H To be added. @@ -28655,7 +28655,7 @@ To be added. - uint32_t svminv[_u32](svbool_t pg, svuint32_t op) + uint32_t svminv<see href="svbool_t pg, svuint32_t op">_u32</see> UMINV Sresult, Pg, Zop.S To be added. @@ -28683,7 +28683,7 @@ To be added. - uint64_t svminv[_u64](svbool_t pg, svuint64_t op) + uint64_t svminv<see href="svbool_t pg, svuint64_t op">_u64</see> UMINV Dresult, Pg, Zop.D To be added. @@ -28777,7 +28777,7 @@ To be added. - float64_t svminnmv[_f64](svbool_t pg, svfloat64_t op) + float64_t svminnmv<see href="svbool_t pg, svfloat64_t op">_f64</see> FMINNMV Dresult, Pg, Zop.D To be added. @@ -28805,7 +28805,7 @@ To be added. - float32_t svminnmv[_f32](svbool_t pg, svfloat32_t op) + float32_t svminnmv<see href="svbool_t pg, svfloat32_t op">_f32</see> FMINNMV Sresult, Pg, Zop.S To be added. @@ -29545,7 +29545,7 @@ To be added. To be added. - svfloat32_t svcmla_lane[_f32](svfloat32_t op1, svfloat32_t op2, svfloat32_t op3, uint64_t imm_index, uint64_t imm_rotation) + svfloat32_t svcmla_lane<see href="svfloat32_t op1, svfloat32_t op2, svfloat32_t op3, uint64_t imm_index, uint64_t imm_rotation">_f32</see> FCMLA Ztied1.S, Zop2.S, Zop3.S[imm_index], #imm_rotation To be added. @@ -29584,7 +29584,7 @@ To be added. To be added. - svfloat64_t svmul_lane[_f64](svfloat64_t op1, svfloat64_t op2, uint64_t imm_index) + svfloat64_t svmul_lane<see href="svfloat64_t op1, svfloat64_t op2, uint64_t imm_index">_f64</see> FMUL Zresult.D, Zop1.D, Zop2.D[imm_index] To be added. @@ -29623,7 +29623,7 @@ To be added. To be added. - svfloat32_t svmul_lane[_f32](svfloat32_t op1, svfloat32_t op2, uint64_t imm_index) + svfloat32_t svmul_lane<see href="svfloat32_t op1, svfloat32_t op2, uint64_t imm_index">_f32</see> FMUL Zresult.S, Zop1.S, Zop2.S[imm_index] To be added. @@ -30671,7 +30671,7 @@ To be added. - uint8_t svorv[_u8](svbool_t pg, svuint8_t op) + uint8_t svorv<see href="svbool_t pg, svuint8_t op">_u8</see> ORV Bresult, Pg, Zop.B To be added. @@ -30699,7 +30699,7 @@ To be added. - int16_t svorv[_s16](svbool_t pg, svint16_t op) + int16_t svorv<see href="svbool_t pg, svint16_t op">_s16</see> ORV Hresult, Pg, Zop.H To be added. @@ -30727,7 +30727,7 @@ To be added. - int32_t svorv[_s32](svbool_t pg, svint32_t op) + int32_t svorv<see href="svbool_t pg, svint32_t op">_s32</see> ORV Sresult, Pg, Zop.S To be added. @@ -30755,7 +30755,7 @@ To be added. - int64_t svorv[_s64](svbool_t pg, svint64_t op) + int64_t svorv<see href="svbool_t pg, svint64_t op">_s64</see> ORV Dresult, Pg, Zop.D To be added. @@ -30783,7 +30783,7 @@ To be added. - int8_t svorv[_s8](svbool_t pg, svint8_t op) + int8_t svorv<see href="svbool_t pg, svint8_t op">_s8</see> ORV Bresult, Pg, Zop.B To be added. @@ -30811,7 +30811,7 @@ To be added. - uint16_t svorv[_u16](svbool_t pg, svuint16_t op) + uint16_t svorv<see href="svbool_t pg, svuint16_t op">_u16</see> ORV Hresult, Pg, Zop.H To be added. @@ -30839,7 +30839,7 @@ To be added. - uint32_t svorv[_u32](svbool_t pg, svuint32_t op) + uint32_t svorv<see href="svbool_t pg, svuint32_t op">_u32</see> ORV Sresult, Pg, Zop.S To be added. @@ -30867,7 +30867,7 @@ To be added. - uint64_t svorv[_u64](svbool_t pg, svuint64_t op) + uint64_t svorv<see href="svbool_t pg, svuint64_t op">_u64</see> ORV Dresult, Pg, Zop.D To be added. @@ -31343,7 +31343,7 @@ To be added. - svfloat64_t svrecpe[_f64](svfloat64_t op) + svfloat64_t svrecpe<see href="svfloat64_t op">_f64</see> FRECPE Zresult.D, Zop.D To be added. @@ -31371,7 +31371,7 @@ To be added. - svfloat32_t svrecpe[_f32](svfloat32_t op) + svfloat32_t svrecpe<see href="svfloat32_t op">_f32</see> FRECPE Zresult.S, Zop.S To be added. @@ -31459,7 +31459,7 @@ To be added. - svfloat64_t svrsqrte[_f64](svfloat64_t op) + svfloat64_t svrsqrte<see href="svfloat64_t op">_f64</see> FRSQRTE Zresult.D, Zop.D To be added. @@ -31487,7 +31487,7 @@ To be added. - svfloat32_t svrsqrte[_f32](svfloat32_t op) + svfloat32_t svrsqrte<see href="svfloat32_t op">_f32</see> FRSQRTE Zresult.S, Zop.S To be added. @@ -31517,7 +31517,7 @@ To be added. To be added. - svfloat64_t svrsqrts[_f64](svfloat64_t op1, svfloat64_t op2) + svfloat64_t svrsqrts<see href="svfloat64_t op1, svfloat64_t op2">_f64</see> FRSQRTS Zresult.D, Zop1.D, Zop2.D To be added. @@ -31547,7 +31547,7 @@ To be added. To be added. - svfloat32_t svrsqrts[_f32](svfloat32_t op1, svfloat32_t op2) + svfloat32_t svrsqrts<see href="svfloat32_t op1, svfloat32_t op2">_f32</see> FRSQRTS Zresult.S, Zop1.S, Zop2.S To be added. @@ -31577,7 +31577,7 @@ To be added. To be added. - svfloat64_t svrecps[_f64](svfloat64_t op1, svfloat64_t op2) + svfloat64_t svrecps<see href="svfloat64_t op1, svfloat64_t op2">_f64</see> FRECPS Zresult.D, Zop1.D, Zop2.D To be added. @@ -31607,7 +31607,7 @@ To be added. To be added. - svfloat32_t svrecps[_f32](svfloat32_t op1, svfloat32_t op2) + svfloat32_t svrecps<see href="svfloat32_t op1, svfloat32_t op2">_f32</see> FRECPS Zresult.S, Zop1.S, Zop2.S To be added. @@ -31875,7 +31875,7 @@ To be added. - svuint8_t svrev[_u8](svuint8_t op) + svuint8_t svrev<see href="svuint8_t op">_u8</see> REV Zresult.B, Zop.B To be added. @@ -31903,7 +31903,7 @@ To be added. - svfloat64_t svrev[_f64](svfloat64_t op) + svfloat64_t svrev<see href="svfloat64_t op">_f64</see> REV Zresult.D, Zop.D To be added. @@ -31931,7 +31931,7 @@ To be added. - svint16_t svrev[_s16](svint16_t op) + svint16_t svrev<see href="svint16_t op">_s16</see> REV Zresult.H, Zop.H To be added. @@ -31959,7 +31959,7 @@ To be added. - svint32_t svrev[_s32](svint32_t op) + svint32_t svrev<see href="svint32_t op">_s32</see> REV Zresult.S, Zop.S To be added. @@ -31987,7 +31987,7 @@ To be added. - svint64_t svrev[_s64](svint64_t op) + svint64_t svrev<see href="svint64_t op">_s64</see> REV Zresult.D, Zop.D To be added. @@ -32015,7 +32015,7 @@ To be added. - svint8_t svrev[_s8](svint8_t op) + svint8_t svrev<see href="svint8_t op">_s8</see> REV Zresult.B, Zop.B To be added. @@ -32043,7 +32043,7 @@ To be added. - svfloat32_t svrev[_f32](svfloat32_t op) + svfloat32_t svrev<see href="svfloat32_t op">_f32</see> REV Zresult.S, Zop.S To be added. @@ -32071,7 +32071,7 @@ To be added. - svuint16_t svrev[_u16](svuint16_t op) + svuint16_t svrev<see href="svuint16_t op">_u16</see> REV Zresult.H, Zop.H To be added. @@ -32099,7 +32099,7 @@ To be added. - svuint32_t svrev[_u32](svuint32_t op) + svuint32_t svrev<see href="svuint32_t op">_u32</see> REV Zresult.S, Zop.S To be added. @@ -32127,7 +32127,7 @@ To be added. - svuint64_t svrev[_u64](svuint64_t op) + svuint64_t svrev<see href="svuint64_t op">_u64</see> REV Zresult.D, Zop.D To be added. @@ -32832,7 +32832,7 @@ To be added. To be added. - int32_t svqdech_pat[_n_s32](int32_t op, enum svpattern pattern, uint64_t imm_factor) + int32_t svqdech_pat<see href="int32_t op, enum svpattern pattern, uint64_t imm_factor">_n_s32</see> SQDECH Xtied, Wtied, pattern, MUL #imm_factor To be added. @@ -32877,7 +32877,7 @@ To be added. To be added. - int64_t svqdech_pat[_n_s64](int64_t op, enum svpattern pattern, uint64_t imm_factor) + int64_t svqdech_pat<see href="int64_t op, enum svpattern pattern, uint64_t imm_factor">_n_s64</see> SQDECH Xtied, pattern, MUL #imm_factor To be added. @@ -32922,7 +32922,7 @@ To be added. To be added. - svint16_t svqdech_pat[_s16](svint16_t op, enum svpattern pattern, uint64_t imm_factor) + svint16_t svqdech_pat<see href="svint16_t op, enum svpattern pattern, uint64_t imm_factor">_s16</see> SQDECH Ztied.H, pattern, MUL #imm_factor To be added. @@ -32967,7 +32967,7 @@ To be added. To be added. - svuint16_t svqdech_pat[_u16](svuint16_t op, enum svpattern pattern, uint64_t imm_factor) + svuint16_t svqdech_pat<see href="svuint16_t op, enum svpattern pattern, uint64_t imm_factor">_u16</see> UQDECH Ztied.H, pattern, MUL #imm_factor To be added. @@ -33012,7 +33012,7 @@ To be added. To be added. - uint32_t svqdech_pat[_n_u32](uint32_t op, enum svpattern pattern, uint64_t imm_factor) + uint32_t svqdech_pat<see href="uint32_t op, enum svpattern pattern, uint64_t imm_factor">_n_u32</see> UQDECH Wtied, pattern, MUL #imm_factor To be added. @@ -33057,7 +33057,7 @@ To be added. To be added. - uint64_t svqdech_pat[_n_u64](uint64_t op, enum svpattern pattern, uint64_t imm_factor) + uint64_t svqdech_pat<see href="uint64_t op, enum svpattern pattern, uint64_t imm_factor">_n_u64</see> UQDECH Xtied, pattern, MUL #imm_factor To be added. @@ -33102,7 +33102,7 @@ To be added. To be added. - int32_t svqdecw_pat[_n_s32](int32_t op, enum svpattern pattern, uint64_t imm_factor) + int32_t svqdecw_pat<see href="int32_t op, enum svpattern pattern, uint64_t imm_factor">_n_s32</see> SQDECW Xtied, Wtied, pattern, MUL #imm_factor To be added. @@ -33147,7 +33147,7 @@ To be added. To be added. - int64_t svqdecw_pat[_n_s64](int64_t op, enum svpattern pattern, uint64_t imm_factor) + int64_t svqdecw_pat<see href="int64_t op, enum svpattern pattern, uint64_t imm_factor">_n_s64</see> SQDECW Xtied, pattern, MUL #imm_factor To be added. @@ -33192,7 +33192,7 @@ To be added. To be added. - svint32_t svqdecw_pat[_s32](svint32_t op, enum svpattern pattern, uint64_t imm_factor) + svint32_t svqdecw_pat<see href="svint32_t op, enum svpattern pattern, uint64_t imm_factor">_s32</see> SQDECW Ztied.S, pattern, MUL #imm_factor To be added. @@ -33237,7 +33237,7 @@ To be added. To be added. - svuint32_t svqdecw_pat[_u32](svuint32_t op, enum svpattern pattern, uint64_t imm_factor) + svuint32_t svqdecw_pat<see href="svuint32_t op, enum svpattern pattern, uint64_t imm_factor">_u32</see> UQDECW Ztied.S, pattern, MUL #imm_factor To be added. @@ -33282,7 +33282,7 @@ To be added. To be added. - uint32_t svqdecw_pat[_n_u32](uint32_t op, enum svpattern pattern, uint64_t imm_factor) + uint32_t svqdecw_pat<see href="uint32_t op, enum svpattern pattern, uint64_t imm_factor">_n_u32</see> UQDECW Wtied, pattern, MUL #imm_factor To be added. @@ -33327,7 +33327,7 @@ To be added. To be added. - uint64_t svqdecw_pat[_n_u64](uint64_t op, enum svpattern pattern, uint64_t imm_factor) + uint64_t svqdecw_pat<see href="uint64_t op, enum svpattern pattern, uint64_t imm_factor">_n_u64</see> UQDECW Xtied, pattern, MUL #imm_factor To be added. @@ -33372,7 +33372,7 @@ To be added. To be added. - int32_t svqdecd_pat[_n_s32](int32_t op, enum svpattern pattern, uint64_t imm_factor) + int32_t svqdecd_pat<see href="int32_t op, enum svpattern pattern, uint64_t imm_factor">_n_s32</see> SQDECD Xtied, Wtied, pattern, MUL #imm_factor To be added. @@ -33417,7 +33417,7 @@ To be added. To be added. - int64_t svqdecd_pat[_n_s64](int64_t op, enum svpattern pattern, uint64_t imm_factor) + int64_t svqdecd_pat<see href="int64_t op, enum svpattern pattern, uint64_t imm_factor">_n_s64</see> SQDECD Xtied, pattern, MUL #imm_factor To be added. @@ -33462,7 +33462,7 @@ To be added. To be added. - svint64_t svqdecd_pat[_s64](svint64_t op, enum svpattern pattern, uint64_t imm_factor) + svint64_t svqdecd_pat<see href="svint64_t op, enum svpattern pattern, uint64_t imm_factor">_s64</see> SQDECD Ztied.D, pattern, MUL #imm_factor To be added. @@ -33507,7 +33507,7 @@ To be added. To be added. - svuint64_t svqdecd_pat[_u64](svuint64_t op, enum svpattern pattern, uint64_t imm_factor) + svuint64_t svqdecd_pat<see href="svuint64_t op, enum svpattern pattern, uint64_t imm_factor">_u64</see> UQDECD Ztied.D, pattern, MUL #imm_factor To be added. @@ -33552,7 +33552,7 @@ To be added. To be added. - uint32_t svqdecd_pat[_n_u32](uint32_t op, enum svpattern pattern, uint64_t imm_factor) + uint32_t svqdecd_pat<see href="uint32_t op, enum svpattern pattern, uint64_t imm_factor">_n_u32</see> UQDECD Wtied, pattern, MUL #imm_factor To be added. @@ -33597,7 +33597,7 @@ To be added. To be added. - uint64_t svqdecd_pat[_n_u64](uint64_t op, enum svpattern pattern, uint64_t imm_factor) + uint64_t svqdecd_pat<see href="uint64_t op, enum svpattern pattern, uint64_t imm_factor">_n_u64</see> UQDECD Xtied, pattern, MUL #imm_factor To be added. @@ -33642,7 +33642,7 @@ To be added. To be added. - int32_t svqdecb_pat[_n_s32](int32_t op, enum svpattern pattern, uint64_t imm_factor) + int32_t svqdecb_pat<see href="int32_t op, enum svpattern pattern, uint64_t imm_factor">_n_s32</see> SQDECB Xtied, Wtied, pattern, MUL #imm_factor To be added. @@ -33687,7 +33687,7 @@ To be added. To be added. - int64_t svqdecb_pat[_n_s64](int64_t op, enum svpattern pattern, uint64_t imm_factor) + int64_t svqdecb_pat<see href="int64_t op, enum svpattern pattern, uint64_t imm_factor">_n_s64</see> SQDECB Xtied, pattern, MUL #imm_factor To be added. @@ -33732,7 +33732,7 @@ To be added. To be added. - uint32_t svqdecb_pat[_n_u32](uint32_t op, enum svpattern pattern, uint64_t imm_factor) + uint32_t svqdecb_pat<see href="uint32_t op, enum svpattern pattern, uint64_t imm_factor">_n_u32</see> UQDECB Wtied, pattern, MUL #imm_factor To be added. @@ -33777,7 +33777,7 @@ To be added. To be added. - uint64_t svqdecb_pat[_n_u64](uint64_t op, enum svpattern pattern, uint64_t imm_factor) + uint64_t svqdecb_pat<see href="uint64_t op, enum svpattern pattern, uint64_t imm_factor">_n_u64</see> UQDECB Xtied, pattern, MUL #imm_factor To be added. @@ -34047,7 +34047,7 @@ To be added. To be added. - svint16_t svqdecp[_s16](svint16_t op, svbool_t pg) + svint16_t svqdecp<see href="svint16_t op, svbool_t pg">_s16</see> SQDECP Ztied.H, Pg To be added. @@ -34077,7 +34077,7 @@ To be added. To be added. - svint32_t svqdecp[_s32](svint32_t op, svbool_t pg) + svint32_t svqdecp<see href="svint32_t op, svbool_t pg">_s32</see> SQDECP Ztied.S, Pg To be added. @@ -34107,7 +34107,7 @@ To be added. To be added. - svint64_t svqdecp[_s64](svint64_t op, svbool_t pg) + svint64_t svqdecp<see href="svint64_t op, svbool_t pg">_s64</see> SQDECP Ztied.D, Pg To be added. @@ -34137,7 +34137,7 @@ To be added. To be added. - svuint16_t svqdecp[_u16](svuint16_t op, svbool_t pg) + svuint16_t svqdecp<see href="svuint16_t op, svbool_t pg">_u16</see> UQDECP Ztied.H, Pg To be added. @@ -34167,7 +34167,7 @@ To be added. To be added. - svuint32_t svqdecp[_u32](svuint32_t op, svbool_t pg) + svuint32_t svqdecp<see href="svuint32_t op, svbool_t pg">_u32</see> UQDECP Ztied.S, Pg To be added. @@ -34197,7 +34197,7 @@ To be added. To be added. - svuint64_t svqdecp[_u64](svuint64_t op, svbool_t pg) + svuint64_t svqdecp<see href="svuint64_t op, svbool_t pg">_u64</see> UQDECP Ztied.D, Pg To be added. @@ -34482,7 +34482,7 @@ To be added. To be added. - int32_t svqinch_pat[_n_s32](int32_t op, enum svpattern pattern, uint64_t imm_factor) + int32_t svqinch_pat<see href="int32_t op, enum svpattern pattern, uint64_t imm_factor">_n_s32</see> SQINCH Xtied, Wtied, pattern, MUL #imm_factor To be added. @@ -34527,7 +34527,7 @@ To be added. To be added. - int64_t svqinch_pat[_n_s64](int64_t op, enum svpattern pattern, uint64_t imm_factor) + int64_t svqinch_pat<see href="int64_t op, enum svpattern pattern, uint64_t imm_factor">_n_s64</see> SQINCH Xtied, pattern, MUL #imm_factor To be added. @@ -34572,7 +34572,7 @@ To be added. To be added. - svint16_t svqinch_pat[_s16](svint16_t op, enum svpattern pattern, uint64_t imm_factor) + svint16_t svqinch_pat<see href="svint16_t op, enum svpattern pattern, uint64_t imm_factor">_s16</see> SQINCH Ztied.H, pattern, MUL #imm_factor To be added. @@ -34617,7 +34617,7 @@ To be added. To be added. - svuint16_t svqinch_pat[_u16](svuint16_t op, enum svpattern pattern, uint64_t imm_factor) + svuint16_t svqinch_pat<see href="svuint16_t op, enum svpattern pattern, uint64_t imm_factor">_u16</see> UQINCH Ztied.H, pattern, MUL #imm_factor To be added. @@ -34662,7 +34662,7 @@ To be added. To be added. - uint32_t svqinch_pat[_n_u32](uint32_t op, enum svpattern pattern, uint64_t imm_factor) + uint32_t svqinch_pat<see href="uint32_t op, enum svpattern pattern, uint64_t imm_factor">_n_u32</see> UQINCH Wtied, pattern, MUL #imm_factor To be added. @@ -34707,7 +34707,7 @@ To be added. To be added. - uint64_t svqinch_pat[_n_u64](uint64_t op, enum svpattern pattern, uint64_t imm_factor) + uint64_t svqinch_pat<see href="uint64_t op, enum svpattern pattern, uint64_t imm_factor">_n_u64</see> UQINCH Xtied, pattern, MUL #imm_factor To be added. @@ -34752,7 +34752,7 @@ To be added. To be added. - int32_t svqincw_pat[_n_s32](int32_t op, enum svpattern pattern, uint64_t imm_factor) + int32_t svqincw_pat<see href="int32_t op, enum svpattern pattern, uint64_t imm_factor">_n_s32</see> SQINCW Xtied, Wtied, pattern, MUL #imm_factor To be added. @@ -34797,7 +34797,7 @@ To be added. To be added. - int64_t svqincw_pat[_n_s64](int64_t op, enum svpattern pattern, uint64_t imm_factor) + int64_t svqincw_pat<see href="int64_t op, enum svpattern pattern, uint64_t imm_factor">_n_s64</see> SQINCW Xtied, pattern, MUL #imm_factor To be added. @@ -34842,7 +34842,7 @@ To be added. To be added. - svint32_t svqincw_pat[_s32](svint32_t op, enum svpattern pattern, uint64_t imm_factor) + svint32_t svqincw_pat<see href="svint32_t op, enum svpattern pattern, uint64_t imm_factor">_s32</see> SQINCW Ztied.S, pattern, MUL #imm_factor To be added. @@ -34887,7 +34887,7 @@ To be added. To be added. - svuint32_t svqincw_pat[_u32](svuint32_t op, enum svpattern pattern, uint64_t imm_factor) + svuint32_t svqincw_pat<see href="svuint32_t op, enum svpattern pattern, uint64_t imm_factor">_u32</see> UQINCW Ztied.S, pattern, MUL #imm_factor To be added. @@ -34932,7 +34932,7 @@ To be added. To be added. - uint32_t svqincw_pat[_n_u32](uint32_t op, enum svpattern pattern, uint64_t imm_factor) + uint32_t svqincw_pat<see href="uint32_t op, enum svpattern pattern, uint64_t imm_factor">_n_u32</see> UQINCW Wtied, pattern, MUL #imm_factor To be added. @@ -34977,7 +34977,7 @@ To be added. To be added. - uint64_t svqincw_pat[_n_u64](uint64_t op, enum svpattern pattern, uint64_t imm_factor) + uint64_t svqincw_pat<see href="uint64_t op, enum svpattern pattern, uint64_t imm_factor">_n_u64</see> UQINCW Xtied, pattern, MUL #imm_factor To be added. @@ -35022,7 +35022,7 @@ To be added. To be added. - int32_t svqincd_pat[_n_s32](int32_t op, enum svpattern pattern, uint64_t imm_factor) + int32_t svqincd_pat<see href="int32_t op, enum svpattern pattern, uint64_t imm_factor">_n_s32</see> SQINCD Xtied, Wtied, pattern, MUL #imm_factor To be added. @@ -35067,7 +35067,7 @@ To be added. To be added. - int64_t svqincd_pat[_n_s64](int64_t op, enum svpattern pattern, uint64_t imm_factor) + int64_t svqincd_pat<see href="int64_t op, enum svpattern pattern, uint64_t imm_factor">_n_s64</see> SQINCD Xtied, pattern, MUL #imm_factor To be added. @@ -35112,7 +35112,7 @@ To be added. To be added. - svint64_t svqincd_pat[_s64](svint64_t op, enum svpattern pattern, uint64_t imm_factor) + svint64_t svqincd_pat<see href="svint64_t op, enum svpattern pattern, uint64_t imm_factor">_s64</see> SQINCD Ztied.D, pattern, MUL #imm_factor To be added. @@ -35157,7 +35157,7 @@ To be added. To be added. - svuint64_t svqincd_pat[_u64](svuint64_t op, enum svpattern pattern, uint64_t imm_factor) + svuint64_t svqincd_pat<see href="svuint64_t op, enum svpattern pattern, uint64_t imm_factor">_u64</see> UQINCD Ztied.D, pattern, MUL #imm_factor To be added. @@ -35202,7 +35202,7 @@ To be added. To be added. - uint32_t svqincd_pat[_n_u32](uint32_t op, enum svpattern pattern, uint64_t imm_factor) + uint32_t svqincd_pat<see href="uint32_t op, enum svpattern pattern, uint64_t imm_factor">_n_u32</see> UQINCD Wtied, pattern, MUL #imm_factor To be added. @@ -35247,7 +35247,7 @@ To be added. To be added. - uint64_t svqincd_pat[_n_u64](uint64_t op, enum svpattern pattern, uint64_t imm_factor) + uint64_t svqincd_pat<see href="uint64_t op, enum svpattern pattern, uint64_t imm_factor">_n_u64</see> UQINCD Xtied, pattern, MUL #imm_factor To be added. @@ -35292,7 +35292,7 @@ To be added. To be added. - int32_t svqincb_pat[_n_s32](int32_t op, enum svpattern pattern, uint64_t imm_factor) + int32_t svqincb_pat<see href="int32_t op, enum svpattern pattern, uint64_t imm_factor">_n_s32</see> SQINCB Xtied, Wtied, pattern, MUL #imm_factor To be added. @@ -35337,7 +35337,7 @@ To be added. To be added. - int64_t svqincb_pat[_n_s64](int64_t op, enum svpattern pattern, uint64_t imm_factor) + int64_t svqincb_pat<see href="int64_t op, enum svpattern pattern, uint64_t imm_factor">_n_s64</see> SQINCB Xtied, pattern, MUL #imm_factor To be added. @@ -35382,7 +35382,7 @@ To be added. To be added. - uint32_t svqincb_pat[_n_u32](uint32_t op, enum svpattern pattern, uint64_t imm_factor) + uint32_t svqincb_pat<see href="uint32_t op, enum svpattern pattern, uint64_t imm_factor">_n_u32</see> UQINCB Wtied, pattern, MUL #imm_factor To be added. @@ -35427,7 +35427,7 @@ To be added. To be added. - uint64_t svqincb_pat[_n_u64](uint64_t op, enum svpattern pattern, uint64_t imm_factor) + uint64_t svqincb_pat<see href="uint64_t op, enum svpattern pattern, uint64_t imm_factor">_n_u64</see> UQINCB Xtied, pattern, MUL #imm_factor To be added. @@ -35697,7 +35697,7 @@ To be added. To be added. - svint16_t svqincp[_s16](svint16_t op, svbool_t pg) + svint16_t svqincp<see href="svint16_t op, svbool_t pg">_s16</see> SQINCP Ztied.H, Pg To be added. @@ -35727,7 +35727,7 @@ To be added. To be added. - svint32_t svqincp[_s32](svint32_t op, svbool_t pg) + svint32_t svqincp<see href="svint32_t op, svbool_t pg">_s32</see> SQINCP Ztied.S, Pg To be added. @@ -35757,7 +35757,7 @@ To be added. To be added. - svint64_t svqincp[_s64](svint64_t op, svbool_t pg) + svint64_t svqincp<see href="svint64_t op, svbool_t pg">_s64</see> SQINCP Ztied.D, Pg To be added. @@ -35787,7 +35787,7 @@ To be added. To be added. - svuint16_t svqincp[_u16](svuint16_t op, svbool_t pg) + svuint16_t svqincp<see href="svuint16_t op, svbool_t pg">_u16</see> UQINCP Ztied.H, Pg To be added. @@ -35817,7 +35817,7 @@ To be added. To be added. - svuint32_t svqincp[_u32](svuint32_t op, svbool_t pg) + svuint32_t svqincp<see href="svuint32_t op, svbool_t pg">_u32</see> UQINCP Ztied.S, Pg To be added. @@ -35847,7 +35847,7 @@ To be added. To be added. - svuint64_t svqincp[_u64](svuint64_t op, svbool_t pg) + svuint64_t svqincp<see href="svuint64_t op, svbool_t pg">_u64</see> UQINCP Ztied.D, Pg To be added. @@ -36183,7 +36183,7 @@ To be added. To be added. - void svst1_scatter[_u64base_f64](svbool_t pg, svuint64_t bases, svfloat64_t data) + void svst1_scatter<see href="svbool_t pg, svuint64_t bases, svfloat64_t data">_u64base_f64</see> ST1D Zdata.D, Pg, [Zbases.D, #0] To be added. @@ -36214,7 +36214,7 @@ To be added. To be added. - void svst1_scatter[_u64base_s64](svbool_t pg, svuint64_t bases, svint64_t data) + void svst1_scatter<see href="svbool_t pg, svuint64_t bases, svint64_t data">_u64base_s64</see> ST1D Zdata.D, Pg, [Zbases.D, #0] To be added. @@ -36245,7 +36245,7 @@ To be added. To be added. - void svst1_scatter[_u64base_u64](svbool_t pg, svuint64_t bases, svuint64_t data) + void svst1_scatter<see href="svbool_t pg, svuint64_t bases, svuint64_t data">_u64base_u64</see> ST1D Zdata.D, Pg, [Zbases.D, #0] To be added. @@ -36277,7 +36277,7 @@ To be added. To be added. - void svst1_scatter_[s64]offset[_f64](svbool_t pg, float64_t *base, svint64_t offsets, svfloat64_t data) + void svst1_scatter_<see href="svbool_t pg, float64_t *base, svint64_t offsets, svfloat64_t data">s64]offset[_f64</see> ST1D Zdata.D, Pg, [Xbase, Zoffsets.D] To be added. @@ -36309,7 +36309,7 @@ To be added. To be added. - void svst1_scatter_[u64]offset[_f64](svbool_t pg, float64_t *base, svuint64_t offsets, svfloat64_t data) + void svst1_scatter_<see href="svbool_t pg, float64_t *base, svuint64_t offsets, svfloat64_t data">u64]offset[_f64</see> ST1D Zdata.D, Pg, [Xbase, Zoffsets.D] To be added. @@ -36341,7 +36341,7 @@ To be added. To be added. - void svst1_scatter_[s32]offset[_s32](svbool_t pg, int32_t *base, svint32_t offsets, svint32_t data) + void svst1_scatter_<see href="svbool_t pg, int32_t *base, svint32_t offsets, svint32_t data">s32]offset[_s32</see> ST1W Zdata.S, Pg, [Xbase, Zoffsets.S, SXTW] To be added. @@ -36373,7 +36373,7 @@ To be added. To be added. - void svst1_scatter_[u32]offset[_s32](svbool_t pg, int32_t *base, svuint32_t offsets, svint32_t data) + void svst1_scatter_<see href="svbool_t pg, int32_t *base, svuint32_t offsets, svint32_t data">u32]offset[_s32</see> ST1W Zdata.S, Pg, [Xbase, Zoffsets.S, UXTW] To be added. @@ -36405,7 +36405,7 @@ To be added. To be added. - void svst1_scatter_[s64]offset[_s64](svbool_t pg, int64_t *base, svint64_t offsets, svint64_t data) + void svst1_scatter_<see href="svbool_t pg, int64_t *base, svint64_t offsets, svint64_t data">s64]offset[_s64</see> ST1D Zdata.D, Pg, [Xbase, Zoffsets.D] To be added. @@ -36437,7 +36437,7 @@ To be added. To be added. - void svst1_scatter_[u64]offset[_s64](svbool_t pg, int64_t *base, svuint64_t offsets, svint64_t data) + void svst1_scatter_<see href="svbool_t pg, int64_t *base, svuint64_t offsets, svint64_t data">u64]offset[_s64</see> ST1D Zdata.D, Pg, [Xbase, Zoffsets.D] To be added. @@ -36469,7 +36469,7 @@ To be added. To be added. - void svst1_scatter_[s32]offset[_f32](svbool_t pg, float32_t *base, svint32_t offsets, svfloat32_t data) + void svst1_scatter_<see href="svbool_t pg, float32_t *base, svint32_t offsets, svfloat32_t data">s32]offset[_f32</see> ST1W Zdata.S, Pg, [Xbase, Zoffsets.S, SXTW] To be added. @@ -36501,7 +36501,7 @@ To be added. To be added. - void svst1_scatter_[u32]offset[_f32](svbool_t pg, float32_t *base, svuint32_t offsets, svfloat32_t data) + void svst1_scatter_<see href="svbool_t pg, float32_t *base, svuint32_t offsets, svfloat32_t data">u32]offset[_f32</see> ST1W Zdata.S, Pg, [Xbase, Zoffsets.S, UXTW] To be added. @@ -36533,7 +36533,7 @@ To be added. To be added. - void svst1_scatter_[s32]offset[_u32](svbool_t pg, uint32_t *base, svint32_t offsets, svuint32_t data) + void svst1_scatter_<see href="svbool_t pg, uint32_t *base, svint32_t offsets, svuint32_t data">s32]offset[_u32</see> ST1W Zdata.S, Pg, [Xbase, Zoffsets.S, SXTW] To be added. @@ -36565,7 +36565,7 @@ To be added. To be added. - void svst1_scatter_[u32]offset[_u32](svbool_t pg, uint32_t *base, svuint32_t offsets, svuint32_t data) + void svst1_scatter_<see href="svbool_t pg, uint32_t *base, svuint32_t offsets, svuint32_t data">u32]offset[_u32</see> ST1W Zdata.S, Pg, [Xbase, Zoffsets.S, UXTW] To be added. @@ -36597,7 +36597,7 @@ To be added. To be added. - void svst1_scatter_[s64]offset[_u64](svbool_t pg, uint64_t *base, svint64_t offsets, svuint64_t data) + void svst1_scatter_<see href="svbool_t pg, uint64_t *base, svint64_t offsets, svuint64_t data">s64]offset[_u64</see> ST1D Zdata.D, Pg, [Xbase, Zoffsets.D] To be added. @@ -36629,7 +36629,7 @@ To be added. To be added. - void svst1_scatter_[u64]offset[_u64](svbool_t pg, uint64_t *base, svuint64_t offsets, svuint64_t data) + void svst1_scatter_<see href="svbool_t pg, uint64_t *base, svuint64_t offsets, svuint64_t data">u64]offset[_u64</see> ST1D Zdata.D, Pg, [Xbase, Zoffsets.D] To be added. @@ -36660,7 +36660,7 @@ To be added. To be added. - void svst1h_scatter[_u64base_s64](svbool_t pg, svuint64_t bases, svint64_t data) + void svst1h_scatter<see href="svbool_t pg, svuint64_t bases, svint64_t data">_u64base_s64</see> ST1H Zdata.D, Pg, [Zbases.D, #0] To be added. @@ -36691,7 +36691,7 @@ To be added. To be added. - void svst1h_scatter[_u64base_u64](svbool_t pg, svuint64_t bases, svuint64_t data) + void svst1h_scatter<see href="svbool_t pg, svuint64_t bases, svuint64_t data">_u64base_u64</see> ST1H Zdata.D, Pg, [Zbases.D, #0] To be added. @@ -36723,7 +36723,7 @@ To be added. To be added. - void svst1h_scatter_[s32]offset[_s32](svbool_t pg, int16_t *base, svint32_t offsets, svint32_t data) + void svst1h_scatter_<see href="svbool_t pg, int16_t *base, svint32_t offsets, svint32_t data">s32]offset[_s32</see> ST1H Zdata.S, Pg, [Xbase, Zoffsets.S, SXTW] To be added. @@ -36755,7 +36755,7 @@ To be added. To be added. - void svst1h_scatter_[u32]offset[_s32](svbool_t pg, int16_t *base, svuint32_t offsets, svint32_t data) + void svst1h_scatter_<see href="svbool_t pg, int16_t *base, svuint32_t offsets, svint32_t data">u32]offset[_s32</see> ST1H Zdata.S, Pg, [Xbase, Zoffsets.S, UXTW] To be added. @@ -36787,7 +36787,7 @@ To be added. To be added. - void svst1h_scatter_[s64]offset[_s64](svbool_t pg, int16_t *base, svint64_t offsets, svint64_t data) + void svst1h_scatter_<see href="svbool_t pg, int16_t *base, svint64_t offsets, svint64_t data">s64]offset[_s64</see> ST1H Zdata.D, Pg, [Xbase, Zoffsets.D] To be added. @@ -36819,7 +36819,7 @@ To be added. To be added. - void svst1h_scatter_[u64]offset[_s64](svbool_t pg, int16_t *base, svuint64_t offsets, svint64_t data) + void svst1h_scatter_<see href="svbool_t pg, int16_t *base, svuint64_t offsets, svint64_t data">u64]offset[_s64</see> ST1H Zdata.D, Pg, [Xbase, Zoffsets.D] To be added. @@ -36851,7 +36851,7 @@ To be added. To be added. - void svst1h_scatter_[s32]offset[_u32](svbool_t pg, uint16_t *base, svint32_t offsets, svuint32_t data) + void svst1h_scatter_<see href="svbool_t pg, uint16_t *base, svint32_t offsets, svuint32_t data">s32]offset[_u32</see> ST1H Zdata.S, Pg, [Xbase, Zoffsets.S, SXTW] To be added. @@ -36883,7 +36883,7 @@ To be added. To be added. - void svst1h_scatter_[u32]offset[_u32](svbool_t pg, uint16_t *base, svuint32_t offsets, svuint32_t data) + void svst1h_scatter_<see href="svbool_t pg, uint16_t *base, svuint32_t offsets, svuint32_t data">u32]offset[_u32</see> ST1H Zdata.S, Pg, [Xbase, Zoffsets.S, UXTW] To be added. @@ -36915,7 +36915,7 @@ To be added. To be added. - void svst1h_scatter_[s64]offset[_u64](svbool_t pg, uint16_t *base, svint64_t offsets, svuint64_t data) + void svst1h_scatter_<see href="svbool_t pg, uint16_t *base, svint64_t offsets, svuint64_t data">s64]offset[_u64</see> ST1H Zdata.D, Pg, [Xbase, Zoffsets.D] To be added. @@ -36947,7 +36947,7 @@ To be added. To be added. - void svst1h_scatter_[u64]offset[_u64](svbool_t pg, uint16_t *base, svuint64_t offsets, svuint64_t data) + void svst1h_scatter_<see href="svbool_t pg, uint16_t *base, svuint64_t offsets, svuint64_t data">u64]offset[_u64</see> ST1H Zdata.D, Pg, [Xbase, Zoffsets.D] To be added. @@ -36978,7 +36978,7 @@ To be added. To be added. - void svst1w_scatter[_u64base_s64](svbool_t pg, svuint64_t bases, svint64_t data) + void svst1w_scatter<see href="svbool_t pg, svuint64_t bases, svint64_t data">_u64base_s64</see> ST1W Zdata.D, Pg, [Zbases.D, #0] To be added. @@ -37009,7 +37009,7 @@ To be added. To be added. - void svst1w_scatter[_u64base_u64](svbool_t pg, svuint64_t bases, svuint64_t data) + void svst1w_scatter<see href="svbool_t pg, svuint64_t bases, svuint64_t data">_u64base_u64</see> ST1W Zdata.D, Pg, [Zbases.D, #0] To be added. @@ -37041,7 +37041,7 @@ To be added. To be added. - void svst1w_scatter_[s64]offset[_s64](svbool_t pg, int32_t *base, svint64_t offsets, svint64_t data) + void svst1w_scatter_<see href="svbool_t pg, int32_t *base, svint64_t offsets, svint64_t data">s64]offset[_s64</see> ST1W Zdata.D, Pg, [Xbase, Zoffsets.D] To be added. @@ -37073,7 +37073,7 @@ To be added. To be added. - void svst1w_scatter_[u64]offset[_s64](svbool_t pg, int32_t *base, svuint64_t offsets, svint64_t data) + void svst1w_scatter_<see href="svbool_t pg, int32_t *base, svuint64_t offsets, svint64_t data">u64]offset[_s64</see> ST1W Zdata.D, Pg, [Xbase, Zoffsets.D] To be added. @@ -37105,7 +37105,7 @@ To be added. To be added. - void svst1w_scatter_[s64]offset[_u64](svbool_t pg, uint32_t *base, svint64_t offsets, svuint64_t data) + void svst1w_scatter_<see href="svbool_t pg, uint32_t *base, svint64_t offsets, svuint64_t data">s64]offset[_u64</see> ST1W Zdata.D, Pg, [Xbase, Zoffsets.D] To be added. @@ -37137,7 +37137,7 @@ To be added. To be added. - void svst1w_scatter_[u64]offset[_u64](svbool_t pg, uint32_t *base, svuint64_t offsets, svuint64_t data) + void svst1w_scatter_<see href="svbool_t pg, uint32_t *base, svuint64_t offsets, svuint64_t data">u64]offset[_u64</see> ST1W Zdata.D, Pg, [Xbase, Zoffsets.D] To be added. @@ -37168,7 +37168,7 @@ To be added. To be added. - void svst1b_scatter[_u64base_s64](svbool_t pg, svuint64_t bases, svint64_t data) + void svst1b_scatter<see href="svbool_t pg, svuint64_t bases, svint64_t data">_u64base_s64</see> ST1B Zdata.D, Pg, [Zbases.D, #0] To be added. @@ -37199,7 +37199,7 @@ To be added. To be added. - void svst1b_scatter[_u64base_u64](svbool_t pg, svuint64_t bases, svuint64_t data) + void svst1b_scatter<see href="svbool_t pg, svuint64_t bases, svuint64_t data">_u64base_u64</see> ST1B Zdata.D, Pg, [Zbases.D, #0] To be added. @@ -37231,7 +37231,7 @@ To be added. To be added. - void svst1b_scatter_[s32]offset[_s32](svbool_t pg, int8_t *base, svint32_t offsets, svint32_t data) + void svst1b_scatter_<see href="svbool_t pg, int8_t *base, svint32_t offsets, svint32_t data">s32]offset[_s32</see> ST1B Zdata.S, Pg, [Xbase, Zoffsets.S, SXTW] To be added. @@ -37263,7 +37263,7 @@ To be added. To be added. - void svst1b_scatter_[u32]offset[_s32](svbool_t pg, int8_t *base, svuint32_t offsets, svint32_t data) + void svst1b_scatter_<see href="svbool_t pg, int8_t *base, svuint32_t offsets, svint32_t data">u32]offset[_s32</see> ST1B Zdata.S, Pg, [Xbase, Zoffsets.S, UXTW] To be added. @@ -37295,7 +37295,7 @@ To be added. To be added. - void svst1b_scatter_[s64]offset[_s64](svbool_t pg, int8_t *base, svint64_t offsets, svint64_t data) + void svst1b_scatter_<see href="svbool_t pg, int8_t *base, svint64_t offsets, svint64_t data">s64]offset[_s64</see> ST1B Zdata.D, Pg, [Xbase, Zoffsets.D] To be added. @@ -37327,7 +37327,7 @@ To be added. To be added. - void svst1b_scatter_[u64]offset[_s64](svbool_t pg, int8_t *base, svuint64_t offsets, svint64_t data) + void svst1b_scatter_<see href="svbool_t pg, int8_t *base, svuint64_t offsets, svint64_t data">u64]offset[_s64</see> ST1B Zdata.D, Pg, [Xbase, Zoffsets.D] To be added. @@ -37359,7 +37359,7 @@ To be added. To be added. - void svst1b_scatter_[s32]offset[_u32](svbool_t pg, uint8_t *base, svint32_t offsets, svuint32_t data) + void svst1b_scatter_<see href="svbool_t pg, uint8_t *base, svint32_t offsets, svuint32_t data">s32]offset[_u32</see> ST1B Zdata.S, Pg, [Xbase, Zoffsets.S, SXTW] To be added. @@ -37391,7 +37391,7 @@ To be added. To be added. - void svst1b_scatter_[u32]offset[_u32](svbool_t pg, uint8_t *base, svuint32_t offsets, svuint32_t data) + void svst1b_scatter_<see href="svbool_t pg, uint8_t *base, svuint32_t offsets, svuint32_t data">u32]offset[_u32</see> ST1B Zdata.S, Pg, [Xbase, Zoffsets.S, UXTW] To be added. @@ -37423,7 +37423,7 @@ To be added. To be added. - void svst1b_scatter_[s64]offset[_u64](svbool_t pg, uint8_t *base, svint64_t offsets, svuint64_t data) + void svst1b_scatter_<see href="svbool_t pg, uint8_t *base, svint64_t offsets, svuint64_t data">s64]offset[_u64</see> ST1B Zdata.D, Pg, [Xbase, Zoffsets.D] To be added. @@ -37455,7 +37455,7 @@ To be added. To be added. - void svst1b_scatter_[u64]offset[_u64](svbool_t pg, uint8_t *base, svuint64_t offsets, svuint64_t data) + void svst1b_scatter_<see href="svbool_t pg, uint8_t *base, svuint64_t offsets, svuint64_t data">u64]offset[_u64</see> ST1B Zdata.D, Pg, [Xbase, Zoffsets.D] To be added. @@ -38906,7 +38906,7 @@ To be added. - svint32_t svunpklo[_s32](svint16_t op) + svint32_t svunpklo<see href="svint16_t op">_s32</see> SUNPKLO Zresult.S, Zop.H To be added. @@ -38934,7 +38934,7 @@ To be added. - svint64_t svunpklo[_s64](svint32_t op) + svint64_t svunpklo<see href="svint32_t op">_s64</see> SUNPKLO Zresult.D, Zop.S To be added. @@ -38962,7 +38962,7 @@ To be added. - svint16_t svunpklo[_s16](svint8_t op) + svint16_t svunpklo<see href="svint8_t op">_s16</see> SUNPKLO Zresult.H, Zop.B To be added. @@ -38990,7 +38990,7 @@ To be added. - svint32_t svunpkhi[_s32](svint16_t op) + svint32_t svunpkhi<see href="svint16_t op">_s32</see> SUNPKHI Zresult.S, Zop.H To be added. @@ -39018,7 +39018,7 @@ To be added. - svint64_t svunpkhi[_s64](svint32_t op) + svint64_t svunpkhi<see href="svint32_t op">_s64</see> SUNPKHI Zresult.D, Zop.S To be added. @@ -39046,7 +39046,7 @@ To be added. - svint16_t svunpkhi[_s16](svint8_t op) + svint16_t svunpkhi<see href="svint8_t op">_s16</see> SUNPKHI Zresult.H, Zop.B To be added. @@ -39078,7 +39078,7 @@ To be added. To be added. - svuint8_t svsplice[_u8](svbool_t pg, svuint8_t op1, svuint8_t op2) + svuint8_t svsplice<see href="svbool_t pg, svuint8_t op1, svuint8_t op2">_u8</see> SPLICE Ztied1.B, Pg, Ztied1.B, Zop2.B To be added. @@ -39110,7 +39110,7 @@ To be added. To be added. - svfloat64_t svsplice[_f64](svbool_t pg, svfloat64_t op1, svfloat64_t op2) + svfloat64_t svsplice<see href="svbool_t pg, svfloat64_t op1, svfloat64_t op2">_f64</see> SPLICE Ztied1.D, Pg, Ztied1.D, Zop2.D To be added. @@ -39142,7 +39142,7 @@ To be added. To be added. - svint16_t svsplice[_s16](svbool_t pg, svint16_t op1, svint16_t op2) + svint16_t svsplice<see href="svbool_t pg, svint16_t op1, svint16_t op2">_s16</see> SPLICE Ztied1.H, Pg, Ztied1.H, Zop2.H To be added. @@ -39174,7 +39174,7 @@ To be added. To be added. - svint32_t svsplice[_s32](svbool_t pg, svint32_t op1, svint32_t op2) + svint32_t svsplice<see href="svbool_t pg, svint32_t op1, svint32_t op2">_s32</see> SPLICE Ztied1.S, Pg, Ztied1.S, Zop2.S To be added. @@ -39206,7 +39206,7 @@ To be added. To be added. - svint64_t svsplice[_s64](svbool_t pg, svint64_t op1, svint64_t op2) + svint64_t svsplice<see href="svbool_t pg, svint64_t op1, svint64_t op2">_s64</see> SPLICE Ztied1.D, Pg, Ztied1.D, Zop2.D To be added. @@ -39238,7 +39238,7 @@ To be added. To be added. - svint8_t svsplice[_s8](svbool_t pg, svint8_t op1, svint8_t op2) + svint8_t svsplice<see href="svbool_t pg, svint8_t op1, svint8_t op2">_s8</see> SPLICE Ztied1.B, Pg, Ztied1.B, Zop2.B To be added. @@ -39270,7 +39270,7 @@ To be added. To be added. - svfloat32_t svsplice[_f32](svbool_t pg, svfloat32_t op1, svfloat32_t op2) + svfloat32_t svsplice<see href="svbool_t pg, svfloat32_t op1, svfloat32_t op2">_f32</see> SPLICE Ztied1.S, Pg, Ztied1.S, Zop2.S To be added. @@ -39302,7 +39302,7 @@ To be added. To be added. - svuint16_t svsplice[_u16](svbool_t pg, svuint16_t op1, svuint16_t op2) + svuint16_t svsplice<see href="svbool_t pg, svuint16_t op1, svuint16_t op2">_u16</see> SPLICE Ztied1.H, Pg, Ztied1.H, Zop2.H To be added. @@ -39334,7 +39334,7 @@ To be added. To be added. - svuint32_t svsplice[_u32](svbool_t pg, svuint32_t op1, svuint32_t op2) + svuint32_t svsplice<see href="svbool_t pg, svuint32_t op1, svuint32_t op2">_u32</see> SPLICE Ztied1.S, Pg, Ztied1.S, Zop2.S To be added. @@ -39366,7 +39366,7 @@ To be added. To be added. - svuint64_t svsplice[_u64](svbool_t pg, svuint64_t op1, svuint64_t op2) + svuint64_t svsplice<see href="svbool_t pg, svuint64_t op1, svuint64_t op2">_u64</see> SPLICE Ztied1.D, Pg, Ztied1.D, Zop2.D To be added. @@ -39457,7 +39457,7 @@ To be added. To be added. - void svst1[_u8](svbool_t pg, uint8_t *base, svuint8_t data) + void svst1<see href="svbool_t pg, uint8_t *base, svuint8_t data">_u8</see> ST1B Zdata.B, Pg, [Xbase, #0, MUL VL] To be added. @@ -39494,7 +39494,7 @@ To be added. To be added. - void svst4[_u8](svbool_t pg, uint8_t *base, svuint8x4_t data) + void svst4<see href="svbool_t pg, uint8_t *base, svuint8x4_t data">_u8</see> ST4B {Zdata0.B - Zdata3.B}, Pg, [Xbase, #0, MUL VL] To be added. @@ -39531,7 +39531,7 @@ To be added. To be added. - void svst3[_u8](svbool_t pg, uint8_t *base, svuint8x3_t data) + void svst3<see href="svbool_t pg, uint8_t *base, svuint8x3_t data">_u8</see> ST3B {Zdata0.B - Zdata2.B}, Pg, [Xbase, #0, MUL VL] To be added. @@ -39568,7 +39568,7 @@ To be added. To be added. - void svst2[_u8](svbool_t pg, uint8_t *base, svuint8x2_t data) + void svst2<see href="svbool_t pg, uint8_t *base, svuint8x2_t data">_u8</see> ST2B {Zdata0.B, Zdata1.B}, Pg, [Xbase, #0, MUL VL] To be added. @@ -39598,7 +39598,7 @@ To be added. To be added. - void svst1[_f64](svbool_t pg, float64_t *base, svfloat64_t data) + void svst1<see href="svbool_t pg, float64_t *base, svfloat64_t data">_f64</see> ST1D Zdata.D, Pg, [Xbase, #0, MUL VL] To be added. @@ -39635,7 +39635,7 @@ To be added. To be added. - void svst4[_f64](svbool_t pg, float64_t *base, svfloat64x4_t data) + void svst4<see href="svbool_t pg, float64_t *base, svfloat64x4_t data">_f64</see> ST4D {Zdata0.D - Zdata3.D}, Pg, [Xbase, #0, MUL VL] To be added. @@ -39672,7 +39672,7 @@ To be added. To be added. - void svst3[_f64](svbool_t pg, float64_t *base, svfloat64x3_t data) + void svst3<see href="svbool_t pg, float64_t *base, svfloat64x3_t data">_f64</see> ST3D {Zdata0.D - Zdata2.D}, Pg, [Xbase, #0, MUL VL] To be added. @@ -39709,7 +39709,7 @@ To be added. To be added. - void svst2[_f64](svbool_t pg, float64_t *base, svfloat64x2_t data) + void svst2<see href="svbool_t pg, float64_t *base, svfloat64x2_t data">_f64</see> ST2D {Zdata0.D, Zdata1.D}, Pg, [Xbase, #0, MUL VL] To be added. @@ -39739,7 +39739,7 @@ To be added. To be added. - void svst1[_s16](svbool_t pg, int16_t *base, svint16_t data) + void svst1<see href="svbool_t pg, int16_t *base, svint16_t data">_s16</see> ST1H Zdata.H, Pg, [Xbase, #0, MUL VL] To be added. @@ -39776,7 +39776,7 @@ To be added. To be added. - void svst4[_s16](svbool_t pg, int16_t *base, svint16x4_t data) + void svst4<see href="svbool_t pg, int16_t *base, svint16x4_t data">_s16</see> ST4H {Zdata0.H - Zdata3.H}, Pg, [Xbase, #0, MUL VL] To be added. @@ -39813,7 +39813,7 @@ To be added. To be added. - void svst3[_s16](svbool_t pg, int16_t *base, svint16x3_t data) + void svst3<see href="svbool_t pg, int16_t *base, svint16x3_t data">_s16</see> ST3H {Zdata0.H - Zdata2.H}, Pg, [Xbase, #0, MUL VL] To be added. @@ -39850,7 +39850,7 @@ To be added. To be added. - void svst2[_s16](svbool_t pg, int16_t *base, svint16x2_t data) + void svst2<see href="svbool_t pg, int16_t *base, svint16x2_t data">_s16</see> ST2H {Zdata0.H, Zdata1.H}, Pg, [Xbase, #0, MUL VL] To be added. @@ -39880,7 +39880,7 @@ To be added. To be added. - void svst1[_s32](svbool_t pg, int32_t *base, svint32_t data) + void svst1<see href="svbool_t pg, int32_t *base, svint32_t data">_s32</see> ST1W Zdata.S, Pg, [Xbase, #0, MUL VL] To be added. @@ -39917,7 +39917,7 @@ To be added. To be added. - void svst4[_s32](svbool_t pg, int32_t *base, svint32x4_t data) + void svst4<see href="svbool_t pg, int32_t *base, svint32x4_t data">_s32</see> ST4W {Zdata0.S - Zdata3.S}, Pg, [Xbase, #0, MUL VL] To be added. @@ -39954,7 +39954,7 @@ To be added. To be added. - void svst3[_s32](svbool_t pg, int32_t *base, svint32x3_t data) + void svst3<see href="svbool_t pg, int32_t *base, svint32x3_t data">_s32</see> ST3W {Zdata0.S - Zdata2.S}, Pg, [Xbase, #0, MUL VL] To be added. @@ -39991,7 +39991,7 @@ To be added. To be added. - void svst2[_s32](svbool_t pg, int32_t *base, svint32x2_t data) + void svst2<see href="svbool_t pg, int32_t *base, svint32x2_t data">_s32</see> ST2W {Zdata0.S, Zdata1.S}, Pg, [Xbase, #0, MUL VL] To be added. @@ -40021,7 +40021,7 @@ To be added. To be added. - void svst1[_s64](svbool_t pg, int64_t *base, svint64_t data) + void svst1<see href="svbool_t pg, int64_t *base, svint64_t data">_s64</see> ST1D Zdata.D, Pg, [Xbase, #0, MUL VL] To be added. @@ -40058,7 +40058,7 @@ To be added. To be added. - void svst4[_s64](svbool_t pg, int64_t *base, svint64x4_t data) + void svst4<see href="svbool_t pg, int64_t *base, svint64x4_t data">_s64</see> ST4D {Zdata0.D - Zdata3.D}, Pg, [Xbase, #0, MUL VL] To be added. @@ -40095,7 +40095,7 @@ To be added. To be added. - void svst3[_s64](svbool_t pg, int64_t *base, svint64x3_t data) + void svst3<see href="svbool_t pg, int64_t *base, svint64x3_t data">_s64</see> ST3D {Zdata0.D - Zdata2.D}, Pg, [Xbase, #0, MUL VL] To be added. @@ -40132,7 +40132,7 @@ To be added. To be added. - void svst2[_s64](svbool_t pg, int64_t *base, svint64x2_t data) + void svst2<see href="svbool_t pg, int64_t *base, svint64x2_t data">_s64</see> ST2D {Zdata0.D, Zdata1.D}, Pg, [Xbase, #0, MUL VL] To be added. @@ -40162,7 +40162,7 @@ To be added. To be added. - void svst1[_s8](svbool_t pg, int8_t *base, svint8_t data) + void svst1<see href="svbool_t pg, int8_t *base, svint8_t data">_s8</see> ST1B Zdata.B, Pg, [Xbase, #0, MUL VL] To be added. @@ -40199,7 +40199,7 @@ To be added. To be added. - void svst4[_s8](svbool_t pg, int8_t *base, svint8x4_t data) + void svst4<see href="svbool_t pg, int8_t *base, svint8x4_t data">_s8</see> ST4B {Zdata0.B - Zdata3.B}, Pg, [Xbase, #0, MUL VL] To be added. @@ -40236,7 +40236,7 @@ To be added. To be added. - void svst3[_s8](svbool_t pg, int8_t *base, svint8x3_t data) + void svst3<see href="svbool_t pg, int8_t *base, svint8x3_t data">_s8</see> ST3B {Zdata0.B - Zdata2.B}, Pg, [Xbase, #0, MUL VL] To be added. @@ -40273,7 +40273,7 @@ To be added. To be added. - void svst2[_s8](svbool_t pg, int8_t *base, svint8x2_t data) + void svst2<see href="svbool_t pg, int8_t *base, svint8x2_t data">_s8</see> ST2B {Zdata0.B, Zdata1.B}, Pg, [Xbase, #0, MUL VL] To be added. @@ -40303,7 +40303,7 @@ To be added. To be added. - void svst1[_f32](svbool_t pg, float32_t *base, svfloat32_t data) + void svst1<see href="svbool_t pg, float32_t *base, svfloat32_t data">_f32</see> ST1W Zdata.S, Pg, [Xbase, #0, MUL VL] To be added. @@ -40340,7 +40340,7 @@ To be added. To be added. - void svst4[_f32](svbool_t pg, float32_t *base, svfloat32x4_t data) + void svst4<see href="svbool_t pg, float32_t *base, svfloat32x4_t data">_f32</see> ST4W {Zdata0.S - Zdata3.S}, Pg, [Xbase, #0, MUL VL] To be added. @@ -40377,7 +40377,7 @@ To be added. To be added. - void svst3[_f32](svbool_t pg, float32_t *base, svfloat32x3_t data) + void svst3<see href="svbool_t pg, float32_t *base, svfloat32x3_t data">_f32</see> ST3W {Zdata0.S - Zdata2.S}, Pg, [Xbase, #0, MUL VL] To be added. @@ -40414,7 +40414,7 @@ To be added. To be added. - void svst2[_f32](svbool_t pg, float32_t *base, svfloat32x2_t data) + void svst2<see href="svbool_t pg, float32_t *base, svfloat32x2_t data">_f32</see> ST2W {Zdata0.S, Zdata1.S}, Pg, [Xbase, #0, MUL VL] To be added. @@ -40444,7 +40444,7 @@ To be added. To be added. - void svst1[_u16](svbool_t pg, uint16_t *base, svuint16_t data) + void svst1<see href="svbool_t pg, uint16_t *base, svuint16_t data">_u16</see> ST1H Zdata.H, Pg, [Xbase, #0, MUL VL] To be added. @@ -40481,7 +40481,7 @@ To be added. To be added. - void svst4[_u16](svbool_t pg, uint16_t *base, svuint16x4_t data) + void svst4<see href="svbool_t pg, uint16_t *base, svuint16x4_t data">_u16</see> ST4H {Zdata0.H - Zdata3.H}, Pg, [Xbase, #0, MUL VL] To be added. @@ -40518,7 +40518,7 @@ To be added. To be added. - void svst3[_u16](svbool_t pg, uint16_t *base, svuint16x3_t data) + void svst3<see href="svbool_t pg, uint16_t *base, svuint16x3_t data">_u16</see> ST3H {Zdata0.H - Zdata2.H}, Pg, [Xbase, #0, MUL VL] To be added. @@ -40555,7 +40555,7 @@ To be added. To be added. - void svst2[_u16](svbool_t pg, uint16_t *base, svuint16x2_t data) + void svst2<see href="svbool_t pg, uint16_t *base, svuint16x2_t data">_u16</see> ST2H {Zdata0.H, Zdata1.H}, Pg, [Xbase, #0, MUL VL] To be added. @@ -40585,7 +40585,7 @@ To be added. To be added. - void svst1[_u32](svbool_t pg, uint32_t *base, svuint32_t data) + void svst1<see href="svbool_t pg, uint32_t *base, svuint32_t data">_u32</see> ST1W Zdata.S, Pg, [Xbase, #0, MUL VL] To be added. @@ -40622,7 +40622,7 @@ To be added. To be added. - void svst4[_u32](svbool_t pg, uint32_t *base, svuint32x4_t data) + void svst4<see href="svbool_t pg, uint32_t *base, svuint32x4_t data">_u32</see> ST4W {Zdata0.S - Zdata3.S}, Pg, [Xbase, #0, MUL VL] To be added. @@ -40659,7 +40659,7 @@ To be added. To be added. - void svst3[_u32](svbool_t pg, uint32_t *base, svuint32x3_t data) + void svst3<see href="svbool_t pg, uint32_t *base, svuint32x3_t data">_u32</see> ST3W {Zdata0.S - Zdata2.S}, Pg, [Xbase, #0, MUL VL] To be added. @@ -40696,7 +40696,7 @@ To be added. To be added. - void svst2[_u32](svbool_t pg, uint32_t *base, svuint32x2_t data) + void svst2<see href="svbool_t pg, uint32_t *base, svuint32x2_t data">_u32</see> ST2W {Zdata0.S, Zdata1.S}, Pg, [Xbase, #0, MUL VL] To be added. @@ -40726,7 +40726,7 @@ To be added. To be added. - void svst1[_u64](svbool_t pg, uint64_t *base, svuint64_t data) + void svst1<see href="svbool_t pg, uint64_t *base, svuint64_t data">_u64</see> ST1D Zdata.D, Pg, [Xbase, #0, MUL VL] To be added. @@ -40763,7 +40763,7 @@ To be added. To be added. - void svst4[_u64](svbool_t pg, uint64_t *base, svuint64x4_t data) + void svst4<see href="svbool_t pg, uint64_t *base, svuint64x4_t data">_u64</see> ST4D {Zdata0.D - Zdata3.D}, Pg, [Xbase, #0, MUL VL] To be added. @@ -40800,7 +40800,7 @@ To be added. To be added. - void svst3[_u64](svbool_t pg, uint64_t *base, svuint64x3_t data) + void svst3<see href="svbool_t pg, uint64_t *base, svuint64x3_t data">_u64</see> ST3D {Zdata0.D - Zdata2.D}, Pg, [Xbase, #0, MUL VL] To be added. @@ -40837,7 +40837,7 @@ To be added. To be added. - void svst2[_u64](svbool_t pg, uint64_t *base, svuint64x2_t data) + void svst2<see href="svbool_t pg, uint64_t *base, svuint64x2_t data">_u64</see> ST2D {Zdata0.D, Zdata1.D}, Pg, [Xbase, #0, MUL VL] To be added. @@ -40867,7 +40867,7 @@ To be added. To be added. - void svst1b[_s16](svbool_t pg, int8_t *base, svint16_t data) + void svst1b<see href="svbool_t pg, int8_t *base, svint16_t data">_s16</see> ST1B Zdata.H, Pg, [Xbase, #0, MUL VL] To be added. @@ -40897,7 +40897,7 @@ To be added. To be added. - void svst1h[_s32](svbool_t pg, int16_t *base, svint32_t data) + void svst1h<see href="svbool_t pg, int16_t *base, svint32_t data">_s32</see> ST1H Zdata.S, Pg, [Xbase, #0, MUL VL] To be added. @@ -40927,7 +40927,7 @@ To be added. To be added. - void svst1b[_s32](svbool_t pg, int8_t *base, svint32_t data) + void svst1b<see href="svbool_t pg, int8_t *base, svint32_t data">_s32</see> ST1B Zdata.S, Pg, [Xbase, #0, MUL VL] To be added. @@ -40957,7 +40957,7 @@ To be added. To be added. - void svst1h[_s64](svbool_t pg, int16_t *base, svint64_t data) + void svst1h<see href="svbool_t pg, int16_t *base, svint64_t data">_s64</see> ST1H Zdata.D, Pg, [Xbase, #0, MUL VL] To be added. @@ -40987,7 +40987,7 @@ To be added. To be added. - void svst1w[_s64](svbool_t pg, int32_t *base, svint64_t data) + void svst1w<see href="svbool_t pg, int32_t *base, svint64_t data">_s64</see> ST1W Zdata.D, Pg, [Xbase, #0, MUL VL] To be added. @@ -41017,7 +41017,7 @@ To be added. To be added. - void svst1b[_s64](svbool_t pg, int8_t *base, svint64_t data) + void svst1b<see href="svbool_t pg, int8_t *base, svint64_t data">_s64</see> ST1B Zdata.D, Pg, [Xbase, #0, MUL VL] To be added. @@ -41047,7 +41047,7 @@ To be added. To be added. - void svst1b[_u16](svbool_t pg, uint8_t *base, svuint16_t data) + void svst1b<see href="svbool_t pg, uint8_t *base, svuint16_t data">_u16</see> ST1B Zdata.H, Pg, [Xbase, #0, MUL VL] To be added. @@ -41077,7 +41077,7 @@ To be added. To be added. - void svst1b[_u32](svbool_t pg, uint8_t *base, svuint32_t data) + void svst1b<see href="svbool_t pg, uint8_t *base, svuint32_t data">_u32</see> ST1B Zdata.S, Pg, [Xbase, #0, MUL VL] To be added. @@ -41107,7 +41107,7 @@ To be added. To be added. - void svst1h[_u32](svbool_t pg, uint16_t *base, svuint32_t data) + void svst1h<see href="svbool_t pg, uint16_t *base, svuint32_t data">_u32</see> ST1H Zdata.S, Pg, [Xbase, #0, MUL VL] To be added. @@ -41137,7 +41137,7 @@ To be added. To be added. - void svst1b[_u64](svbool_t pg, uint8_t *base, svuint64_t data) + void svst1b<see href="svbool_t pg, uint8_t *base, svuint64_t data">_u64</see> ST1B Zdata.D, Pg, [Xbase, #0, MUL VL] To be added. @@ -41167,7 +41167,7 @@ To be added. To be added. - void svst1h[_u64](svbool_t pg, uint16_t *base, svuint64_t data) + void svst1h<see href="svbool_t pg, uint16_t *base, svuint64_t data">_u64</see> ST1H Zdata.D, Pg, [Xbase, #0, MUL VL] To be added. @@ -41197,7 +41197,7 @@ To be added. To be added. - void svst1w[_u64](svbool_t pg, uint32_t *base, svuint64_t data) + void svst1w<see href="svbool_t pg, uint32_t *base, svuint64_t data">_u64</see> ST1W Zdata.D, Pg, [Xbase, #0, MUL VL] To be added. @@ -41227,7 +41227,7 @@ To be added. To be added. - void svstnt1[_u8](svbool_t pg, uint8_t *base, svuint8_t data) + void svstnt1<see href="svbool_t pg, uint8_t *base, svuint8_t data">_u8</see> STNT1B Zdata.B, Pg, [Xbase, #0, MUL VL] To be added. @@ -41257,7 +41257,7 @@ To be added. To be added. - void svstnt1[_f64](svbool_t pg, float64_t *base, svfloat64_t data) + void svstnt1<see href="svbool_t pg, float64_t *base, svfloat64_t data">_f64</see> STNT1D Zdata.D, Pg, [Xbase, #0, MUL VL] To be added. @@ -41287,7 +41287,7 @@ To be added. To be added. - void svstnt1[_s16](svbool_t pg, int16_t *base, svint16_t data) + void svstnt1<see href="svbool_t pg, int16_t *base, svint16_t data">_s16</see> STNT1H Zdata.H, Pg, [Xbase, #0, MUL VL] To be added. @@ -41317,7 +41317,7 @@ To be added. To be added. - void svstnt1[_s32](svbool_t pg, int32_t *base, svint32_t data) + void svstnt1<see href="svbool_t pg, int32_t *base, svint32_t data">_s32</see> STNT1W Zdata.S, Pg, [Xbase, #0, MUL VL] To be added. @@ -41347,7 +41347,7 @@ To be added. To be added. - void svstnt1[_s64](svbool_t pg, int64_t *base, svint64_t data) + void svstnt1<see href="svbool_t pg, int64_t *base, svint64_t data">_s64</see> STNT1D Zdata.D, Pg, [Xbase, #0, MUL VL] To be added. @@ -41377,7 +41377,7 @@ To be added. To be added. - void svstnt1[_s8](svbool_t pg, int8_t *base, svint8_t data) + void svstnt1<see href="svbool_t pg, int8_t *base, svint8_t data">_s8</see> STNT1B Zdata.B, Pg, [Xbase, #0, MUL VL] To be added. @@ -41407,7 +41407,7 @@ To be added. To be added. - void svstnt1[_f32](svbool_t pg, float32_t *base, svfloat32_t data) + void svstnt1<see href="svbool_t pg, float32_t *base, svfloat32_t data">_f32</see> STNT1W Zdata.S, Pg, [Xbase, #0, MUL VL] To be added. @@ -41437,7 +41437,7 @@ To be added. To be added. - void svstnt1[_u16](svbool_t pg, uint16_t *base, svuint16_t data) + void svstnt1<see href="svbool_t pg, uint16_t *base, svuint16_t data">_u16</see> STNT1H Zdata.H, Pg, [Xbase, #0, MUL VL] To be added. @@ -41467,7 +41467,7 @@ To be added. To be added. - void svstnt1[_u32](svbool_t pg, uint32_t *base, svuint32_t data) + void svstnt1<see href="svbool_t pg, uint32_t *base, svuint32_t data">_u32</see> STNT1W Zdata.S, Pg, [Xbase, #0, MUL VL] To be added. @@ -41497,7 +41497,7 @@ To be added. To be added. - void svstnt1[_u64](svbool_t pg, uint64_t *base, svuint64_t data) + void svstnt1<see href="svbool_t pg, uint64_t *base, svuint64_t data">_u64</see> STNT1D Zdata.D, Pg, [Xbase, #0, MUL VL] To be added. @@ -41846,7 +41846,7 @@ To be added. To be added. - svuint8_t svqsub[_u8](svuint8_t op1, svuint8_t op2) + svuint8_t svqsub<see href="svuint8_t op1, svuint8_t op2">_u8</see> UQSUB Zresult.B, Zop1.B, Zop2.B To be added. @@ -41876,7 +41876,7 @@ To be added. To be added. - svint16_t svqsub[_s16](svint16_t op1, svint16_t op2) + svint16_t svqsub<see href="svint16_t op1, svint16_t op2">_s16</see> SQSUB Zresult.H, Zop1.H, Zop2.H To be added. @@ -41906,7 +41906,7 @@ To be added. To be added. - svint32_t svqsub[_s32](svint32_t op1, svint32_t op2) + svint32_t svqsub<see href="svint32_t op1, svint32_t op2">_s32</see> SQSUB Zresult.S, Zop1.S, Zop2.S To be added. @@ -41936,7 +41936,7 @@ To be added. To be added. - svint64_t svqsub[_s64](svint64_t op1, svint64_t op2) + svint64_t svqsub<see href="svint64_t op1, svint64_t op2">_s64</see> SQSUB Zresult.D, Zop1.D, Zop2.D To be added. @@ -41966,7 +41966,7 @@ To be added. To be added. - svint8_t svqsub[_s8](svint8_t op1, svint8_t op2) + svint8_t svqsub<see href="svint8_t op1, svint8_t op2">_s8</see> SQSUB Zresult.B, Zop1.B, Zop2.B To be added. @@ -41996,7 +41996,7 @@ To be added. To be added. - svuint16_t svqsub[_u16](svuint16_t op1, svuint16_t op2) + svuint16_t svqsub<see href="svuint16_t op1, svuint16_t op2">_u16</see> UQSUB Zresult.H, Zop1.H, Zop2.H To be added. @@ -42026,7 +42026,7 @@ To be added. To be added. - svuint32_t svqsub[_u32](svuint32_t op1, svuint32_t op2) + svuint32_t svqsub<see href="svuint32_t op1, svuint32_t op2">_u32</see> UQSUB Zresult.S, Zop1.S, Zop2.S To be added. @@ -42056,7 +42056,7 @@ To be added. To be added. - svuint64_t svqsub[_u64](svuint64_t op1, svuint64_t op2) + svuint64_t svqsub<see href="svuint64_t op1, svuint64_t op2">_u64</see> UQSUB Zresult.D, Zop1.D, Zop2.D To be added. @@ -42806,7 +42806,7 @@ To be added. To be added. - svuint8_t svtrn1[_u8](svuint8_t op1, svuint8_t op2) + svuint8_t svtrn1<see href="svuint8_t op1, svuint8_t op2">_u8</see> TRN1 Zresult.B, Zop1.B, Zop2.B To be added. @@ -42836,7 +42836,7 @@ To be added. To be added. - svfloat64_t svtrn1[_f64](svfloat64_t op1, svfloat64_t op2) + svfloat64_t svtrn1<see href="svfloat64_t op1, svfloat64_t op2">_f64</see> TRN1 Zresult.D, Zop1.D, Zop2.D To be added. @@ -42866,7 +42866,7 @@ To be added. To be added. - svint16_t svtrn1[_s16](svint16_t op1, svint16_t op2) + svint16_t svtrn1<see href="svint16_t op1, svint16_t op2">_s16</see> TRN1 Zresult.H, Zop1.H, Zop2.H To be added. @@ -42896,7 +42896,7 @@ To be added. To be added. - svint32_t svtrn1[_s32](svint32_t op1, svint32_t op2) + svint32_t svtrn1<see href="svint32_t op1, svint32_t op2">_s32</see> TRN1 Zresult.S, Zop1.S, Zop2.S To be added. @@ -42926,7 +42926,7 @@ To be added. To be added. - svint64_t svtrn1[_s64](svint64_t op1, svint64_t op2) + svint64_t svtrn1<see href="svint64_t op1, svint64_t op2">_s64</see> TRN1 Zresult.D, Zop1.D, Zop2.D To be added. @@ -42956,7 +42956,7 @@ To be added. To be added. - svint8_t svtrn1[_s8](svint8_t op1, svint8_t op2) + svint8_t svtrn1<see href="svint8_t op1, svint8_t op2">_s8</see> TRN1 Zresult.B, Zop1.B, Zop2.B To be added. @@ -42986,7 +42986,7 @@ To be added. To be added. - svfloat32_t svtrn1[_f32](svfloat32_t op1, svfloat32_t op2) + svfloat32_t svtrn1<see href="svfloat32_t op1, svfloat32_t op2">_f32</see> TRN1 Zresult.S, Zop1.S, Zop2.S To be added. @@ -43016,7 +43016,7 @@ To be added. To be added. - svuint16_t svtrn1[_u16](svuint16_t op1, svuint16_t op2) + svuint16_t svtrn1<see href="svuint16_t op1, svuint16_t op2">_u16</see> TRN1 Zresult.H, Zop1.H, Zop2.H To be added. @@ -43046,7 +43046,7 @@ To be added. To be added. - svuint32_t svtrn1[_u32](svuint32_t op1, svuint32_t op2) + svuint32_t svtrn1<see href="svuint32_t op1, svuint32_t op2">_u32</see> TRN1 Zresult.S, Zop1.S, Zop2.S To be added. @@ -43076,7 +43076,7 @@ To be added. To be added. - svuint64_t svtrn1[_u64](svuint64_t op1, svuint64_t op2) + svuint64_t svtrn1<see href="svuint64_t op1, svuint64_t op2">_u64</see> TRN1 Zresult.D, Zop1.D, Zop2.D To be added. @@ -43106,7 +43106,7 @@ To be added. To be added. - svuint8_t svtrn2[_u8](svuint8_t op1, svuint8_t op2) + svuint8_t svtrn2<see href="svuint8_t op1, svuint8_t op2">_u8</see> TRN2 Zresult.B, Zop1.B, Zop2.B To be added. @@ -43136,7 +43136,7 @@ To be added. To be added. - svfloat64_t svtrn2[_f64](svfloat64_t op1, svfloat64_t op2) + svfloat64_t svtrn2<see href="svfloat64_t op1, svfloat64_t op2">_f64</see> TRN2 Zresult.D, Zop1.D, Zop2.D To be added. @@ -43166,7 +43166,7 @@ To be added. To be added. - svint16_t svtrn2[_s16](svint16_t op1, svint16_t op2) + svint16_t svtrn2<see href="svint16_t op1, svint16_t op2">_s16</see> TRN2 Zresult.H, Zop1.H, Zop2.H To be added. @@ -43196,7 +43196,7 @@ To be added. To be added. - svint32_t svtrn2[_s32](svint32_t op1, svint32_t op2) + svint32_t svtrn2<see href="svint32_t op1, svint32_t op2">_s32</see> TRN2 Zresult.S, Zop1.S, Zop2.S To be added. @@ -43226,7 +43226,7 @@ To be added. To be added. - svint64_t svtrn2[_s64](svint64_t op1, svint64_t op2) + svint64_t svtrn2<see href="svint64_t op1, svint64_t op2">_s64</see> TRN2 Zresult.D, Zop1.D, Zop2.D To be added. @@ -43256,7 +43256,7 @@ To be added. To be added. - svint8_t svtrn2[_s8](svint8_t op1, svint8_t op2) + svint8_t svtrn2<see href="svint8_t op1, svint8_t op2">_s8</see> TRN2 Zresult.B, Zop1.B, Zop2.B To be added. @@ -43286,7 +43286,7 @@ To be added. To be added. - svfloat32_t svtrn2[_f32](svfloat32_t op1, svfloat32_t op2) + svfloat32_t svtrn2<see href="svfloat32_t op1, svfloat32_t op2">_f32</see> TRN2 Zresult.S, Zop1.S, Zop2.S To be added. @@ -43316,7 +43316,7 @@ To be added. To be added. - svuint16_t svtrn2[_u16](svuint16_t op1, svuint16_t op2) + svuint16_t svtrn2<see href="svuint16_t op1, svuint16_t op2">_u16</see> TRN2 Zresult.H, Zop1.H, Zop2.H To be added. @@ -43346,7 +43346,7 @@ To be added. To be added. - svuint32_t svtrn2[_u32](svuint32_t op1, svuint32_t op2) + svuint32_t svtrn2<see href="svuint32_t op1, svuint32_t op2">_u32</see> TRN2 Zresult.S, Zop1.S, Zop2.S To be added. @@ -43376,7 +43376,7 @@ To be added. To be added. - svuint64_t svtrn2[_u64](svuint64_t op1, svuint64_t op2) + svuint64_t svtrn2<see href="svuint64_t op1, svuint64_t op2">_u64</see> TRN2 Zresult.D, Zop1.D, Zop2.D To be added. @@ -43415,7 +43415,7 @@ To be added. To be added. - svfloat64_t svtmad[_f64](svfloat64_t op1, svfloat64_t op2, uint64_t imm3) + svfloat64_t svtmad<see href="svfloat64_t op1, svfloat64_t op2, uint64_t imm3">_f64</see> FTMAD Ztied1.D, Ztied1.D, Zop2.D, #imm3 To be added. @@ -43454,7 +43454,7 @@ To be added. To be added. - svfloat32_t svtmad[_f32](svfloat32_t op1, svfloat32_t op2, uint64_t imm3) + svfloat32_t svtmad<see href="svfloat32_t op1, svfloat32_t op2, uint64_t imm3">_f32</see> FTMAD Ztied1.S, Ztied1.S, Zop2.S, #imm3 To be added. @@ -43484,7 +43484,7 @@ To be added. To be added. - svfloat64_t svtssel[_f64](svfloat64_t op1, svuint64_t op2) + svfloat64_t svtssel<see href="svfloat64_t op1, svuint64_t op2">_f64</see> FTSSEL Zresult.D, Zop1.D, Zop2.D To be added. @@ -43514,7 +43514,7 @@ To be added. To be added. - svfloat32_t svtssel[_f32](svfloat32_t op1, svuint32_t op2) + svfloat32_t svtssel<see href="svfloat32_t op1, svuint32_t op2">_f32</see> FTSSEL Zresult.S, Zop1.S, Zop2.S To be added. @@ -43544,7 +43544,7 @@ To be added. To be added. - svfloat64_t svtsmul[_f64](svfloat64_t op1, svuint64_t op2) + svfloat64_t svtsmul<see href="svfloat64_t op1, svuint64_t op2">_f64</see> FTSMUL Zresult.D, Zop1.D, Zop2.D To be added. @@ -43574,7 +43574,7 @@ To be added. To be added. - svfloat32_t svtsmul[_f32](svfloat32_t op1, svuint32_t op2) + svfloat32_t svtsmul<see href="svfloat32_t op1, svuint32_t op2">_f32</see> FTSMUL Zresult.S, Zop1.S, Zop2.S To be added. @@ -43604,7 +43604,7 @@ To be added. To be added. - svuint8_t svuzp1[_u8](svuint8_t op1, svuint8_t op2) + svuint8_t svuzp1<see href="svuint8_t op1, svuint8_t op2">_u8</see> svbool_t svuzp1_b8(svbool_t op1, svbool_t op2) To be added. @@ -43634,7 +43634,7 @@ To be added. To be added. - svfloat64_t svuzp1[_f64](svfloat64_t op1, svfloat64_t op2) + svfloat64_t svuzp1<see href="svfloat64_t op1, svfloat64_t op2">_f64</see> UZP1 Zresult.D, Zop1.D, Zop2.D To be added. @@ -43664,7 +43664,7 @@ To be added. To be added. - svint16_t svuzp1[_s16](svint16_t op1, svint16_t op2) + svint16_t svuzp1<see href="svint16_t op1, svint16_t op2">_s16</see> UZP1 Zresult.H, Zop1.H, Zop2.H To be added. @@ -43694,7 +43694,7 @@ To be added. To be added. - svint32_t svuzp1[_s32](svint32_t op1, svint32_t op2) + svint32_t svuzp1<see href="svint32_t op1, svint32_t op2">_s32</see> UZP1 Zresult.S, Zop1.S, Zop2.S To be added. @@ -43724,7 +43724,7 @@ To be added. To be added. - svint64_t svuzp1[_s64](svint64_t op1, svint64_t op2) + svint64_t svuzp1<see href="svint64_t op1, svint64_t op2">_s64</see> UZP1 Zresult.D, Zop1.D, Zop2.D To be added. @@ -43754,7 +43754,7 @@ To be added. To be added. - svint8_t svuzp1[_s8](svint8_t op1, svint8_t op2) + svint8_t svuzp1<see href="svint8_t op1, svint8_t op2">_s8</see> UZP1 Zresult.B, Zop1.B, Zop2.B To be added. @@ -43784,7 +43784,7 @@ To be added. To be added. - svfloat32_t svuzp1[_f32](svfloat32_t op1, svfloat32_t op2) + svfloat32_t svuzp1<see href="svfloat32_t op1, svfloat32_t op2">_f32</see> UZP1 Zresult.S, Zop1.S, Zop2.S To be added. @@ -43814,7 +43814,7 @@ To be added. To be added. - svuint16_t svuzp1[_u16](svuint16_t op1, svuint16_t op2) + svuint16_t svuzp1<see href="svuint16_t op1, svuint16_t op2">_u16</see> UZP1 Zresult.H, Zop1.H, Zop2.H To be added. @@ -43844,7 +43844,7 @@ To be added. To be added. - svuint32_t svuzp1[_u32](svuint32_t op1, svuint32_t op2) + svuint32_t svuzp1<see href="svuint32_t op1, svuint32_t op2">_u32</see> UZP1 Zresult.S, Zop1.S, Zop2.S To be added. @@ -43874,7 +43874,7 @@ To be added. To be added. - svuint64_t svuzp1[_u64](svuint64_t op1, svuint64_t op2) + svuint64_t svuzp1<see href="svuint64_t op1, svuint64_t op2">_u64</see> UZP1 Zresult.D, Zop1.D, Zop2.D To be added. @@ -43904,7 +43904,7 @@ To be added. To be added. - svuint8_t svuzp2[_u8](svuint8_t op1, svuint8_t op2) + svuint8_t svuzp2<see href="svuint8_t op1, svuint8_t op2">_u8</see> UZP2 Zresult.B, Zop1.B, Zop2.B To be added. @@ -43934,7 +43934,7 @@ To be added. To be added. - svfloat64_t svuzp2[_f64](svfloat64_t op1, svfloat64_t op2) + svfloat64_t svuzp2<see href="svfloat64_t op1, svfloat64_t op2">_f64</see> UZP2 Zresult.D, Zop1.D, Zop2.D To be added. @@ -43964,7 +43964,7 @@ To be added. To be added. - svint16_t svuzp2[_s16](svint16_t op1, svint16_t op2) + svint16_t svuzp2<see href="svint16_t op1, svint16_t op2">_s16</see> UZP2 Zresult.H, Zop1.H, Zop2.H To be added. @@ -43994,7 +43994,7 @@ To be added. To be added. - svint32_t svuzp2[_s32](svint32_t op1, svint32_t op2) + svint32_t svuzp2<see href="svint32_t op1, svint32_t op2">_s32</see> UZP2 Zresult.S, Zop1.S, Zop2.S To be added. @@ -44024,7 +44024,7 @@ To be added. To be added. - svint64_t svuzp2[_s64](svint64_t op1, svint64_t op2) + svint64_t svuzp2<see href="svint64_t op1, svint64_t op2">_s64</see> UZP2 Zresult.D, Zop1.D, Zop2.D To be added. @@ -44054,7 +44054,7 @@ To be added. To be added. - svint8_t svuzp2[_s8](svint8_t op1, svint8_t op2) + svint8_t svuzp2<see href="svint8_t op1, svint8_t op2">_s8</see> UZP2 Zresult.B, Zop1.B, Zop2.B To be added. @@ -44084,7 +44084,7 @@ To be added. To be added. - svfloat32_t svuzp2[_f32](svfloat32_t op1, svfloat32_t op2) + svfloat32_t svuzp2<see href="svfloat32_t op1, svfloat32_t op2">_f32</see> UZP2 Zresult.S, Zop1.S, Zop2.S To be added. @@ -44114,7 +44114,7 @@ To be added. To be added. - svuint16_t svuzp2[_u16](svuint16_t op1, svuint16_t op2) + svuint16_t svuzp2<see href="svuint16_t op1, svuint16_t op2">_u16</see> UZP2 Zresult.H, Zop1.H, Zop2.H To be added. @@ -44144,7 +44144,7 @@ To be added. To be added. - svuint32_t svuzp2[_u32](svuint32_t op1, svuint32_t op2) + svuint32_t svuzp2<see href="svuint32_t op1, svuint32_t op2">_u32</see> UZP2 Zresult.S, Zop1.S, Zop2.S To be added. @@ -44174,7 +44174,7 @@ To be added. To be added. - svuint64_t svuzp2[_u64](svuint64_t op1, svuint64_t op2) + svuint64_t svuzp2<see href="svuint64_t op1, svuint64_t op2">_u64</see> UZP2 Zresult.D, Zop1.D, Zop2.D To be added. @@ -44204,7 +44204,7 @@ To be added. To be added. - svuint8_t svtbl[_u8](svuint8_t data, svuint8_t indices) + svuint8_t svtbl<see href="svuint8_t data, svuint8_t indices">_u8</see> TBL Zresult.B, {Zdata.B}, Zindices.B To be added. @@ -44234,7 +44234,7 @@ To be added. To be added. - svfloat64_t svtbl[_f64](svfloat64_t data, svuint64_t indices) + svfloat64_t svtbl<see href="svfloat64_t data, svuint64_t indices">_f64</see> TBL Zresult.D, {Zdata.D}, Zindices.D To be added. @@ -44264,7 +44264,7 @@ To be added. To be added. - svint16_t svtbl[_s16](svint16_t data, svuint16_t indices) + svint16_t svtbl<see href="svint16_t data, svuint16_t indices">_s16</see> TBL Zresult.H, {Zdata.H}, Zindices.H To be added. @@ -44294,7 +44294,7 @@ To be added. To be added. - svint32_t svtbl[_s32](svint32_t data, svuint32_t indices) + svint32_t svtbl<see href="svint32_t data, svuint32_t indices">_s32</see> TBL Zresult.S, {Zdata.S}, Zindices.S To be added. @@ -44324,7 +44324,7 @@ To be added. To be added. - svint64_t svtbl[_s64](svint64_t data, svuint64_t indices) + svint64_t svtbl<see href="svint64_t data, svuint64_t indices">_s64</see> TBL Zresult.D, {Zdata.D}, Zindices.D To be added. @@ -44354,7 +44354,7 @@ To be added. To be added. - svint8_t svtbl[_s8](svint8_t data, svuint8_t indices) + svint8_t svtbl<see href="svint8_t data, svuint8_t indices">_s8</see> TBL Zresult.B, {Zdata.B}, Zindices.B To be added. @@ -44384,7 +44384,7 @@ To be added. To be added. - svfloat32_t svtbl[_f32](svfloat32_t data, svuint32_t indices) + svfloat32_t svtbl<see href="svfloat32_t data, svuint32_t indices">_f32</see> TBL Zresult.S, {Zdata.S}, Zindices.S To be added. @@ -44414,7 +44414,7 @@ To be added. To be added. - svuint16_t svtbl[_u16](svuint16_t data, svuint16_t indices) + svuint16_t svtbl<see href="svuint16_t data, svuint16_t indices">_u16</see> TBL Zresult.H, {Zdata.H}, Zindices.H To be added. @@ -44444,7 +44444,7 @@ To be added. To be added. - svuint32_t svtbl[_u32](svuint32_t data, svuint32_t indices) + svuint32_t svtbl<see href="svuint32_t data, svuint32_t indices">_u32</see> TBL Zresult.S, {Zdata.S}, Zindices.S To be added. @@ -44474,7 +44474,7 @@ To be added. To be added. - svuint64_t svtbl[_u64](svuint64_t data, svuint64_t indices) + svuint64_t svtbl<see href="svuint64_t data, svuint64_t indices">_u64</see> TBL Zresult.D, {Zdata.D}, Zindices.D To be added. @@ -44758,7 +44758,7 @@ To be added. - uint8_t sveorv[_u8](svbool_t pg, svuint8_t op) + uint8_t sveorv<see href="svbool_t pg, svuint8_t op">_u8</see> EORV Bresult, Pg, Zop.B To be added. @@ -44786,7 +44786,7 @@ To be added. - int16_t sveorv[_s16](svbool_t pg, svint16_t op) + int16_t sveorv<see href="svbool_t pg, svint16_t op">_s16</see> EORV Hresult, Pg, Zop.H To be added. @@ -44814,7 +44814,7 @@ To be added. - int32_t sveorv[_s32](svbool_t pg, svint32_t op) + int32_t sveorv<see href="svbool_t pg, svint32_t op">_s32</see> EORV Sresult, Pg, Zop.S To be added. @@ -44842,7 +44842,7 @@ To be added. - int64_t sveorv[_s64](svbool_t pg, svint64_t op) + int64_t sveorv<see href="svbool_t pg, svint64_t op">_s64</see> EORV Dresult, Pg, Zop.D To be added. @@ -44870,7 +44870,7 @@ To be added. - int8_t sveorv[_s8](svbool_t pg, svint8_t op) + int8_t sveorv<see href="svbool_t pg, svint8_t op">_s8</see> EORV Bresult, Pg, Zop.B To be added. @@ -44898,7 +44898,7 @@ To be added. - uint16_t sveorv[_u16](svbool_t pg, svuint16_t op) + uint16_t sveorv<see href="svbool_t pg, svuint16_t op">_u16</see> EORV Hresult, Pg, Zop.H To be added. @@ -44926,7 +44926,7 @@ To be added. - uint32_t sveorv[_u32](svbool_t pg, svuint32_t op) + uint32_t sveorv<see href="svbool_t pg, svuint32_t op">_u32</see> EORV Sresult, Pg, Zop.S To be added. @@ -44954,7 +44954,7 @@ To be added. - uint64_t sveorv[_u64](svbool_t pg, svuint64_t op) + uint64_t sveorv<see href="svbool_t pg, svuint64_t op">_u64</see> EORV Dresult, Pg, Zop.D To be added. @@ -45162,7 +45162,7 @@ To be added. - svuint16_t svunpklo[_u16](svuint8_t op) + svuint16_t svunpklo<see href="svuint8_t op">_u16</see> UUNPKLO Zresult.H, Zop.B To be added. @@ -45190,7 +45190,7 @@ To be added. - svuint32_t svunpklo[_u32](svuint16_t op) + svuint32_t svunpklo<see href="svuint16_t op">_u32</see> UUNPKLO Zresult.S, Zop.H To be added. @@ -45218,7 +45218,7 @@ To be added. - svuint64_t svunpklo[_u64](svuint32_t op) + svuint64_t svunpklo<see href="svuint32_t op">_u64</see> UUNPKLO Zresult.D, Zop.S To be added. @@ -45246,7 +45246,7 @@ To be added. - svuint16_t svunpkhi[_u16](svuint8_t op) + svuint16_t svunpkhi<see href="svuint8_t op">_u16</see> UUNPKHI Zresult.H, Zop.B To be added. @@ -45274,7 +45274,7 @@ To be added. - svuint32_t svunpkhi[_u32](svuint16_t op) + svuint32_t svunpkhi<see href="svuint16_t op">_u32</see> UUNPKHI Zresult.S, Zop.H To be added. @@ -45302,7 +45302,7 @@ To be added. - svuint64_t svunpkhi[_u64](svuint32_t op) + svuint64_t svunpkhi<see href="svuint32_t op">_u64</see> UUNPKHI Zresult.D, Zop.S To be added. @@ -45332,7 +45332,7 @@ To be added. To be added. - svuint8_t svzip2[_u8](svuint8_t op1, svuint8_t op2) + svuint8_t svzip2<see href="svuint8_t op1, svuint8_t op2">_u8</see> ZIP2 Zresult.B, Zop1.B, Zop2.B To be added. @@ -45362,7 +45362,7 @@ To be added. To be added. - svfloat64_t svzip2[_f64](svfloat64_t op1, svfloat64_t op2) + svfloat64_t svzip2<see href="svfloat64_t op1, svfloat64_t op2">_f64</see> ZIP2 Zresult.D, Zop1.D, Zop2.D To be added. @@ -45392,7 +45392,7 @@ To be added. To be added. - svint16_t svzip2[_s16](svint16_t op1, svint16_t op2) + svint16_t svzip2<see href="svint16_t op1, svint16_t op2">_s16</see> ZIP2 Zresult.H, Zop1.H, Zop2.H To be added. @@ -45422,7 +45422,7 @@ To be added. To be added. - svint32_t svzip2[_s32](svint32_t op1, svint32_t op2) + svint32_t svzip2<see href="svint32_t op1, svint32_t op2">_s32</see> ZIP2 Zresult.S, Zop1.S, Zop2.S To be added. @@ -45452,7 +45452,7 @@ To be added. To be added. - svint64_t svzip2[_s64](svint64_t op1, svint64_t op2) + svint64_t svzip2<see href="svint64_t op1, svint64_t op2">_s64</see> ZIP2 Zresult.D, Zop1.D, Zop2.D To be added. @@ -45482,7 +45482,7 @@ To be added. To be added. - svint8_t svzip2[_s8](svint8_t op1, svint8_t op2) + svint8_t svzip2<see href="svint8_t op1, svint8_t op2">_s8</see> ZIP2 Zresult.B, Zop1.B, Zop2.B To be added. @@ -45512,7 +45512,7 @@ To be added. To be added. - svfloat32_t svzip2[_f32](svfloat32_t op1, svfloat32_t op2) + svfloat32_t svzip2<see href="svfloat32_t op1, svfloat32_t op2">_f32</see> ZIP2 Zresult.S, Zop1.S, Zop2.S To be added. @@ -45542,7 +45542,7 @@ To be added. To be added. - svuint16_t svzip2[_u16](svuint16_t op1, svuint16_t op2) + svuint16_t svzip2<see href="svuint16_t op1, svuint16_t op2">_u16</see> ZIP2 Zresult.H, Zop1.H, Zop2.H svbool_t svzip2_b16(svbool_t op1, svbool_t op2) ZIP2 Presult.H, Pop1.H, Pop2.H @@ -45574,7 +45574,7 @@ To be added. To be added. - svuint32_t svzip2[_u32](svuint32_t op1, svuint32_t op2) + svuint32_t svzip2<see href="svuint32_t op1, svuint32_t op2">_u32</see> ZIP2 Zresult.S, Zop1.S, Zop2.S svbool_t svzip2_b32(svbool_t op1, svbool_t op2) ZIP2 Presult.S, Pop1.S, Pop2.S @@ -45606,7 +45606,7 @@ To be added. To be added. - svuint64_t svzip2[_u64](svuint64_t op1, svuint64_t op2) + svuint64_t svzip2<see href="svuint64_t op1, svuint64_t op2">_u64</see> ZIP2 Zresult.D, Zop1.D, Zop2.D svbool_t svzip2_b64(svbool_t op1, svbool_t op2) ZIP2 Presult.D, Pop1.D, Pop2.D @@ -45638,7 +45638,7 @@ To be added. To be added. - svuint8_t svzip1[_u8](svuint8_t op1, svuint8_t op2) + svuint8_t svzip1<see href="svuint8_t op1, svuint8_t op2">_u8</see> ZIP1 Zresult.B, Zop1.B, Zop2.B svbool_t svzip1_b8(svbool_t op1, svbool_t op2) ZIP1 Presult.B, Pop1.B, Pop2.B @@ -45670,7 +45670,7 @@ To be added. To be added. - svfloat64_t svzip1[_f64](svfloat64_t op1, svfloat64_t op2) + svfloat64_t svzip1<see href="svfloat64_t op1, svfloat64_t op2">_f64</see> ZIP1 Zresult.D, Zop1.D, Zop2.D To be added. @@ -45700,7 +45700,7 @@ To be added. To be added. - svint16_t svzip1[_s16](svint16_t op1, svint16_t op2) + svint16_t svzip1<see href="svint16_t op1, svint16_t op2">_s16</see> ZIP1 Zresult.H, Zop1.H, Zop2.H To be added. @@ -45730,7 +45730,7 @@ To be added. To be added. - svint32_t svzip1[_s32](svint32_t op1, svint32_t op2) + svint32_t svzip1<see href="svint32_t op1, svint32_t op2">_s32</see> ZIP1 Zresult.S, Zop1.S, Zop2.S To be added. @@ -45760,7 +45760,7 @@ To be added. To be added. - svint64_t svzip1[_s64](svint64_t op1, svint64_t op2) + svint64_t svzip1<see href="svint64_t op1, svint64_t op2">_s64</see> ZIP1 Zresult.D, Zop1.D, Zop2.D To be added. @@ -45790,7 +45790,7 @@ To be added. To be added. - svint8_t svzip1[_s8](svint8_t op1, svint8_t op2) + svint8_t svzip1<see href="svint8_t op1, svint8_t op2">_s8</see> ZIP1 Zresult.B, Zop1.B, Zop2.B To be added. @@ -45820,7 +45820,7 @@ To be added. To be added. - svfloat32_t svzip1[_f32](svfloat32_t op1, svfloat32_t op2) + svfloat32_t svzip1<see href="svfloat32_t op1, svfloat32_t op2">_f32</see> ZIP1 Zresult.S, Zop1.S, Zop2.S To be added. @@ -45850,7 +45850,7 @@ To be added. To be added. - svuint16_t svzip1[_u16](svuint16_t op1, svuint16_t op2) + svuint16_t svzip1<see href="svuint16_t op1, svuint16_t op2">_u16</see> ZIP1 Zresult.H, Zop1.H, Zop2.H svbool_t svzip1_b16(svbool_t op1, svbool_t op2) ZIP1 Presult.H, Pop1.H, Pop2.H @@ -45882,7 +45882,7 @@ To be added. To be added. - svuint32_t svzip1[_u32](svuint32_t op1, svuint32_t op2) + svuint32_t svzip1<see href="svuint32_t op1, svuint32_t op2">_u32</see> ZIP1 Zresult.S, Zop1.S, Zop2.S svbool_t svzip1_b32(svbool_t op1, svbool_t op2) ZIP1 Presult.S, Pop1.S, Pop2.S @@ -45914,7 +45914,7 @@ To be added. To be added. - svuint64_t svzip1[_u64](svuint64_t op1, svuint64_t op2) + svuint64_t svzip1<see href="svuint64_t op1, svuint64_t op2">_u64</see> ZIP1 Zresult.D, Zop1.D, Zop2.D svbool_t svzip1_b64(svbool_t op1, svbool_t op2) ZIP1 Presult.D, Pop1.D, Pop2.D @@ -45924,4 +45924,4 @@ - + \ No newline at end of file diff --git a/xml/System/Char.xml b/xml/System/Char.xml index 6373ff80de7..9175b0a1d71 100644 --- a/xml/System/Char.xml +++ b/xml/System/Char.xml @@ -9110,7 +9110,7 @@ This member is an explicit interface member implementation. It can be used only ]]> - As explained in Best Practices for Using Strings, we recommend that you avoid calling character-casing and string-casing methods that substitute default values. Instead, you should call methods that require parameters to be explicitly specified. To convert a character to lowercase by using the casing conventions of the current culture, call the method overload with a value of for its parameter. + As explained in Best Practices for Using Strings, we recommend that you avoid calling character-casing and string-casing methods that substitute default values. Instead, you should call methods that require parameters to be explicitly specified. To convert a character to lowercase by using the casing conventions of the current culture, call the method overload with a value of for its culture parameter. @@ -9529,7 +9529,7 @@ This member is an explicit interface member implementation. It can be used only ]]> - As explained in Best Practices for Using Strings, we recommend that you avoid calling character-casing and string-casing methods that substitute default values. Instead, you should call methods that require parameters to be explicitly specified. To convert a character to uppercase by using the casing conventions of the current culture, call the method overload with a value of for its parameter. + As explained in Best Practices for Using Strings, we recommend that you avoid calling character-casing and string-casing methods that substitute default values. Instead, you should call methods that require parameters to be explicitly specified. To convert a character to uppercase by using the casing conventions of the current culture, call the method overload with a value of for its culture parameter. diff --git a/xml/System/Uri.xml b/xml/System/Uri.xml index 30b73d15062..fc06c487ac8 100644 --- a/xml/System/Uri.xml +++ b/xml/System/Uri.xml @@ -5984,7 +5984,7 @@ The following examples show a URI and the results of calling Gets a value that indicates whether the URI string was completely escaped before the instance was created. - if the parameter was set to when the instance was created; otherwise, . + if the dontEscape parameter was set to when the instance was created; otherwise, . Date: Tue, 7 Jan 2025 10:26:31 -0800 Subject: [PATCH 4/5] Fix up paramrefs in System.Data, System.CodeDom, etc. (#10790) --- .../SqlMetaData.xml | 2 +- .../ToolboxCategoryItems.xml | 237 ++-- .../DesignerView.xml | 140 +- .../ViewStateService.xml | 52 +- .../ContextItemManager.xml | 54 +- .../ServiceManager.xml | 24 +- .../ActivityXamlServices.xml | 22 +- .../ICollectionContract`1.xml | 58 +- xml/System.AddIn.Contract/IListContract`1.xml | 138 +- xml/System.AddIn.Hosting/AddInStore.xml | 230 ++- .../CollectionAdapters.xml | 98 +- .../CompilerErrorCollection.xml | 166 +-- xml/System.CodeDom/CodeGotoStatement.xml | 60 +- .../AssemblyCatalog.xml | 6 +- .../CatalogExportProvider.xml | 60 +- .../ComposablePartExportProvider.xml | 64 +- .../Export.xml | 6 +- .../CodeDomSerializerBase.xml | 414 +++--- .../CodeDomSerializerException.xml | 28 +- .../ComponentSerializationService.xml | 152 +- .../ObjectStatementCollection.xml | 32 +- .../TypeCodeDomSerializer.xml | 122 +- .../DesignSurface.xml | 4 +- .../DesignerActionService.xml | 4 +- .../EventBindingService.xml | 102 +- .../PropertyDescriptorCollection.xml | 207 ++- .../PropertyTabAttribute.xml | 108 +- .../TimeSpanConverter.xml | 90 +- xml/System.Composition/CompositionContext.xml | 14 +- .../ConfigurationElement.xml | 2 +- .../ConfigurationPermission.xml | 36 +- .../RsaProtectedConfigurationProvider.xml | 24 +- .../DbExpressionBuilder.xml | 258 ++-- .../EntityDataReader.xml | 4 +- xml/System.Data.Objects/ObjectContext.xml | 37 +- xml/System.Data.Objects/ObjectQuery`1.xml | 7 +- xml/System.Data.Odbc/OdbcErrorCollection.xml | 90 +- xml/System.Data.Odbc/OdbcParameter.xml | 950 ++++++------- xml/System.Data.OleDb/OleDbParameter.xml | 920 ++++++------ .../OracleBoolean.xml | 198 +-- xml/System.Data.OracleClient/OracleLob.xml | 881 ++++++------ xml/System.Data.SqlTypes/SqlFileStream.xml | 200 +-- xml/System.Data/DataRelationCollection.xml | 181 ++- xml/System.Data/DataRow.xml | 1261 ++++++++--------- xml/System.Data/DataRowExtensions.xml | 184 +-- xml/System.Data/DataRowView.xml | 392 +++-- xml/System.Data/DataSet.xml | 4 +- xml/System.Data/DataTable.xml | 2 +- 48 files changed, 4151 insertions(+), 4174 deletions(-) diff --git a/xml/Microsoft.SqlServer.Server/SqlMetaData.xml b/xml/Microsoft.SqlServer.Server/SqlMetaData.xml index c24a3e3f83a..82ee3654173 100644 --- a/xml/Microsoft.SqlServer.Server/SqlMetaData.xml +++ b/xml/Microsoft.SqlServer.Server/SqlMetaData.xml @@ -2466,7 +2466,7 @@ Gets the name of the column or parameter. The name of the column or parameter as a . To be added. - The specified in the constructor is longer than 128 characters. + The name specified in the constructor is longer than 128 characters. diff --git a/xml/System.Activities.Presentation.Toolbox/ToolboxCategoryItems.xml b/xml/System.Activities.Presentation.Toolbox/ToolboxCategoryItems.xml index f7428e1066f..24abca56957 100644 --- a/xml/System.Activities.Presentation.Toolbox/ToolboxCategoryItems.xml +++ b/xml/System.Activities.Presentation.Toolbox/ToolboxCategoryItems.xml @@ -36,8 +36,8 @@ A collection of objects. This class is and so cannot be inherited. This class provides support for the categorization of toolbox items when re-hosting the Windows Workflow Designer outside of Visual Studio 2010. - @@ -174,11 +174,11 @@ The zero-based index of the target array. Copies the entire collection to a compatible one-dimensional , starting at the specified index of the target . - in the same order in which the enumerator iterates through the collection. - + in the same order in which the enumerator iterates through the collection. + ]]> The is . @@ -206,11 +206,11 @@ Gets the number of tools contained in the . The number of elements contained in the . - implements the interface. - + implements the interface. + ]]> @@ -238,15 +238,15 @@ Returns an enumerator that iterates through the collection. An for the . - is undefined. Therefore, you must call to advance the enumerator to the first element of the collection before reading the value of . An enumerator remains valid as long as the collection remains unchanged. If changes are made to the collection, such as adding, modifying, or deleting elements, the enumerator is no longer valid and its behavior is undefined. - - The enumerator does not have exclusive access to the collection; therefore, enumerating through a collection is intrinsically not a thread-safe procedure. - + is undefined. Therefore, you must call to advance the enumerator to the first element of the collection before reading the value of . An enumerator remains valid as long as the collection remains unchanged. If changes are made to the collection, such as adding, modifying, or deleting elements, the enumerator is no longer valid and its behavior is undefined. + + The enumerator does not have exclusive access to the collection; therefore, enumerating through a collection is intrinsically not a thread-safe procedure. + ]]> @@ -274,11 +274,11 @@ if the is read-only; otherwise, . - implements the interface. A collection that is read-only does not allow the addition, removal, or modification of elements after the collection is created. - + implements the interface. A collection that is read-only does not allow the addition, removal, or modification of elements after the collection is created. + ]]> @@ -306,11 +306,11 @@ Gets the toolbox category at the specified index. The toolbox category at the specified index. - implements the interface. This property provides the ability to access a specific element in the collection by using the following syntax: `myCollection[index]`. - + implements the interface. This property provides the ability to access a specific element in the collection by using the following syntax: `myCollection[index]`. + ]]> @@ -371,11 +371,11 @@ The zero-based index of the target array. Copies the entire collection to a compatible one-dimensional , starting at the specified index of the target . - in the same order in which the enumerator iterates through the collection. - + in the same order in which the enumerator iterates through the collection. + ]]> The is . @@ -409,11 +409,11 @@ Gets the number of toolbox categories contained in the collection. The number of items contained in the collection. - implements the interface. - + implements the interface. + ]]> @@ -441,11 +441,11 @@ if access to the is synchronized (thread safe); otherwise, . - implements the interface. The property returns an object, which can be used to synchronize access to the . - + implements the interface. The property returns an object, which can be used to synchronize access to the . + ]]> @@ -472,11 +472,11 @@ Gets an object that can be used to synchronize access to the . An object that can be used to synchronize access to the . - implements the interface. - + implements the interface. + ]]> @@ -504,15 +504,15 @@ Returns an enumerator that iterates through the collection. An for the . - is undefined. Therefore, you must call to advance the enumerator to the first element of the collection before reading the value of . An enumerator remains valid as long as the collection remains unchanged. If changes are made to the collection, such as adding, modifying, or deleting elements, the enumerator is no longer valid and its behavior is undefined. - - The enumerator does not have exclusive access to the collection; therefore, enumerating through a collection is intrinsically not a thread-safe procedure. - + is undefined. Therefore, you must call to advance the enumerator to the first element of the collection before reading the value of . An enumerator remains valid as long as the collection remains unchanged. If changes are made to the collection, such as adding, modifying, or deleting elements, the enumerator is no longer valid and its behavior is undefined. + + The enumerator does not have exclusive access to the collection; therefore, enumerating through a collection is intrinsically not a thread-safe procedure. + ]]> @@ -543,11 +543,11 @@ Adds a tool to the . The zero-based index of the tool added to the collection. - implements the interface. - + implements the interface. + ]]> The is of a type that is not assignable to the implemented by the collection. @@ -581,11 +581,11 @@ Removes all the tools from the . - implements the interface. - + implements the interface. + ]]> @@ -617,11 +617,11 @@ if the is found in the ; otherwise, . - implements the interface. - + implements the interface. + ]]> The is . @@ -653,11 +653,11 @@ Determines the index of a specific tool in the . The index of if found in the list; otherwise, -1. - implements the interface. - + implements the interface. + ]]> The is . @@ -690,15 +690,15 @@ The inserted into the collection. Inserts a toolbox category into the collection at the specified index. - implements the interface. - - If `index` equals the number of items in the , then `value` is appended to the end. - - In collections of contiguous elements, such as lists, the elements that follow the insertion point move down to accommodate the new element. If the collection is indexed, the indexes of the elements that are moved are also updated. - + implements the interface. + + If `index` equals the number of items in the , then `value` is appended to the end. + + In collections of contiguous elements, such as lists, the elements that follow the insertion point move down to accommodate the new element. If the collection is indexed, the indexes of the elements that are moved are also updated. + ]]> The is not valid for the collection. @@ -729,11 +729,11 @@ if the has a fixed size; otherwise, . - implements the interface. - + implements the interface. + ]]> @@ -761,11 +761,11 @@ if the is read-only; otherwise, . - implements the interface. A collection that is read-only does not allow the addition, removal, or modification of elements after the collection is created. - + implements the interface. A collection that is read-only does not allow the addition, removal, or modification of elements after the collection is created. + ]]> @@ -802,14 +802,13 @@ Gets or sets the toolbox category at a specified index of the collection. The toolbox category at the specified index. - implements the interface. This property provides the ability to access a specific element in the collection by using the following syntax: `myCollection[index]`. - + implements the interface. This property provides the ability to access a specific element in the collection by using the following syntax: `myCollection[index]`. + ]]> - The set is . @@ -837,13 +836,13 @@ The tool to remove from the collection. Removes the first occurrence of a specific toolbox category from the . - implements the interface. - - In collections of contiguous elements, such as lists, the elements that follow the removed element move up to occupy the vacated spot. If the collection is indexed, the indexes of the elements that are moved are also updated. - + implements the interface. + + In collections of contiguous elements, such as lists, the elements that follow the removed element move up to occupy the vacated spot. If the collection is indexed, the indexes of the elements that are moved are also updated. + ]]> @@ -873,13 +872,13 @@ The zero-based index of the toolbox category item to remove. Removes a toolbox category at the specified index of the collection. - implements the interface. - - In collections of contiguous elements, such as lists, the elements that follow the removed element move up to occupy the vacated spot. If the collection is indexed, the indexes of the elements that are moved are also updated. - + implements the interface. + + In collections of contiguous elements, such as lists, the elements that follow the removed element move up to occupy the vacated spot. If the collection is indexed, the indexes of the elements that are moved are also updated. + ]]> The is not valid for the collection. diff --git a/xml/System.Activities.Presentation.View/DesignerView.xml b/xml/System.Activities.Presentation.View/DesignerView.xml index 0ffacf3d1fc..47d88d733e8 100644 --- a/xml/System.Activities.Presentation.View/DesignerView.xml +++ b/xml/System.Activities.Presentation.View/DesignerView.xml @@ -29,11 +29,11 @@ Provides Windows Presentation Foundation (WPF) controls for the designer view that represents the workflow canvas. - and interfaces to provide support for named XAML elements and for attaching event handlers to them. - + and interfaces to provide support for named XAML elements and for attaching event handlers to them. + ]]> @@ -175,11 +175,11 @@ Contains the dependency property that represents the property. - @@ -229,11 +229,11 @@ Gets or sets a collection of services shared between all elements contained in the designer. The context. - @@ -256,11 +256,11 @@ The used to copy the current workflow design surface as a screenshot and place it in the clipboard. - @@ -561,7 +561,7 @@ System.Windows.Input.ICommand - The command used to navigate to the selected child of a composite activity and expand it to fill the full screen of the Windows Workflow Designer surface. The context menu command initiates this action. + The command used to navigate to the selected child of a composite activity and expand it to fill the full screen of the Windows Workflow Designer surface. The "View full screen" context menu command initiates this action. To be added. @@ -714,7 +714,7 @@ System.Windows.Input.ICommand - The command used to navigate to the parent activity of the selected child activity and expand it to fill the full screen of the Windows Workflow Designer surface. The context menu command initiates this action. + The command used to navigate to the parent activity of the selected child activity and expand it to fill the full screen of the Windows Workflow Designer surface. The "View parent" context menu command initiates this action. To be added. @@ -838,11 +838,11 @@ if the element is in multiple selection mode; otherwise, . - @@ -1157,11 +1157,11 @@ The that contains the event data. Raises the PreviewMouseWheel event. - attached event reaches an element in its route that is derived from this class. Override this method to add class handling for this event. If the CTRL key is pressed when this event is processed, the view is zoomed in or out, based on the movement of the mouse wheel. - + attached event reaches an element in its route that is derived from this class. Override this method to add class handling for this event. If the CTRL key is pressed when this event is processed, the view is zoomed in or out, based on the movement of the mouse wheel. + ]]> @@ -1191,11 +1191,11 @@ if the assembly reference is added; if the assembly reference is removed. Refreshes the list of imported namespaces based on whether the specified referenced assembly is added or removed. - @@ -1323,11 +1323,11 @@ Gets or sets a that is the UI representation of the root of the current model tree. The root element. - method to set this property to a representation of a . - + method to set this property to a representation of a . + ]]> @@ -1523,11 +1523,11 @@ The target. Attaches events and names to compiled content. - @@ -1573,11 +1573,11 @@ The target. Calls the StyleBamlReader to attach events on EventSetters and Templates in compiled content. - @@ -1598,24 +1598,24 @@ System.Windows.Input.ICommand - The command used to show or hide the argument designer. Clicking the button on the Windows Workflow Designer surface initiates this action. + The command used to show or hide the argument designer. Clicking the "Arguments" button on the Windows Workflow Designer surface initiates this action. - Show/Hide Arguments -``` - - The following code sample demonstrates how invoke this property in C#. - -```csharp -DesignerView dView = des.Context.Services.GetService(); -((RoutedCommand)DesignerView.ToggleArgumentDesignerCommand).Execute(null, dView); -``` - + Show/Hide Arguments +``` + + The following code sample demonstrates how invoke this property in C#. + +```csharp +DesignerView dView = des.Context.Services.GetService(); +((RoutedCommand)DesignerView.ToggleArgumentDesignerCommand).Execute(null, dView); +``` + ]]> @@ -1696,7 +1696,7 @@ DesignerView dView = des.Context.Services.GetService(); System.Windows.Input.ICommand - The command used to show or hide the variable designer. Clicking the button on the Windows Workflow Designer surface initiates this action. + The command used to show or hide the variable designer. Clicking the "Variables" button on the Windows Workflow Designer surface initiates this action. To be added. diff --git a/xml/System.Activities.Presentation.View/ViewStateService.xml b/xml/System.Activities.Presentation.View/ViewStateService.xml index ac2adb308b6..a0db4e13f23 100644 --- a/xml/System.Activities.Presentation.View/ViewStateService.xml +++ b/xml/System.Activities.Presentation.View/ViewStateService.xml @@ -16,11 +16,11 @@ Enables the preservation and accessing of all data values associated with the user interaction components of a workflow application, at a particular point in time in the running of a workflow application. A stores view states for model items. - is an abstract class. Derived classes must store view states when is called, and retrieve them when is called. - + is an abstract class. Derived classes must store view states when is called, and retrieve them when is called. + ]]> @@ -96,14 +96,14 @@ The that the view state applies to. - Returns an aspect of the view state that was stored for the specified , matching the specified . + Returns an aspect of the view state that was stored for the specified . Returns . - to initially store view state information so that it can be retrieved. - + to initially store view state information so that it can be retrieved. + ]]> @@ -133,11 +133,11 @@ Retrieves an aspect of the view state for the specified , matching the specified . The aspect of the view state as an ,or . - to initially store view state information so that it can be retrieved. - + to initially store view state information so that it can be retrieved. + ]]> @@ -168,11 +168,11 @@ An to be stored. Stores an aspect of the view state for the specified , matching the specified . - and passing the same values for `modelItem` and `key`. - + and passing the same values for `modelItem` and `key`. + ]]> @@ -203,11 +203,11 @@ An to be stored. When implemented in a derived class, records the current setting of the item represented by the specified key so that it is available for an undo operation. The item represented by the specified key is then stored in the view state of the specified model item. - and passing the same values for `modelItem` and `key`. - + and passing the same values for `modelItem` and `key`. + ]]> diff --git a/xml/System.Activities.Presentation/ContextItemManager.xml b/xml/System.Activities.Presentation/ContextItemManager.xml index c22c97055da..6d3fd0e87e1 100644 --- a/xml/System.Activities.Presentation/ContextItemManager.xml +++ b/xml/System.Activities.Presentation/ContextItemManager.xml @@ -23,11 +23,11 @@ Represents a class that maintains a set of context items published into the designer editing context. This class is abstract. - contained in the represents a piece of transient state in a . - + contained in the represents a piece of transient state in a . + ]]> @@ -112,11 +112,11 @@ if the context contains an instance of the specified item type; otherwise, . - method, which must be implemented for this method to provide the type checking functionality. - + method, which must be implemented for this method to provide the type checking functionality. + ]]> @@ -228,11 +228,11 @@ Returns an instance of the requested item type. If there is no context item with the given type, an empty item will be created. Returns , which contains a context item of the requested type. If there is no item in the context for this type, a default one is created. - method, which must be implemented for this method to provide the get type functionality. - + method, which must be implemented for this method to provide the get type functionality. + ]]> @@ -292,11 +292,11 @@ Represents a helper method that performs delegate removals and that unwraps delegates that are proxies to generic callbacks. Returns , which contains the new delegate that should be assigned to . - method. - + method. + ]]> @@ -323,11 +323,11 @@ The value to set into the . When overridden in a derived class, sets a context item to the specified value. - to an empty value, create an instance of the item using a parameterless constructor. - + to an empty value, create an instance of the item using a parameterless constructor. + ]]> @@ -387,11 +387,11 @@ The type of item you want to subscribe to. - A that is invoked when changes. + A that is invoked when the changes. Adds an event callback that is invoked when a context item of the specified item type changes. To be added. - or is . + is . diff --git a/xml/System.Activities.Presentation/ServiceManager.xml b/xml/System.Activities.Presentation/ServiceManager.xml index dacf993c8b4..74954f45e43 100644 --- a/xml/System.Activities.Presentation/ServiceManager.xml +++ b/xml/System.Activities.Presentation/ServiceManager.xml @@ -26,11 +26,11 @@ Implements and provides access to services offered by the editing context. - represent functionality that is either provided by the host for the designer to use or that is used by the designer to make functionality available to all designers within the editor. It is obtained from the by the property. - + represent functionality that is either provided by the host for the designer to use or that is used by the designer to make functionality available to all designers within the editor. It is obtained from the by the property. + ]]> @@ -105,9 +105,9 @@ The type of service to check. - Returns a Boolean value that indicates whether the service manager contains a service of the given type. + Returns a value that indicates whether the service manager contains a service of the given type. - if a service of type has been published; otherwise, . + if a service of type has been published; otherwise, . To be added. @@ -160,11 +160,11 @@ Retrieves the requested service. A generic type, which is an instance of the service. - , this method throws a if the service is not available. - + , this method throws a if the service is not available. + ]]> There is no service of the given type. diff --git a/xml/System.Activities.XamlIntegration/ActivityXamlServices.xml b/xml/System.Activities.XamlIntegration/ActivityXamlServices.xml index bb2fe182e0e..8f8bdb92dff 100644 --- a/xml/System.Activities.XamlIntegration/ActivityXamlServices.xml +++ b/xml/System.Activities.XamlIntegration/ActivityXamlServices.xml @@ -26,11 +26,11 @@ Maps an activity tree to an or . - @@ -168,7 +168,7 @@ The type of the return value of the method that this delegate encapsulates. The XAML reader. Returns a delegate method for the specified XAML reader with return value of specified type. - A delegate method for the specified XAML reader with return value of type . + A delegate method for the specified XAML reader with return value of type . To be added. @@ -180,11 +180,11 @@ Maps an activity tree to an or . - diff --git a/xml/System.AddIn.Contract.Collections/ICollectionContract`1.xml b/xml/System.AddIn.Contract.Collections/ICollectionContract`1.xml index 379ba02590b..b5595d712e9 100644 --- a/xml/System.AddIn.Contract.Collections/ICollectionContract`1.xml +++ b/xml/System.AddIn.Contract.Collections/ICollectionContract`1.xml @@ -26,14 +26,14 @@ - The type of elements in the collection. must implement the interface. + The type of elements in the collection. must implement the interface. Represents a generic collection of objects. - can be dynamically resized. - + can be dynamically resized. + ]]> @@ -61,11 +61,11 @@ The to add to the . Adds an to the . - is read-only, call the method. - + is read-only, call the method. + ]]> The is read-only. @@ -91,11 +91,11 @@ Removes all elements from the . - is read-only, call the method. - + is read-only, call the method. + ]]> The is read-only. @@ -158,14 +158,14 @@ is less than 0. - is multidimensional. - - -or- - - The number of elements in the source is greater than the available space from to the end of the destination array. - - -or- - + is multidimensional. + + -or- + + The number of elements in the source is greater than the available space from to the end of the destination array. + + -or- + Type cannot be cast automatically to the type of the destination array. @@ -241,11 +241,11 @@ if is successfully removed; otherwise, . This method also returns if was not found in the . - is read-only, call the method. - + is read-only, call the method. + ]]> The is read-only. diff --git a/xml/System.AddIn.Contract/IListContract`1.xml b/xml/System.AddIn.Contract/IListContract`1.xml index 24486c5afee..2fb1adb325c 100644 --- a/xml/System.AddIn.Contract/IListContract`1.xml +++ b/xml/System.AddIn.Contract/IListContract`1.xml @@ -22,13 +22,13 @@ The contract type of the objects in the list. Represents a generic list of types that are defined by a contract and are used to pass collections of that contract type between a host and an add-in. - class uses an interface to pass collections, in both directions, between the host and the add-in. It is recommended that you use the class instead of using this class directly in your code. For an example, see [Walkthrough: Passing Collections Between Hosts and Add-Ins](/previous-versions/dotnet/netframework-4.0/bb384207(v=vs.100)). - - This class can be used to pass objects by reference between application domains because the objects are not serialized. - + class uses an interface to pass collections, in both directions, between the host and the add-in. It is recommended that you use the class instead of using this class directly in your code. For an example, see [Walkthrough: Passing Collections Between Hosts and Add-Ins](/previous-versions/dotnet/netframework-4.0/bb384207(v=vs.100)). + + This class can be used to pass objects by reference between application domains because the objects are not serialized. + ]]> @@ -56,11 +56,11 @@ The object to add. Adds an object to an collection. - @@ -208,18 +208,18 @@ Returns the item at the specified index of an collection. The item at the specified index. - method does not remove the item at the specified index. To remove an item from the collection, use the method. - + method does not remove the item at the specified index. To remove an item from the collection, use the method. + ]]> - is less than zero. - - -or- - + is less than zero. + + -or- + is equal to or greater than the return value of . @@ -247,21 +247,15 @@ Returns the index of a specific item in an collection. The index of the specified item. - method does not remove the item at the specified index. To remove an item from the collection, use the method. - + method does not remove the item at the specified index. To remove an item from the collection, use the method. + ]]> - - is less than zero. - - -or- - - is equal to or greater than the return value of the method. @@ -289,20 +283,20 @@ The object to insert in the collection. Inserts an item at the specified index in an collection. - method, the items that follow the insertion point move to accommodate the new item. The indexes of the items that are moved are also updated. To replace an item at a specified index, use the method. - - To determine whether an collection is read-only, call the method. - + method, the items that follow the insertion point move to accommodate the new item. The indexes of the items that are moved are also updated. To replace an item at a specified index, use the method. + + To determine whether an collection is read-only, call the method. + ]]> - is less than zero. - - -or- - + is less than zero. + + -or- + is equal to or greater than the return value of . The collection is read-only. @@ -332,11 +326,11 @@ if an item is removed; otherwise, . - @@ -364,20 +358,20 @@ The index of the item to remove. Removes the item at the specified index in an collection. - , the items that follow the removed item move to occupy the vacated spot. The indexes of the items that are moved are also updated. - - To determine whether an collection is read-only, call the method. - + , the items that follow the removed item move to occupy the vacated spot. The indexes of the items that are moved are also updated. + + To determine whether an collection is read-only, call the method. + ]]> - is less than zero. - - -or- - + is less than zero. + + -or- + is equal to or greater than the return value of the method. The collection is read-only. @@ -407,20 +401,20 @@ The item to set at the specified index. Sets the item at the specified index in an collection. - method sets the item at the specified index. To add an item to the collection, use the method. - - To determine whether an collection is read-only, call the method. - + method sets the item at the specified index. To add an item to the collection, use the method. + + To determine whether an collection is read-only, call the method. + ]]> - is less than zero. - - -or- - + is less than zero. + + -or- + is equal to or greater than the return value of the method. The collection is read-only. diff --git a/xml/System.AddIn.Hosting/AddInStore.xml b/xml/System.AddIn.Hosting/AddInStore.xml index 53d924238c3..9ed400cb1e7 100644 --- a/xml/System.AddIn.Hosting/AddInStore.xml +++ b/xml/System.AddIn.Hosting/AddInStore.xml @@ -17,31 +17,31 @@ Provides methods to store and find information about available add-ins and pipeline segments. -
This file is located in the root directory of the pipeline directory structure.|

Updates the file with new pipeline segments. If no new segments are installed, this method just validates the cache.



Rebuilds the file and includes new pipeline segments.| -|AddIns.store

This file is located in a directory that contains one or more add-in subdirectories. If this directory is in the pipeline directory structure, it must be named AddIns.|

Updates the file with new add-ins at a specified location. Call this method if your add-ins are outside the pipeline directory structure.

If no new add-ins are installed, this method just validates the cache.



Rebuilds the file and includes add-ins at a specified location. Call this method if your add-ins are outside the pipeline directory structure.



If the add-ins are in the pipeline directory structure, this method updates the file with new add-ins.



If the add-ins are in the pipeline directory structure, this method rebuilds the file and includes new add-ins.| - - These methods create the cache files if they do not previously exist. - - After the cache files are created, use the method to examine the files to find all add-ins that match a specified host view of the add-in. You can also use the method to find a specific add-in. - +
This file is located in the root directory of the pipeline directory structure.|

Updates the file with new pipeline segments. If no new segments are installed, this method just validates the cache.



Rebuilds the file and includes new pipeline segments.| +|AddIns.store

This file is located in a directory that contains one or more add-in subdirectories. If this directory is in the pipeline directory structure, it must be named AddIns.|

Updates the file with new add-ins at a specified location. Call this method if your add-ins are outside the pipeline directory structure.

If no new add-ins are installed, this method just validates the cache.



Rebuilds the file and includes add-ins at a specified location. Call this method if your add-ins are outside the pipeline directory structure.



If the add-ins are in the pipeline directory structure, this method updates the file with new add-ins.



If the add-ins are in the pipeline directory structure, this method rebuilds the file and includes new add-ins.| + + These methods create the cache files if they do not previously exist. + + After the cache files are created, use the method to examine the files to find all add-ins that match a specified host view of the add-in. You can also use the method to find a specific add-in. + > [!IMPORTANT] -> It is unsupported to allow untrusted users or entities to access PipelineSegments.store and Addins.store. Doing so can cause data corruption issues for applications. - - - -## Examples - The following example shows how to update cache files. - +> It is unsupported to allow untrusted users or entities to access PipelineSegments.store and Addins.store. Doing so can cause data corruption issues for applications. + + + +## Examples + The following example shows how to update cache files. + :::code language="csharp" source="~/snippets/csharp/System.AddIn.Hosting/AddInController/Overview/P3Host.cs" id="Snippet2"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/addinP3Host/vb/p3host.vb" id="Snippet2"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/addinP3Host/vb/p3host.vb" id="Snippet2"::: + ]]> Add-Ins and Extensibility @@ -83,26 +83,24 @@ Finds a specific add-in. A collection of tokens that contains only the token representing the add-in that was found. - collection. If multiple pipelines to the specified add-in are found, you can differentiate them by examining the property. - - - -## Examples - The following example finds a specific add-in. - + collection. If multiple pipelines to the specified add-in are found, you can differentiate them by examining the property. + +## Examples + The following example finds a specific add-in. + :::code language="csharp" source="~/snippets/csharp/System.AddIn.Hosting/AddInController/Overview/P3Host.cs" id="Snippet6"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/addinP3Host/vb/p3host.vb" id="Snippet6"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/addinP3Host/vb/p3host.vb" id="Snippet6"::: + ]]> - The length of or or is 0. - + The length of or or is 0. + -or- - - The add-in file does not exist in . + + The add-in file does not exist in . One or more parameters are . The caller does not have read access permission to . @@ -157,19 +155,19 @@ Finds all add-ins for a specified host view of the add-in at a location specified by the enumeration value. A collection of tokens that represent the add-ins that were found. - enumeration currently contains only the value, which points to the host's application base directory. - - - -## Examples - The following example finds add-ins at the location specified by the enumeration. - + enumeration currently contains only the value, which points to the host's application base directory. + + + +## Examples + The following example finds add-ins at the location specified by the enumeration. + :::code language="csharp" source="~/snippets/csharp/System.AddIn.Hosting/AddInController/Overview/P3Host.cs" id="Snippet4"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/addinP3Host/vb/p3host.vb" id="Snippet4"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/addinP3Host/vb/p3host.vb" id="Snippet4"::: + ]]> There is an access violation to the pipeline directory structure. @@ -213,20 +211,20 @@ The type that defines the host's view of the add-in. - One of the enumeration values. - + One of the enumeration values. + Currently the only value in this enumeration is the directory specified by the property that was used to set up the host's application domain. - (Optional). The path of the directory that contains one or more subdirectories of add-ins. Because this parameter takes an array of strings, you can specify more than one path. - + (Optional). The path of the directory that contains one or more subdirectories of add-ins. Because this parameter takes an array of strings, you can specify more than one path. + This parameter is not required if your add-ins are located in the pipeline directory structure under the AddIns folder. Finds all add-ins for a specified host view of the add-in at the location specified by a value and an optional add-ins folder. A collection of tokens that represent the add-ins that were found. - There is an access violation to the pipeline directory structure. @@ -275,17 +273,17 @@ The type that defines the host's view of the add-in. The path of the root of the pipeline directory structure. - (Optional). The path of the directory that contains one or more subdirectories of add-ins. Because this parameter takes an array of strings, you can specify more than one path. - + (Optional). The path of the directory that contains one or more subdirectories of add-ins. Because this parameter takes an array of strings, you can specify more than one path. + This parameter is not required if your add-ins are located in the pipeline directory structure under the AddIns folder. Finds all add-ins for a specified host view of the add-in from a specified root directory. A collection of tokens that represent the add-ins that were found. - collection to activate a specific add-in by calling the method of the class. - + collection to activate a specific add-in by calling the method of the class. + ]]> There is an access violation to the pipeline directory structure. @@ -335,17 +333,17 @@ - One of the enumeration values. - + One of the enumeration values. + Currently the only value in this enumeration is the directory specified by the property that was used to set up the host's application domain. Rebuilds the pipeline segments cache and includes new segments at the location specified by a value. A collection of strings that describe warnings as the pipeline segments are evaluated. - A segment directory is missing from the pipeline directory structure. @@ -388,13 +386,13 @@ Rebuilds the pipeline segments cache and includes new segments from a specified root directory. A collection of strings that describe warnings as the pipeline segments are evaluated. - method. - + method. + ]]> A segment directory is missing from the pipeline directory structure. @@ -432,13 +430,13 @@ Rebuilds the add-in cache and includes new add-ins from a specified root directory. A collection of strings that describe warnings as the pipeline segments are evaluated. - method. - + method. + ]]> A segment directory is missing from the pipeline directory structure. @@ -492,17 +490,17 @@ - One of the enumeration values. - + One of the enumeration values. + Currently the only value in this enumeration is the directory as specified by the property that was used to set up the host's application domain. Updates the pipeline segments cache with new segments at the location specified by a value. A collection of strings that describe warnings as the pipeline segments are evaluated. - A segment directory is missing from the pipeline directory structure. @@ -545,21 +543,21 @@ Updates the pipeline segments cache with new segments from a specified root directory. A collection of strings that describe warnings as the pipeline segments are evaluated. - class. - + class. + :::code language="csharp" source="~/snippets/csharp/System.AddIn.Hosting/AddInController/Overview/P3Host.cs" id="Snippet3"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/addinP3Host/vb/p3host.vb" id="Snippet3"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/addinP3Host/vb/p3host.vb" id="Snippet3"::: + ]]> A segment directory is missing from the pipeline directory structure. @@ -596,13 +594,13 @@ Updates the add-in cache and includes new add-ins at a specified location. A collection of strings that describe warnings as the pipeline segments are evaluated. - A segment directory is missing from the pipeline directory structure. diff --git a/xml/System.AddIn.Pipeline/CollectionAdapters.xml b/xml/System.AddIn.Pipeline/CollectionAdapters.xml index 8d8c4c8913e..466148d5f9f 100644 --- a/xml/System.AddIn.Pipeline/CollectionAdapters.xml +++ b/xml/System.AddIn.Pipeline/CollectionAdapters.xml @@ -17,13 +17,13 @@ Enables collections to be passed between an add-in and its host application. - collection to be converted to a collection. The collection is passed across the isolation boundary and converted back to an collection that the add-in or the host application can use. - - Objects in collections must be remotable. For more information about the object types that you can pass, see [Contracts, Views, and Adapters](/previous-versions/dotnet/netframework-4.0/bb384205(v=vs.100)). - + collection to be converted to a collection. The collection is passed across the isolation boundary and converted back to an collection that the add-in or the host application can use. + + Objects in collections must be remotable. For more information about the object types that you can pass, see [Contracts, Views, and Adapters](/previous-versions/dotnet/netframework-4.0/bb384205(v=vs.100)). + ]]> Add-Ins and Extensibility @@ -52,26 +52,26 @@ - The type of objects that are contained in the list. must be serializable. + The type of objects that are contained in the list. must be serializable. The collection from the other side of the pipeline. Converts the specified collection to an collection. The converted collection. - collection. The collection will have a lifetime token for the remote collection. - - You should use this method overload only when the contents of the are serializable types that can be passed directly to the add-in and host (rather than types that must be adapted into views). - - - -## Examples - The following example implements a host-side adapter pipeline segment as described [Walkthrough: Passing Collections Between Hosts and Add-Ins](/previous-versions/dotnet/netframework-4.0/bb384207(v=vs.100)). The example adapts the custom `ProcessBooks` method by taking the collection passed from the add-in and converting it to an collection, which the host application can then use. - + collection. The collection will have a lifetime token for the remote collection. + + You should use this method overload only when the contents of the are serializable types that can be passed directly to the add-in and host (rather than types that must be adapted into views). + + + +## Examples + The following example implements a host-side adapter pipeline segment as described [Walkthrough: Passing Collections Between Hosts and Add-Ins](/previous-versions/dotnet/netframework-4.0/bb384207(v=vs.100)). The example adapts the custom `ProcessBooks` method by taking the collection passed from the add-in and converting it to an collection, which the host application can then use. + :::code language="csharp" source="~/snippets/csharp/System.AddIn.Pipeline/CollectionAdapters/ToIListT/LibraryManagerViewToContractAddInAdapter.cs" id="Snippet3"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/AddInCollectionPipelineAddInSideAdapter/vb/LibraryManagerViewToContractAddInAdapter.vb" id="Snippet3"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/AddInCollectionPipelineAddInSideAdapter/vb/LibraryManagerViewToContractAddInAdapter.vb" id="Snippet3"::: + ]]> @@ -102,7 +102,7 @@ - The type that defines the contract for passing objects of type across the isolation boundary. + The type that defines the contract for passing objects of type across the isolation boundary. The type that defines the view of the objects in the list. The collection to pass to the other side of the pipeline. A converter that adapts the data from the type defined in the contract to the type expected in the view. @@ -110,11 +110,11 @@ Converts a specified collection to an collection by using converter adapters. The converted collection. - collections that contain types that must be adapted before they can be passed to the add-in or host (rather than simple serializable types that can be passed directly). The host application or add-in can use the returned collection. It will have a lifetime token for the remote . - + collections that contain types that must be adapted before they can be passed to the add-in or host (rather than simple serializable types that can be passed directly). The host application or add-in can use the returned collection. It will have a lifetime token for the remote . + ]]> @@ -142,26 +142,26 @@ - The type of objects that are contained in the list. must be serializable. + The type of objects that are contained in the list. must be serializable. The collection to convert. Converts a specified collection to an collection. The converted collection. - collection can be marshaled across the isolation boundary between the add-in and its host application. - - You should use this method overload only when the contents of the collection are serializable types that can be passed directly to the contract (rather than types that must be adapted into contracts). - - - -## Examples - The following example implements the class that defines an add-in side adapter pipeline segment. It adapts the custom `ProcessBooks` method by taking the collection passed from the add-in view segment and converting it to an collection that can be marshaled across the isolation boundary to the host. - + collection can be marshaled across the isolation boundary between the add-in and its host application. + + You should use this method overload only when the contents of the collection are serializable types that can be passed directly to the contract (rather than types that must be adapted into contracts). + + + +## Examples + The following example implements the class that defines an add-in side adapter pipeline segment. It adapts the custom `ProcessBooks` method by taking the collection passed from the add-in view segment and converting it to an collection that can be marshaled across the isolation boundary to the host. + :::code language="csharp" source="~/snippets/csharp/System.AddIn.Pipeline/CollectionAdapters/ToIListContractT/LibraryManagerContractToViewHostAdapter.cs" id="Snippet4"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/AddInCollectionPipelineHostSideAdapter/vb/LibraryManagerContractToViewHostAdapter.vb" id="Snippet4"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/AddInCollectionPipelineHostSideAdapter/vb/LibraryManagerContractToViewHostAdapter.vb" id="Snippet4"::: + ]]> @@ -193,18 +193,18 @@ The type that defines the view of the objects in the list. - The type that defines the contract for passing objects of type across the isolation boundary. + The type that defines the contract for passing objects of type across the isolation boundary. The collection to convert. A converter that adapts the data from the type defined in the view to the type expected by the contract. A converter that adapts the data from the type defined in the contract to the type expected in the view. Converts a specified collection to an collection by using converter adapters. The converted collection. - collections that contain types that must be adapted into contracts before they can be passed to the contract (rather than simple serializable types that can be passed directly). The collection can be marshaled across the isolation boundary between an add-in and its host application. - + collections that contain types that must be adapted into contracts before they can be passed to the contract (rather than simple serializable types that can be passed directly). The collection can be marshaled across the isolation boundary between an add-in and its host application. + ]]> diff --git a/xml/System.CodeDom.Compiler/CompilerErrorCollection.xml b/xml/System.CodeDom.Compiler/CompilerErrorCollection.xml index 36cb893ce65..c367cc0018d 100644 --- a/xml/System.CodeDom.Compiler/CompilerErrorCollection.xml +++ b/xml/System.CodeDom.Compiler/CompilerErrorCollection.xml @@ -36,23 +36,23 @@ Represents a collection of objects. - class provides a simple collection object that can be used to store a set of objects. - + class provides a simple collection object that can be used to store a set of objects. + > [!NOTE] -> This class contains an inheritance demand at the class level that applies to all members. A is thrown when the derived class does not have full-trust permission. For details about inheritance demands, see [Inheritance Demands](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/x4yx82e6(v=vs.100)). - - - -## Examples - The following example demonstrates how to use the class. The example creates a new instance of the class and uses several methods to add statements to the collection, return their index, and add or remove attributes at a specific index point. - +> This class contains an inheritance demand at the class level that applies to all members. A is thrown when the derived class does not have full-trust permission. For details about inheritance demands, see [Inheritance Demands](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/x4yx82e6(v=vs.100)). + + + +## Examples + The following example demonstrates how to use the class. The example creates a new instance of the class and uses several methods to add statements to the collection, return their index, and add or remove attributes at a specific index point. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/CompilerErrorCollectionExample/CPP/class1.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.CodeDom.Compiler/CompilerErrorCollection/Overview/class1.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/CompilerErrorCollectionExample/VB/class1.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/CompilerErrorCollectionExample/VB/class1.vb" id="Snippet1"::: + ]]> @@ -100,15 +100,15 @@ Initializes a new instance of the class. - class. - + class. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/CompilerErrorCollectionExample/CPP/class1.cpp" id="Snippet2"::: :::code language="csharp" source="~/snippets/csharp/System.CodeDom.Compiler/CompilerErrorCollection/Overview/class1.cs" id="Snippet2"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/CompilerErrorCollectionExample/VB/class1.vb" id="Snippet2"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/CompilerErrorCollectionExample/VB/class1.vb" id="Snippet2"::: + ]]> @@ -218,15 +218,15 @@ Adds the specified object to the error collection. The index at which the new element was inserted. - method to add a object to a . - + method to add a object to a . + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/CompilerErrorCollectionExample/CPP/class1.cpp" id="Snippet3"::: :::code language="csharp" source="~/snippets/csharp/System.CodeDom.Compiler/CompilerErrorCollection/Overview/class1.cs" id="Snippet3"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/CompilerErrorCollectionExample/VB/class1.vb" id="Snippet3"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/CompilerErrorCollectionExample/VB/class1.vb" id="Snippet3"::: + ]]> @@ -275,15 +275,15 @@ An array of type that contains the objects to add to the collection. Copies the elements of an array to the end of the error collection. - method overload to add an array of objects to a . - + method overload to add an array of objects to a . + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/CompilerErrorCollectionExample/CPP/class1.cpp" id="Snippet4"::: :::code language="csharp" source="~/snippets/csharp/System.CodeDom.Compiler/CompilerErrorCollection/Overview/class1.cs" id="Snippet4"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/CompilerErrorCollectionExample/VB/class1.vb" id="Snippet4"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/CompilerErrorCollectionExample/VB/class1.vb" id="Snippet4"::: + ]]> @@ -325,15 +325,15 @@ A object that contains the objects to add to the collection. Adds the contents of the specified compiler error collection to the end of the error collection. - method overload to add objects from one to another . - + method overload to add objects from one to another . + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/CompilerErrorCollectionExample/CPP/class1.cpp" id="Snippet4"::: :::code language="csharp" source="~/snippets/csharp/System.CodeDom.Compiler/CompilerErrorCollection/Overview/class1.cs" id="Snippet4"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/CompilerErrorCollectionExample/VB/class1.vb" id="Snippet4"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/CompilerErrorCollectionExample/VB/class1.vb" id="Snippet4"::: + ]]> @@ -377,15 +377,15 @@ if the is contained in the collection; otherwise, . - method to locate a specific object and determine the index value at which it was found. - + method to locate a specific object and determine the index value at which it was found. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/CompilerErrorCollectionExample/CPP/class1.cpp" id="Snippet5"::: :::code language="csharp" source="~/snippets/csharp/System.CodeDom.Compiler/CompilerErrorCollection/Overview/class1.cs" id="Snippet5"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/CompilerErrorCollectionExample/VB/class1.vb" id="Snippet5"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/CompilerErrorCollectionExample/VB/class1.vb" id="Snippet5"::: + ]]> @@ -427,24 +427,24 @@ The index in the array at which to start copying. Copies the collection values to a one-dimensional instance at the specified index. - method to copy the contents of a to an array, starting at the specified index value. - + method to copy the contents of a to an array, starting at the specified index value. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/CompilerErrorCollectionExample/CPP/class1.cpp" id="Snippet6"::: :::code language="csharp" source="~/snippets/csharp/System.CodeDom.Compiler/CompilerErrorCollection/Overview/class1.cs" id="Snippet6"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/CompilerErrorCollectionExample/VB/class1.vb" id="Snippet6"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/CompilerErrorCollectionExample/VB/class1.vb" id="Snippet6"::: + ]]> - The array indicated by the parameter is multidimensional. - - -or- - - The number of elements in the is greater than the available space between the index value of the parameter in the array indicated by the parameter and the end of the array indicated by the parameter. + The array indicated by the parameter is multidimensional. + + -or- + + The number of elements in the is greater than the available space between and the end of the array indicated by . The parameter is . - The parameter is less than the lowbound of the array indicated by the parameter. + The parameter is less than the lower bound of the array indicated by the parameter. @@ -551,15 +551,15 @@ Gets the index of the specified object in the collection, if it exists in the collection. The index of the specified in the , if found; otherwise, -1. - object and uses the method to determine the index value at which it was found. - + object and uses the method to determine the index value at which it was found. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/CompilerErrorCollectionExample/CPP/class1.cpp" id="Snippet5"::: :::code language="csharp" source="~/snippets/csharp/System.CodeDom.Compiler/CompilerErrorCollection/Overview/class1.cs" id="Snippet5"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/CompilerErrorCollectionExample/VB/class1.vb" id="Snippet5"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/CompilerErrorCollectionExample/VB/class1.vb" id="Snippet5"::: + ]]> @@ -601,15 +601,15 @@ The to insert. Inserts the specified into the collection at the specified index. - method to insert a object into a . - + method to insert a object into a . + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/CompilerErrorCollectionExample/CPP/class1.cpp" id="Snippet8"::: :::code language="csharp" source="~/snippets/csharp/System.CodeDom.Compiler/CompilerErrorCollection/Overview/class1.cs" id="Snippet8"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/CompilerErrorCollectionExample/VB/class1.vb" id="Snippet8"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/CompilerErrorCollectionExample/VB/class1.vb" id="Snippet8"::: + ]]> @@ -687,15 +687,15 @@ The to remove from the . Removes a specific from the collection. - item from a . - + item from a . + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/CompilerErrorCollectionExample/CPP/class1.cpp" id="Snippet9"::: :::code language="csharp" source="~/snippets/csharp/System.CodeDom.Compiler/CompilerErrorCollection/Overview/class1.cs" id="Snippet9"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/CompilerErrorCollectionExample/VB/class1.vb" id="Snippet9"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/CompilerErrorCollectionExample/VB/class1.vb" id="Snippet9"::: + ]]> The specified object is not found in the collection. diff --git a/xml/System.CodeDom/CodeGotoStatement.xml b/xml/System.CodeDom/CodeGotoStatement.xml index 58ce4e60e05..38443dca2eb 100644 --- a/xml/System.CodeDom/CodeGotoStatement.xml +++ b/xml/System.CodeDom/CodeGotoStatement.xml @@ -44,25 +44,25 @@ Represents a statement. - can be used to represent a `goto` statement, which is used in some languages to redirect program flow to a specified label. - - The property indicates the name of the label at which to continue program execution. - + can be used to represent a `goto` statement, which is used in some languages to redirect program flow to a specified label. + + The property indicates the name of the label at which to continue program execution. + > [!NOTE] -> Not all languages support `goto` statements. Call the method with the flag to determine whether a code generator supports `goto` statements. - - - -## Examples - The following example code demonstrates use of a and a to redirect program flow. - +> Not all languages support `goto` statements. Call the method with the flag to determine whether a code generator supports `goto` statements. + + + +## Examples + The following example code demonstrates use of a and a to redirect program flow. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/CodeGotoStatementExample/CPP/codegotostatementexample.cpp" id="Snippet2"::: :::code language="csharp" source="~/snippets/csharp/System.CodeDom/CodeGotoStatement/Overview/codegotostatementexample.cs" id="Snippet2"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/CodeGotoStatementExample/VB/codegotostatementexample.vb" id="Snippet2"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/CodeGotoStatementExample/VB/codegotostatementexample.vb" id="Snippet2"::: + ]]> @@ -109,11 +109,11 @@ Initializes a new instance of the class. - property to indicate the name of the label at which to continue program execution. - + property to indicate the name of the label at which to continue program execution. + ]]> @@ -150,7 +150,7 @@ Initializes a new instance of the class using the specified label name. To be added. - is . + is . @@ -191,16 +191,16 @@ Gets or sets the name of the label at which to continue program execution. A string that indicates the name of the label at which to continue program execution. - . - + . + ]]> - The label cannot be set because is or an empty string. + The label cannot be set because the value is or an empty string. diff --git a/xml/System.ComponentModel.Composition.Hosting/AssemblyCatalog.xml b/xml/System.ComponentModel.Composition.Hosting/AssemblyCatalog.xml index 9fdf68ef258..fd08594f54c 100644 --- a/xml/System.ComponentModel.Composition.Hosting/AssemblyCatalog.xml +++ b/xml/System.ComponentModel.Composition.Hosting/AssemblyCatalog.xml @@ -252,7 +252,7 @@ The assembly referenced by `codeBase` is loaded into the Load context. specified a directory. - or is . + or is . is not found. @@ -298,7 +298,7 @@ The assembly referenced by `codeBase` is loaded into the Load context. specified a directory. - or is . + or is . is not found. @@ -378,7 +378,7 @@ The assembly referenced by `codeBase` is loaded into the Load context. specified a directory. - , or is . + , or is . is not found. diff --git a/xml/System.ComponentModel.Composition.Hosting/CatalogExportProvider.xml b/xml/System.ComponentModel.Composition.Hosting/CatalogExportProvider.xml index dca00b87f44..3788f98f56a 100644 --- a/xml/System.ComponentModel.Composition.Hosting/CatalogExportProvider.xml +++ b/xml/System.ComponentModel.Composition.Hosting/CatalogExportProvider.xml @@ -29,13 +29,13 @@ Retrieves exports from a catalog. - [!IMPORTANT] -> This type implements the interface. When you have finished using the type, you should dispose of it either directly or indirectly. To dispose of the type directly, call its method in a `try`/`catch` block. To dispose of it indirectly, use a language construct such as `using` (in C#) or `Using` (in Visual Basic). For more information, see the "Using an Object that Implements IDisposable" section in the interface topic. - +> This type implements the interface. When you have finished using the type, you should dispose of it either directly or indirectly. To dispose of the type directly, call its method in a `try`/`catch` block. To dispose of it indirectly, use a language construct such as `using` (in C#) or `Using` (in Visual Basic). For more information, see the "Using an Object that Implements IDisposable" section in the interface topic. + ]]> @@ -189,16 +189,16 @@ Releases all resources used by the current instance of the class. - . The `Dispose` method leaves the in an unusable state. After calling `Dispose`, 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). - + . The `Dispose` method leaves the in an unusable state. After calling `Dispose`, 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 `Dispose` 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 `Dispose` 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. + ]]> @@ -263,11 +263,11 @@ Returns all exports that match the conditions of the specified import. A collection that contains all the exports that match the specified condition. - method should return an empty collection of objects. - + method should return an empty collection of objects. + ]]> @@ -299,20 +299,20 @@ Gets or sets the export provider that provides access to additional exports. The export provider that provides the access to additional objects. The default is . - object. - + object. + ]]> The has been disposed of. - is . - This property has already been set. - - -or- - + The value to set is . + This property has already been set. + + -or- + The methods on the object have already been accessed. diff --git a/xml/System.ComponentModel.Composition.Hosting/ComposablePartExportProvider.xml b/xml/System.ComponentModel.Composition.Hosting/ComposablePartExportProvider.xml index d71306dbc8d..10a204d335e 100644 --- a/xml/System.ComponentModel.Composition.Hosting/ComposablePartExportProvider.xml +++ b/xml/System.ComponentModel.Composition.Hosting/ComposablePartExportProvider.xml @@ -29,13 +29,13 @@ Retrieves exports from a part. - [!IMPORTANT] -> This type implements the interface. When you have finished using the type, you should dispose of it either directly or indirectly. To dispose of the type directly, call its method in a `try`/`catch` block. To dispose of it indirectly, use a language construct such as `using` (in C#) or `Using` (in Visual Basic). For more information, see the "Using an Object that Implements IDisposable" section in the interface topic. - +> This type implements the interface. When you have finished using the type, you should dispose of it either directly or indirectly. To dispose of the type directly, call its method in a `try`/`catch` block. To dispose of it indirectly, use a language construct such as `using` (in C#) or `Using` (in Visual Basic). For more information, see the "Using an Object that Implements IDisposable" section in the interface topic. + ]]> @@ -178,16 +178,16 @@ Releases all resources used by the current instance of the class. - . The `Dispose` method leaves the in an unusable state. After calling `Dispose`, 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). - + . The `Dispose` method leaves the in an unusable state. After calling `Dispose`, 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 `Dispose` 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 `Dispose` 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. + ]]> @@ -258,11 +258,11 @@ Gets a collection of all exports in this provider that match the conditions of the specified import. A collection of all exports in this provider that match the specified conditions. - method should return an empty collection of objects. - + method should return an empty collection of objects. + ]]> @@ -292,24 +292,24 @@ Gets or sets the export provider that provides access to additional objects. - A provider that provides the access to objects. - + A provider that provides the access to objects. + The default is . - . - + . + ]]> The has been disposed of. - is . - This property has already been set. - - -or- - + The value to set is . + This property has already been set. + + -or- + The methods on the have already been accessed. diff --git a/xml/System.ComponentModel.Composition.Primitives/Export.xml b/xml/System.ComponentModel.Composition.Primitives/Export.xml index e7ddaafcabb..c11ec179754 100644 --- a/xml/System.ComponentModel.Composition.Primitives/Export.xml +++ b/xml/System.ComponentModel.Composition.Primitives/Export.xml @@ -97,7 +97,7 @@ -or- - is . + is . @@ -135,7 +135,7 @@ -or- - is . + is . is an empty string (""). @@ -184,7 +184,7 @@ -or- - is . + is . is an empty string (""). diff --git a/xml/System.ComponentModel.Design.Serialization/CodeDomSerializerBase.xml b/xml/System.ComponentModel.Design.Serialization/CodeDomSerializerBase.xml index 7d5b87ac814..500d782dd69 100644 --- a/xml/System.ComponentModel.Design.Serialization/CodeDomSerializerBase.xml +++ b/xml/System.ComponentModel.Design.Serialization/CodeDomSerializerBase.xml @@ -44,11 +44,11 @@ Provides a base class for classes. - class is used as a shared base between the and classes. Public classes derive from the class. Each public class defines its own public API. The class defines no public API, but does offer a multitude of utility methods that can be used to aid the serialization process. - + class is used as a shared base between the and classes. Public classes derive from the class. Each public class defines its own public API. The class defines no public API, but does offer a multitude of utility methods that can be used to aid the serialization process. + ]]> @@ -103,25 +103,25 @@ Deserializes the given expression into an in-memory object. An object resulting from interpretation of . - |This expression represents `this` or `Me`. To locate the object that is associated with this expression, the method will look in the context stack for a . This object contains the root object of the graph and the expression that represents it. If the object is present and the expression matches, the root object will be returned. An error is reported if an instance cannot be located.| -||If the target of the field reference evaluates to the root object, the method of the manager parameter will be used to retrieve the object instance based on name. Otherwise, standard reflection is used against the target object to locate the requested field. An error is reported if the field cannot be located.| -||The method of the `manager` parameter is used to locate the instance representing the given variable name. An error is reported if an instance cannot be located.| - - continues to interpret expressions until they are completely resolved to an object, or until it can no longer simplify the expression. In this case, will return a that contains the most simplified expression. The following expressions are not supported: - -- - -- - -- - + |This expression represents `this` or `Me`. To locate the object that is associated with this expression, the method will look in the context stack for a . This object contains the root object of the graph and the expression that represents it. If the object is present and the expression matches, the root object will be returned. An error is reported if an instance cannot be located.| +||If the target of the field reference evaluates to the root object, the method of the manager parameter will be used to retrieve the object instance based on name. Otherwise, standard reflection is used against the target object to locate the requested field. An error is reported if the field cannot be located.| +||The method of the `manager` parameter is used to locate the instance representing the given variable name. An error is reported if an instance cannot be located.| + + continues to interpret expressions until they are completely resolved to an object, or until it can no longer simplify the expression. In this case, will return a that contains the most simplified expression. The following expressions are not supported: + +- + +- + +- + ]]> @@ -186,11 +186,11 @@ Returns an instance of the given type. An instance of . - method is invoked during deserialization to obtain an instance of an object. When this is called, an instance of the requested type should be returned. The default implementation invokes the method of the `manager` parameter. - + method is invoked during deserialization to obtain an instance of an object. When this is called, an instance of the requested type should be returned. The default implementation invokes the method of the `manager` parameter. + ]]> @@ -243,15 +243,15 @@ An array that filters which properties will be deserialized. Deserializes properties on the given object from the invariant culture's resource bundle. - method is a helper method that derived classes can call. It looks for properties on the given object and attempts to load their values out of the invariant culture's resource bundle. This is generally used to handle design-time properties that are not emitted into source code. It should not be used for localized properties because it only operates on the invariant culture. - - This method inspects all of the properties of the `value` parameter that match the attributes specified by the `filter` parameter, and then checks for those properties in a resource binary object. This is useful for deserializing properties that cannot be represented in code, such as design-time properties. - - This method requires that a designer loader offers an to read resources. If the provides a for the invariant culture, then will read resources from the XML resource (.resx) file's metadata section, which is not included in final compiled code. If this service is not available, no resources will be read. - + method is a helper method that derived classes can call. It looks for properties on the given object and attempts to load their values out of the invariant culture's resource bundle. This is generally used to handle design-time properties that are not emitted into source code. It should not be used for localized properties because it only operates on the invariant culture. + + This method inspects all of the properties of the `value` parameter that match the attributes specified by the `filter` parameter, and then checks for those properties in a resource binary object. This is useful for deserializing properties that cannot be represented in code, such as design-time properties. + + This method requires that a designer loader offers an to read resources. If the provides a for the invariant culture, then will read resources from the XML resource (.resx) file's metadata section, which is not included in final compiled code. If this service is not available, no resources will be read. + ]]> @@ -292,13 +292,13 @@ The to deserialize. Deserializes a statement by interpreting and executing a CodeDOM statement. - method is a helper method that derived classes can call. It interprets the `statement` parameter. - - The being deserialized will be pushed on the context stack. - + method is a helper method that derived classes can call. It interprets the `statement` parameter. + + The being deserialized will be pushed on the context stack. + ]]> @@ -460,21 +460,21 @@ Returns an expression for the given object. A representing , or if there is no existing expression for . - method returns an expression representing the given object. It can return `null`, indicating that no expression has been set that describes the object. Expressions are acquired in one of three ways: - -- The expression could be the result of a prior call to the method. - -- The expression could have been found in the . - -- The expression could be derived through . - - To derive expressions through , the method queries the reference service for a name for the given object. If the expression service returns a valid name, , the method checks to see if there is a "." in the name. This indicates that the expression service found this object as the return value of a read-only property on another object. If there is a ".", will split the reference into parts. The leftmost part is a name that will be evaluated with the method. For each subsequent part, a property reference expression will be built. The final expression will then be returned. - - If the object did not have an expression set, or if the object was not found in the reference service, will return `null`, indicating there is no existing expression for the object. - + method returns an expression representing the given object. It can return `null`, indicating that no expression has been set that describes the object. Expressions are acquired in one of three ways: + +- The expression could be the result of a prior call to the method. + +- The expression could have been found in the . + +- The expression could be derived through . + + To derive expressions through , the method queries the reference service for a name for the given object. If the expression service returns a valid name, , the method checks to see if there is a "." in the name. This indicates that the expression service found this object as the return value of a read-only property on another object. If there is a ".", will split the reference into parts. The leftmost part is a name that will be evaluated with the method. For each subsequent part, a property reference expression will be built. The final expression will then be returned. + + If the object did not have an expression set, or if the object was not found in the reference service, will return `null`, indicating there is no existing expression for the object. + ]]> @@ -564,11 +564,11 @@ Gets a reflection type generated from type metadata. A reflection type generated from the metadata of . - @@ -605,13 +605,13 @@ The serialization manager. The object to use metadata from. Gets a reflection type generated from object metadata. - A reflection type generated from the metadata of . + A reflection type generated from the metadata of . - @@ -668,11 +668,11 @@ Locates a serializer for the given object value. A that is appropriate for . - method is an extension to the method. The method takes an object type, rather than an object value. If an external party had overridden metadata for a specific object through , that metadata override would not be seen by the method, which only takes a type. The method checks the metadata of the value and the value's type. If the two differ, will look to see if there is a custom designer serializer attribute on the value. If so, will attempt to use it. Otherwise, it will defer to . - + method is an extension to the method. The method takes an object type, rather than an object value. If an external party had overridden metadata for a specific object through , that metadata override would not be seen by the method, which only takes a type. The method checks the metadata of the value and the value's type. If the two differ, will look to see if there is a custom designer serializer attribute on the value. If so, will attempt to use it. Otherwise, it will defer to . + ]]> @@ -717,11 +717,11 @@ Locates a serializer for the given type. A that is appropriate for . - method is an extension to the method. The method takes an object type, rather than an object value. - + method is an extension to the method. The method takes an object type, rather than an object value. + ]]> @@ -802,11 +802,11 @@ Returns a unique name for the given object. A unique name for . - method calls the method. If this method does not return a name, then uses to fabricate a valid name for the object. If the service is not available, will fabricate a name based on the short type name combined with an index number to make it unique. The resulting name is associated with the serialization manager by calling the method before the new name is returned. - + method calls the method. If this method does not return a name, then uses to fabricate a valid name for the object. If the service is not available, will fabricate a name based on the short type name combined with an index number to make it unique. The resulting name is associated with the serialization manager by calling the method before the new name is returned. + ]]> @@ -867,11 +867,11 @@ if has been serialized; otherwise, . - method to create a relationship between `value` and a referring expression. - + method to create a relationship between `value` and a referring expression. + ]]> @@ -919,11 +919,11 @@ if has been serialized; otherwise, . - method to create a relationship between `value` and a referring expression. - + method to create a relationship between `value` and a referring expression. + ]]> @@ -971,13 +971,13 @@ Returns an expression representing the creation of the given object. An expression representing the creation of . - method can be used to serialize an expression that represents the creation of the `value` parameter. It is aware of instance descriptors. - - The `isComplete` parameter is set to `true` if the expression represents a fully configured object, or `false` if further serialization must be done on the object's properties. - + method can be used to serialize an expression that represents the creation of the `value` parameter. It is aware of instance descriptors. + + The `isComplete` parameter is set to `true` if the expression represents a fully configured object, or `false` if further serialization must be done on the object's properties. + ]]> @@ -1024,15 +1024,15 @@ An specifying the event to serialize. Serializes the given event into the given statement collection. - method is a helper method that derived classes can call to serialize a single event into the given . queries the serialization manager for a for the given event, and then asks the to serialize it. - - places the `statements` and `descriptor` parameters on the . - - requires an to discover event bindings to methods that are not compiled. If this service is not present, event bindings to non-compiled methods will not be written. Event bindings to compiled methods will still be serialized if the objects to which the events are bound can be converted into expressions. - + method is a helper method that derived classes can call to serialize a single event into the given . queries the serialization manager for a for the given event, and then asks the to serialize it. + + places the `statements` and `descriptor` parameters on the . + + requires an to discover event bindings to methods that are not compiled. If this service is not present, event bindings to non-compiled methods will not be written. Event bindings to compiled methods will still be serialized if the objects to which the events are bound can be converted into expressions. + ]]> @@ -1097,13 +1097,13 @@ An array that filters which events will be serialized. Serializes the specified events into the given statement collection. - method is a helper method that derived classes can call. It looks at events on the `value` parameter that match the `filter` parameter, and then it calls the method for each event. - - The method places the for `value` on the . - + method is a helper method that derived classes can call. It looks at events on the `value` parameter that match the `filter` parameter, and then it calls the method for each event. + + The method places the for `value` on the . + ]]> @@ -1160,13 +1160,13 @@ An array that filters which properties will be serialized. Serializes the properties on the given object into the given statement collection. - method is a helper method that derived classes can call. It looks at properties on the `value` parameter that match the `filter` parameter, and then it calls the method for each property. - - The method places the for `value` on the . - + method is a helper method that derived classes can call. It looks at properties on the `value` parameter that match the `filter` parameter, and then it calls the method for each property. + + The method places the for `value` on the . + ]]> @@ -1223,15 +1223,15 @@ An array that filters which properties will be serialized. Serializes the properties on the given object into the invariant culture's resource bundle. - method is a helper method that derived classes can call. It looks at properties on the `value` parameter that match the `filter` parameter, and then it serializes the properties into the invariant culture resource bundle. If the resource service returns a , the property values will be stored in the metadata section of the XML resource (.resx) file. The `statements` parameter is not used. - - To be serialized as a resource, a property must be simple (not a content property) and its value must be serializable. Properties that do not conform to this pattern will be skipped. - - requires an to obtain a to write resources for the invariant culture. If this service is not available, no resources will be written. - + method is a helper method that derived classes can call. It looks at properties on the `value` parameter that match the `filter` parameter, and then it serializes the properties into the invariant culture resource bundle. If the resource service returns a , the property values will be stored in the metadata section of the XML resource (.resx) file. The `statements` parameter is not used. + + To be serialized as a resource, a property must be simple (not a content property) and its value must be serializable. Properties that do not conform to this pattern will be skipped. + + requires an to obtain a to write resources for the invariant culture. If this service is not available, no resources will be written. + ]]> @@ -1282,13 +1282,13 @@ The property to serialize. Serializes a property on the given object. - method retrieves a for the `propertyToSerialize` parameter and delegates to it. - - places the `statements` and `propertyToSerialize` parameters on the . - + method retrieves a for the `propertyToSerialize` parameter and delegates to it. + + places the `statements` and `propertyToSerialize` parameters on the . + ]]> @@ -1343,13 +1343,13 @@ The object to serialize. Serializes the given object into a resource bundle using the given resource name. - method is a helper method that serializes a value to a resource bundle under the given name. The culture that the resource is written to is determined by searching the serialization manager's collection for a property called `ResourceCulture`. If this property exists, resources will be written to that culture. Otherwise, resources will be written to the invariant culture. The `value` parameter must be serializable. - - requires an to obtain a to write resources for the correct culture. If this service is not available, will instead build a binary object in code that represents the resource. - + method is a helper method that serializes a value to a resource bundle under the given name. The culture that the resource is written to is determined by searching the serialization manager's collection for a property called `ResourceCulture`. If this property exists, resources will be written to that culture. Otherwise, resources will be written to the invariant culture. The `value` parameter must be serializable. + + requires an to obtain a to write resources for the correct culture. If this service is not available, will instead build a binary object in code that represents the resource. + ]]> @@ -1406,13 +1406,13 @@ The object to serialize. Serializes the given object into a resource bundle using the given resource name. - method requires an to obtain a to write resources for the correct culture. If this service is not available, will instead build a binary object in code that represents the resource. - + method requires an to obtain a to write resources for the correct culture. If this service is not available, will instead build a binary object in code that represents the resource. + ]]> @@ -1464,30 +1464,30 @@ Serializes the given object into an expression. A object if can be serialized; otherwise, . - method uses the following rules for serializing types: - -1. It first calls the method to see if an expression has already been created for the object. If so, it returns the existing expression. - -2. It then locates the object's serializer, and asks it to serialize. - -3. If the return value of the object's serializer is a , the expression is returned. - -4. It makes one last call to to see if the serializer added an expression. - -5. Finally, it returns `null`. - - If no expression could be created and no suitable serializer could be found, an error will be reported through the serialization manager. No error will be reported if a serializer was found but it failed to produce an expression. In this case, it is assumed that the serializer either already reported the error or it did not attempt to serialize the object. - - If the serializer returned a statement or a collection of statements, those statements will not be discarded. The method will first look for a on the context stack and add statements to the statement context object's property. If there is no statement context, the method will look in the context for a and add the statements there. If no place can be found to add the statements, an error will be generated. - + method uses the following rules for serializing types: + +1. It first calls the method to see if an expression has already been created for the object. If so, it returns the existing expression. + +2. It then locates the object's serializer, and asks it to serialize. + +3. If the return value of the object's serializer is a , the expression is returned. + +4. It makes one last call to to see if the serializer added an expression. + +5. Finally, it returns `null`. + + If no expression could be created and no suitable serializer could be found, an error will be reported through the serialization manager. No error will be reported if a serializer was found but it failed to produce an expression. In this case, it is assumed that the serializer either already reported the error or it did not attempt to serialize the object. + + If the serializer returned a statement or a collection of statements, those statements will not be discarded. The method will first look for a on the context stack and add statements to the statement context object's property. If there is no statement context, the method will look in the context for a and add the statements there. If no place can be found to add the statements, an error will be generated. + > [!NOTE] -> You should not call the method within when serializing your own object. Instead, you should call . If it returns `null`, create your own expression and call . Then proceed with the rest of your serialization. - +> You should not call the method within when serializing your own object. Instead, you should call . If it returns `null`, create your own expression and call . Then proceed with the rest of your serialization. + ]]> @@ -1557,19 +1557,19 @@ Serializes the given object into an expression. A containing as a serialized expression. - method is a helper method that serializes a value to a resource expression. This is in contrast to the method, which writes a value to a resource binary object. goes one step further and returns an expression that can be used to recover the resource. For example, the return value might be "rm.GetValue("SomeBitmap");". The name of the resource is calculated from the , if one can be found on the context stack. - - The method will look on the for the following objects: - -- - a collection of statements to add a resource manager to, if one needs to be declared. - -- - the root expression, which is needed to create a resource manager. - -- - used to fabricate a name for the resource and to decide what type of resource manager call to make. - + method is a helper method that serializes a value to a resource expression. This is in contrast to the method, which writes a value to a resource binary object. goes one step further and returns an expression that can be used to recover the resource. For example, the return value might be "rm.GetValue("SomeBitmap");". The name of the resource is calculated from the , if one can be found on the context stack. + + The method will look on the for the following objects: + +- - a collection of statements to add a resource manager to, if one needs to be declared. + +- - the root expression, which is needed to create a resource manager. + +- - used to fabricate a name for the resource and to decide what type of resource manager call to make. + ]]> @@ -1625,11 +1625,11 @@ Serializes the given object into an expression appropriate for the invariant culture. A containing as a serialized expression. - method will also write the resource value into the invariant culture's resource file if the current `ResourceCulture` is not the invariant culture. - + method will also write the resource value into the invariant culture's resource file if the current `ResourceCulture` is not the invariant culture. + ]]> @@ -1690,11 +1690,11 @@ The with which to associate . Associates an object with an expression. - method is a helper method that associates a with an object. Objects that have been associated with expressions in this way are accessible through the method. stores its expression table as an appended object on the context stack so it is accessible by any serializer's method. - + method is a helper method that associates a with an object. Objects that have been associated with expressions in this way are accessible through the method. stores its expression table as an appended object on the context stack so it is accessible by any serializer's method. + ]]> @@ -1743,11 +1743,11 @@ to specify a preset expression; otherwise, . Associates an object with an expression, optionally specifying a preset expression. - method is a helper method that associates a with an object. Objects that have been associated with expressions in this way are accessible through the method. The stores its expression table as an appended object on the context stack so it is accessible by any serializer's method. - + method is a helper method that associates a with an object. Objects that have been associated with expressions in this way are accessible through the method. The stores its expression table as an appended object on the context stack so it is accessible by any serializer's method. + ]]> diff --git a/xml/System.ComponentModel.Design.Serialization/CodeDomSerializerException.xml b/xml/System.ComponentModel.Design.Serialization/CodeDomSerializerException.xml index f5c4116ec32..b4efd821f7f 100644 --- a/xml/System.ComponentModel.Design.Serialization/CodeDomSerializerException.xml +++ b/xml/System.ComponentModel.Design.Serialization/CodeDomSerializerException.xml @@ -46,20 +46,20 @@ The exception that is thrown when line number information is available for a serialization error. - with an example message and a . - + with an example message and a . + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Winforms/CodeDomSerializerExceptionExample/CPP/source.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.ComponentModel.Design.Serialization/CodeDomSerializerException/Overview/source.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/CodeDomSerializerExceptionExample/VB/source.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/CodeDomSerializerExceptionExample/VB/source.vb" id="Snippet1"::: + ]]> @@ -148,7 +148,7 @@ Initializes a new instance of the class. To be added. - is . + is . @@ -261,7 +261,7 @@ Initializes a new instance of the class. To be added. - is . + is . diff --git a/xml/System.ComponentModel.Design.Serialization/ComponentSerializationService.xml b/xml/System.ComponentModel.Design.Serialization/ComponentSerializationService.xml index 47bf5b59a91..47639004748 100644 --- a/xml/System.ComponentModel.Design.Serialization/ComponentSerializationService.xml +++ b/xml/System.ComponentModel.Design.Serialization/ComponentSerializationService.xml @@ -47,15 +47,15 @@ Provides the base class for serializing a set of components or serializable objects into a serialization store. - serializes a set of components or serializable objects into a serialization store. The store can then be deserialized later. The class differs from other serialization schemes in that the serialization format is opaque, and it allows for partial serialization of objects. For example, you can choose to serialize only selected properties for an object. - - This class is `abstract`. Typically, a will provide a concrete implementation of this class and add it as a service to its . This allows objects to be serialized in the format best suited for them. - - The class replaces the interface from the .NET Framework version 1.0, although the latter is retained for backward compatibility. - + serializes a set of components or serializable objects into a serialization store. The store can then be deserialized later. The class differs from other serialization schemes in that the serialization format is opaque, and it allows for partial serialization of objects. For example, you can choose to serialize only selected properties for an object. + + This class is `abstract`. Typically, a will provide a concrete implementation of this class and add it as a service to its . This allows objects to be serialized in the format best suited for them. + + The class replaces the interface from the .NET Framework version 1.0, although the latter is retained for backward compatibility. + ]]> @@ -148,13 +148,13 @@ Creates a new . A new created serialization store. - or method. Once closed, a serialization store can be used for deserialization, or it can be saved into a stream. - - The serialization store can be passed to any of the various serializing methods to build up serialization state for a group of objects. - + or method. Once closed, a serialization store can be used for deserialization, or it can be saved into a stream. + + The serialization store can be passed to any of the various serializing methods to build up serialization state for a group of objects. + ]]> @@ -211,11 +211,11 @@ Deserializes the given store to produce a collection of objects. A collection of objects created according to the stored state. - @@ -269,13 +269,13 @@ Deserializes the given store and populates the given with deserialized objects. A collection of objects created according to the stored state. - are added to `container`. - + are added to `container`. + ]]> @@ -345,11 +345,11 @@ The container to which objects will be added. Deserializes the given to the given container. - method deserializes `store`, but instead of producing new objects, it applies the data in the store to an existing set of objects that are taken from the provided container. As a result, the caller can create in advance an object however it sees fit. If an object has a deserialization state and the object is not named in the set of existing objects, a new object will be created. If that object also implements , it will be added to `container`. Objects in the container must have names and types that match objects in the serialization store in order for an existing object to be used. - + method deserializes `store`, but instead of producing new objects, it applies the data in the store to an existing set of objects that are taken from the provided container. As a result, the caller can create in advance an object however it sees fit. If an object has a deserialization state and the object is not named in the set of existing objects, a new object will be created. If that object also implements , it will be added to `container`. Objects in the container must have names and types that match objects in the serialization store in order for an existing object to be used. + ]]> @@ -411,11 +411,11 @@ to guarantee that the deserialization will only work if applied to an object of the same type. Deserializes the given to the given container, optionally validating recycled types. - method deserializes `store`, but instead of producing new objects, it applies the data in the store to an existing set of objects that are taken from the provided container. As a result, the caller can create in advance an object however it sees fit. If an object has a deserialization state and the object is not named in the set of existing objects, a new object will be created. If that object also implements , it will be added to `container`. Objects in the container must have names and types that match objects in the serialization store in order for an existing object to be used. - + method deserializes `store`, but instead of producing new objects, it applies the data in the store to an existing set of objects that are taken from the provided container. As a result, the caller can create in advance an object however it sees fit. If an object has a deserialization state and the object is not named in the set of existing objects, a new object will be created. If that object also implements , it will be added to `container`. Objects in the container must have names and types that match objects in the serialization store in order for an existing object to be used. + ]]> @@ -474,11 +474,11 @@ to indicate that the default property values should be applied. Deserializes the given to the given container, optionally applying default property values. - method deserializes `store`, but instead of producing new objects, it applies the data in the store to an existing set of objects that are taken from the provided container. As a result, the caller can create in advance an object however it sees fit. If an object has a deserialization state and the object is not named in the set of existing objects, a new object will be created. If that object also implements , it will be added to `container`. Objects in the container must have names and types that match objects in the serialization store in order for an existing object to be used. - + method deserializes `store`, but instead of producing new objects, it applies the data in the store to an existing set of objects that are taken from the provided container. As a result, the caller can create in advance an object however it sees fit. If an object has a deserialization state and the object is not named in the set of existing objects, a new object will be created. If that object also implements , it will be added to `container`. Objects in the container must have names and types that match objects in the serialization store in order for an existing object to be used. + ]]> @@ -530,11 +530,11 @@ Loads a from a stream. A new instance. - methods. - + methods. + ]]> @@ -587,11 +587,11 @@ The object to serialize. Serializes the given object to the given . - @@ -646,15 +646,15 @@ The object to serialize. Serializes the given object, accounting for default property values. - method, only serializes values that differ from the component's default state. This provides the most compact serialization mechanism but assumes that a newly created object will be used during deserialization. If an existing object is used, the resulting deserialized object is not guaranteed to duplicate the original state of the serialized object; the properties that contained default values during serialization will not be reset back to their defaults during deserialization. - - The method does not use this shortcut. It serializes all properties of the source object so that deserialization can restore all the object's properties, regardless of default state. - - This method is particularly useful for serializing collections, because the order of the constituent items within the collection can change. In this circumstance, the safest process to restore the original state of the entire collection is to overwrite all the items with all their original property values. - + method, only serializes values that differ from the component's default state. This provides the most compact serialization mechanism but assumes that a newly created object will be used during deserialization. If an existing object is used, the resulting deserialized object is not guaranteed to duplicate the original state of the serialized object; the properties that contained default values during serialization will not be reset back to their defaults during deserialization. + + The method does not use this shortcut. It serializes all properties of the source object so that deserialization can restore all the object's properties, regardless of default state. + + This method is particularly useful for serializing collections, because the order of the constituent items within the collection can change. In this circumstance, the safest process to restore the original state of the entire collection is to overwrite all the items with all their original property values. + ]]> @@ -712,15 +712,15 @@ A specifying the member to serialize. Serializes the given member on the given object. - method can be invoked multiple times for the same object to build up a list of serialized members within the serialization store. In general, the member should be a property or an event. - + method can be invoked multiple times for the same object to build up a list of serialized members within the serialization store. In general, the member should be a property or an event. + ]]> - or is . + or is . is closed, or is not a supported type of serialization store. Use a store returned by . @@ -773,17 +773,17 @@ The member to serialize. Serializes the given member on the given object, accounting for the default property value. - method serializes the `member` on `owningObject`, even if `member` contains the default property value. - - Note that for some members, containing the default value and restoring the setting of the same value to the member are different concepts. For example, if a property inherits its value from a parent object when no local value is set, setting the value back to the property may not be what is desired. The method takes this into account and would clear the state of the property in this case. - + method serializes the `member` on `owningObject`, even if `member` contains the default property value. + + Note that for some members, containing the default value and restoring the setting of the same value to the member are different concepts. For example, if a property inherits its value from a parent object when no local value is set, setting the value back to the property may not be what is desired. The method takes this into account and would clear the state of the property in this case. + ]]> - or is . + or is . is closed, or is not a supported type of serialization store. Use a store returned by . diff --git a/xml/System.ComponentModel.Design.Serialization/ObjectStatementCollection.xml b/xml/System.ComponentModel.Design.Serialization/ObjectStatementCollection.xml index 5ac657e6dc3..c11cb655e08 100644 --- a/xml/System.ComponentModel.Design.Serialization/ObjectStatementCollection.xml +++ b/xml/System.ComponentModel.Design.Serialization/ObjectStatementCollection.xml @@ -207,15 +207,15 @@ A collection of statement owners to add to the table. Populates the statement table with a collection of statement owners. - method if you want statement tables to be used to store values for certain objects. - + method if you want statement tables to be used to store values for certain objects. + ]]> - is . + is . @@ -252,11 +252,11 @@ The statement owner to add to the table. Populates the statement table with a statement owner. - method if you want statement tables to be used to store values for certain objects. - + method if you want statement tables to be used to store values for certain objects. + ]]> @@ -304,11 +304,11 @@ For a description of this member, see the method. An that can be used to iterate through the collection. - instance is cast to an interface. - + instance is cast to an interface. + ]]> diff --git a/xml/System.ComponentModel.Design.Serialization/TypeCodeDomSerializer.xml b/xml/System.ComponentModel.Design.Serialization/TypeCodeDomSerializer.xml index 31ff1d1b28c..88181d3e4dd 100644 --- a/xml/System.ComponentModel.Design.Serialization/TypeCodeDomSerializer.xml +++ b/xml/System.ComponentModel.Design.Serialization/TypeCodeDomSerializer.xml @@ -44,11 +44,11 @@ Serializes an object to a new type. - class performs the same tasks as a , but serializing an object through this class defines a new type. - + class performs the same tasks as a , but serializing an object through this class defines a new type. + ]]> @@ -125,28 +125,28 @@ Deserializes the given type declaration. The root object. - method deserializes a previously serialized code type declaration. The following table shows the tasks default implementation performs. - -|Task|Description| -|----------|-----------------| -|Case Sensitivity Checks|The implementation searches for a service to decide if it should treat members as case sensitive or case insensitive.| -|Statement Sorting|All member variables and local variables from init methods are stored in a table. Then each statement in an init method is added to a statement collection grouped according to its left-hand side, so all statements assigning or operating on a particular variable are grouped under that variable. Variables that have no statements are discarded.| -|Deserialization|The statement collections for each variable are deserialized according to the variable.| - - The following table shows the services the method requires. - -|Service|Description| -|-------------|-----------------| -||While not strictly necessary, the service, if available, is used to determine if the serialization should be case sensitive or case insensitive.| -||If an object does not exist in the name table during deserialization, a query for is made. If this query succeeds, the container is checked for the object. The container is also used as a stand-in for any container argument needed by components.| - + method deserializes a previously serialized code type declaration. The following table shows the tasks default implementation performs. + +|Task|Description| +|----------|-----------------| +|Case Sensitivity Checks|The implementation searches for a service to decide if it should treat members as case sensitive or case insensitive.| +|Statement Sorting|All member variables and local variables from init methods are stored in a table. Then each statement in an init method is added to a statement collection grouped according to its left-hand side, so all statements assigning or operating on a particular variable are grouped under that variable. Variables that have no statements are discarded.| +|Deserialization|The statement collections for each variable are deserialized according to the variable.| + + The following table shows the services the method requires. + +|Service|Description| +|-------------|-----------------| +||While not strictly necessary, the service, if available, is used to determine if the serialization should be case sensitive or case insensitive.| +||If an object does not exist in the name table during deserialization, a query for is made. If this query succeeds, the container is checked for the object. The container is also used as a stand-in for any container argument needed by components.| + ]]> - or is . + or is . @@ -191,15 +191,15 @@ Returns the method where statements used to serialize a member are stored. The method used to emit all of the initialization code for the given member. - method returns the method to emit all of the initialization code for the given member. The default implementation returns an empty constructor. If the same method is to be returned for multiple values, the same instance of the method should be returned. You can use the dictionary to remember methods you have created. The `typeDecl` parameter can also be used to add infrastructure methods. For example, if you want to emit a separate method for each object, you need a single method that calls all of these methods in turn. This method can be added to the code type declaration as needed. - + method returns the method to emit all of the initialization code for the given member. The default implementation returns an empty constructor. If the same method is to be returned for multiple values, the same instance of the method should be returned. You can use the dictionary to remember methods you have created. The `typeDecl` parameter can also be used to add infrastructure methods. For example, if you want to emit a separate method for each object, you need a single method that calls all of these methods in turn. This method can be added to the code type declaration as needed. + ]]> - , , or is . + , , or is . @@ -242,15 +242,15 @@ Returns an array of methods to be interpreted during deserialization. A array of methods to be interpreted during deserialization. - - or is . + or is . @@ -303,31 +303,31 @@ Serializes the object root by creating a new type declaration that defines root. A that defines the root object. - method serializes the given root object and optional collection of members to create a new type definition. If the `members` collection contains values, these values are serialized. Values themselves may serialize as either member variables or local variables. This determination is done by searching for an extender property on the object called `GenerateMember`. If `true`, a member is generated. Otherwise, a local variable is generated. For convenience, the `members` collection can contain the root object. In this case, the root object is not also added as a member or local variable. - - The name of the returned type is taken from the root object's name, if it was a named object. If not, a name is fabricated from the simple type name of the root class. - - The following table shows the tasks performed by the default implementation of the method. - -|Task|Description| -|----------|-----------------| -|Context Seeding|The serialization context is initialized with data including the and | -|Member Serialization|Next, walks all of the members and calls . Because serialization is done opportunistically in , this ensures that serialization is not done twice.| -|Root Serialization|Next, the root object is serialized and its statements are added to the statement collection.| -|Statement Integration|After all objects are serialized, the method orders the statements and adds them to a method returned from . Finally, a constructor is fabricated that calls all of the methods returned from .| - -- - - The following table shows the objects the method places on the context stack. - -|Instance|Description| -|--------------|-----------------| -||This serializer. Deriving classes may find it useful to add public properties to this class.| -||The type being created. Most objects do not need direct access to this.| - + method serializes the given root object and optional collection of members to create a new type definition. If the `members` collection contains values, these values are serialized. Values themselves may serialize as either member variables or local variables. This determination is done by searching for an extender property on the object called `GenerateMember`. If `true`, a member is generated. Otherwise, a local variable is generated. For convenience, the `members` collection can contain the root object. In this case, the root object is not also added as a member or local variable. + + The name of the returned type is taken from the root object's name, if it was a named object. If not, a name is fabricated from the simple type name of the root class. + + The following table shows the tasks performed by the default implementation of the method. + +|Task|Description| +|----------|-----------------| +|Context Seeding|The serialization context is initialized with data including the and | +|Member Serialization|Next, walks all of the members and calls . Because serialization is done opportunistically in , this ensures that serialization is not done twice.| +|Root Serialization|Next, the root object is serialized and its statements are added to the statement collection.| +|Statement Integration|After all objects are serialized, the method orders the statements and adds them to a method returned from . Finally, a constructor is fabricated that calls all of the methods returned from .| + +- + + The following table shows the objects the method places on the context stack. + +|Instance|Description| +|--------------|-----------------| +||This serializer. Deriving classes may find it useful to add public properties to this class.| +||The type being created. Most objects do not need direct access to this.| + ]]> diff --git a/xml/System.ComponentModel.Design/DesignSurface.xml b/xml/System.ComponentModel.Design/DesignSurface.xml index e4d9c9abcdd..19190e0d0ed 100644 --- a/xml/System.ComponentModel.Design/DesignSurface.xml +++ b/xml/System.ComponentModel.Design/DesignSurface.xml @@ -235,7 +235,7 @@ ]]> - is . + is . The attached to the has been disposed. @@ -286,7 +286,7 @@ ]]> - is . + is . The attached to the has been disposed. diff --git a/xml/System.ComponentModel.Design/DesignerActionService.xml b/xml/System.ComponentModel.Design/DesignerActionService.xml index 90a3f829191..4c530710467 100644 --- a/xml/System.ComponentModel.Design/DesignerActionService.xml +++ b/xml/System.ComponentModel.Design/DesignerActionService.xml @@ -593,7 +593,7 @@ ]]> - is . + is . @@ -646,7 +646,7 @@ ]]> - is . + is . diff --git a/xml/System.ComponentModel.Design/EventBindingService.xml b/xml/System.ComponentModel.Design/EventBindingService.xml index b9aca974293..34bb972f883 100644 --- a/xml/System.ComponentModel.Design/EventBindingService.xml +++ b/xml/System.ComponentModel.Design/EventBindingService.xml @@ -47,11 +47,11 @@ A default implementation of the interface. - provides a way to link an event handler with a component event from designer code. - + provides a way to link an event handler with a component event from designer code. + ]]> @@ -128,11 +128,11 @@ Creates a unique method name. The unique method name. - method must be compatible with the script language being used and it must not conflict with any other name in your code. - + method must be compatible with the script language being used and it must not conflict with any other name in your code. + ]]> @@ -178,11 +178,11 @@ The name of the method to be freed. Provides a notification that a particular method is no longer being used by an event handler. - and , an implementation can infer when a method is no longer needed. - + and , an implementation can infer when a method is no longer needed. + ]]> @@ -223,11 +223,11 @@ Returns a collection of names of compatible methods. A collection of strings that are names of compatible methods. - should return an empty collection if no names are compatible. - + should return an empty collection if no names are compatible. + ]]> @@ -313,11 +313,11 @@ if it is possible to display the code; otherwise, . - method does not display any particular code; generally it displays the last code the user typed. - + method does not display any particular code; generally it displays the last code the user typed. + ]]> @@ -356,11 +356,11 @@ if it is possible to display the code; otherwise, . - @@ -403,11 +403,11 @@ if it is possible to display the code; otherwise, . - method displays the body of the user code with the given method name. - + method displays the body of the user code with the given method name. + ]]> @@ -493,11 +493,11 @@ Gets a collection of event-handler methods that have a method signature compatible with the specified event. A collection of strings that are names of compatible methods. - should return an empty collection if no names are compatible. - + should return an empty collection if no names are compatible. + ]]> @@ -769,7 +769,7 @@ This member is an explicit interface member implementation. It can be used only if the code is displayed; otherwise, . To be added. - is . + is . @@ -808,11 +808,11 @@ This member is an explicit interface member implementation. It can be used only The name of the method. Provides a notification that a particular method is being used by an event handler. - and , an implementation can infer when a method is no longer needed. - + and , an implementation can infer when a method is no longer needed. + ]]> @@ -852,11 +852,11 @@ This member is an explicit interface member implementation. It can be used only The method name to validate. Validates that the provided method name is valid for the language or script being used. - diff --git a/xml/System.ComponentModel/PropertyDescriptorCollection.xml b/xml/System.ComponentModel/PropertyDescriptorCollection.xml index 28f4eeeafac..21be1c8b2e4 100644 --- a/xml/System.ComponentModel/PropertyDescriptorCollection.xml +++ b/xml/System.ComponentModel/PropertyDescriptorCollection.xml @@ -65,30 +65,30 @@ Represents a collection of objects. - is read-only; it does not implement methods that add or remove properties. You must inherit from this class to implement these methods. - - Using the properties available in the class, you can query the collection about its contents. Use the property to determine the number of elements in the collection. Use the property to get a specific property by index number or by name. - - In addition to properties, you can use the method to get a description of the property with the specified name from the collection. - - - -## Examples - The following code example creates a new using the properties on `button1`. It requires that `button1` has been instantiated on a form. - + is read-only; it does not implement methods that add or remove properties. You must inherit from this class to implement these methods. + + Using the properties available in the class, you can query the collection about its contents. Use the property to determine the number of elements in the collection. Use the property to get a specific property by index number or by name. + + In addition to properties, you can use the method to get a description of the property with the specified name from the collection. + + + +## Examples + The following code example creates a new using the properties on `button1`. It requires that `button1` has been instantiated on a form. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Winforms/Classic PropertyDescriptorCollection Example/CPP/source.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.ComponentModel/PropertyDescriptorCollection/Overview/source.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/Classic PropertyDescriptorCollection Example/VB/source.vb" id="Snippet1"::: - - The next example prints all the properties on a button in a text box. It requires that `button1` and `textBox1` have been instantiated on a form. - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/Classic PropertyDescriptorCollection Example/VB/source.vb" id="Snippet1"::: + + The next example prints all the properties on a button in a text box. It requires that `button1` and `textBox1` have been instantiated on a form. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Winforms/Classic PropertyDescriptorCollection Example/CPP/source.cpp" id="Snippet2"::: :::code language="csharp" source="~/snippets/csharp/System.ComponentModel/PropertyDescriptorCollection/Overview/source.cs" id="Snippet2"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/Classic PropertyDescriptorCollection Example/VB/source.vb" id="Snippet2"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/Classic PropertyDescriptorCollection Example/VB/source.vb" id="Snippet2"::: + ]]> @@ -461,20 +461,20 @@ Gets the number of property descriptors in the collection. The number of property descriptors in the collection. - property to set the limits of a loop that iterates through a collection of objects. Because the collection is zero-based, be sure to use `Count - 1` as the upper boundary of the loop. - - - -## Examples - The following code example uses the property to print the number of properties on `button1`. It requires that `button1` and `textBox1` have been instantiated on a form. - + property to set the limits of a loop that iterates through a collection of objects. Because the collection is zero-based, be sure to use `Count - 1` as the upper boundary of the loop. + + + +## Examples + The following code example uses the property to print the number of properties on `button1`. It requires that `button1` and `textBox1` have been instantiated on a form. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Winforms/Classic PropertyDescriptorCollection.Count Example/CPP/source.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.ComponentModel/PropertyDescriptorCollection/Count/source.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/Classic PropertyDescriptorCollection.Count Example/VB/source.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/Classic PropertyDescriptorCollection.Count Example/VB/source.vb" id="Snippet1"::: + ]]> @@ -570,15 +570,15 @@ Returns the with the specified name, using a Boolean to indicate whether to ignore case. A with the specified name, or if the property does not exist. - . It prints the type of component for this in a text box. It requires that `button1` and `textBox1` have been instantiated on a form. - + . It prints the type of component for this in a text box. It requires that `button1` and `textBox1` have been instantiated on a form. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Winforms/Classic PropertyDescriptorCollection.Find Example/CPP/source.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.ComponentModel/PropertyDescriptorCollection/Find/source.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/Classic PropertyDescriptorCollection.Find Example/VB/source.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/Classic PropertyDescriptorCollection.Find Example/VB/source.vb" id="Snippet1"::: + ]]> @@ -629,15 +629,15 @@ Returns an enumerator for this class. An enumerator of type . - @@ -848,15 +848,15 @@ An array of strings describing the order in which to sort the objects in this collection. Sorts the members of this collection. The specified order is applied first, followed by the default sort for this collection, which is usually alphabetical. - method. If the contains four objects with the names `A`, `B`, `C`, and `D`, the properties of `myNewColl` would be sorted in the order `D`, `B`, `A`, and `C`. - + method. If the contains four objects with the names `A`, `B`, `C`, and `D`, the properties of `myNewColl` would be sorted in the order `D`, `B`, `A`, and `C`. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Winforms/Classic EventDescriptorCollection.InternalSort Example/CPP/source.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.ComponentModel/EventDescriptorCollection/InternalSort/source.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/Classic EventDescriptorCollection.InternalSort Example/VB/source.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/Classic EventDescriptorCollection.InternalSort Example/VB/source.vb" id="Snippet1"::: + ]]> @@ -916,20 +916,20 @@ Gets or sets the at the specified index number. The with the specified index number. - to access that . For example, to get the third , you need to specify `myColl[2]`. - - - -## Examples - The following code example uses the property to print the name of the specified by the index number in a text box. Because the index number is zero-based, this example prints the name of the second . It requires that `button1` has been instantiated on a form. - + to access that . For example, to get the third , you need to specify `myColl[2]`. + + + +## Examples + The following code example uses the property to print the name of the specified by the index number in a text box. Because the index number is zero-based, this example prints the name of the second . It requires that `button1` has been instantiated on a form. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Winforms/Classic PropertyDescriptorCollection.this Example/CPP/source.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.ComponentModel/PropertyDescriptorCollection/Item/source.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/Classic PropertyDescriptorCollection.this Example/VB/source.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/Classic PropertyDescriptorCollection.this Example/VB/source.vb" id="Snippet1"::: + ]]> The parameter is not a valid index for . @@ -992,20 +992,20 @@ Gets or sets the with the specified name. The with the specified name, or if the property does not exist. - property is case-sensitive when searching for names. That is, the names "Pname" and "pname" are considered to be two different properties. - - - -## Examples - The following code example uses the property to print the type of component for the specified by the index. It requires that `button1` and `textBox1` have been instantiated on a form. - + property is case-sensitive when searching for names. That is, the names "Pname" and "pname" are considered to be two different properties. + + + +## Examples + The following code example uses the property to print the type of component for the specified by the index. It requires that `button1` and `textBox1` have been instantiated on a form. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Winforms/Classic PropertyDescriptorCollection.this1 Example/CPP/source.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.ComponentModel/PropertyDescriptorCollection/Item/source1.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/Classic PropertyDescriptorCollection.this1 Example/VB/source.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/Classic PropertyDescriptorCollection.this1 Example/VB/source.vb" id="Snippet1"::: + ]]> @@ -1271,15 +1271,15 @@ Sorts the members of this collection. The specified order is applied first, followed by the default sort for this collection, which is usually alphabetical. A new that contains the sorted objects. - method. If the contains four objects with the names `A`, `B`, `C`, and `D`, the properties of `myNewColl` would be sorted in the order `D`, `B`, `A`, and `C`. - + method. If the contains four objects with the names `A`, `B`, `C`, and `D`, the properties of `myNewColl` would be sorted in the order `D`, `B`, `A`, and `C`. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Winforms/Classic EventDescriptorCollection.Sort Example/CPP/source.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.ComponentModel/EventDescriptorCollection/Sort/source.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/Classic EventDescriptorCollection.Sort Example/VB/source.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/Classic EventDescriptorCollection.Sort Example/VB/source.vb" id="Snippet1"::: + ]]> @@ -1346,15 +1346,15 @@ Sorts the members of this collection. The specified order is applied first, followed by the sort using the specified . A new that contains the sorted objects. - method. If the contains four objects with the names `A`, `B`, `C`, and `D`, the properties of `myNewColl` would be sorted in the order `D`, `B`, `A`, and `C`. - + method. If the contains four objects with the names `A`, `B`, `C`, and `D`, the properties of `myNewColl` would be sorted in the order `D`, `B`, `A`, and `C`. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Winforms/Classic EventDescriptorCollection.Sort Example/CPP/source.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.ComponentModel/EventDescriptorCollection/Sort/source.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/Classic EventDescriptorCollection.Sort Example/VB/source.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/Classic EventDescriptorCollection.Sort Example/VB/source.vb" id="Snippet1"::: + ]]> @@ -1717,15 +1717,15 @@ This member is an explicit interface member implementation. It can be used only Returns an enumerator for this class. An enumerator of type . - @@ -2525,13 +2525,12 @@ This member is an explicit interface member implementation. It can be used only The element at the specified index. To be added. The collection is read-only. - - is not a . + The value being set is not a . - is less than 0. - - -or- - + is less than 0. + + -or- + is equal to or greater than . diff --git a/xml/System.ComponentModel/PropertyTabAttribute.xml b/xml/System.ComponentModel/PropertyTabAttribute.xml index 732237e4232..618a646cef3 100644 --- a/xml/System.ComponentModel/PropertyTabAttribute.xml +++ b/xml/System.ComponentModel/PropertyTabAttribute.xml @@ -52,19 +52,19 @@ Identifies the property tab or tabs to display for the specified class or classes. - lets you add a new property page to a control. The can add additional property tabs to expose property information other than a component's default set of properties. - - - -## Examples - The following code example demonstrates how to use the to specify a property tab. The code example defines a component that exposes the properties of another selected component by type. - + lets you add a new property page to a control. The can add additional property tabs to expose property information other than a component's default set of properties. + + + +## Examples + The following code example demonstrates how to use the to specify a property tab. The code example defines a component that exposes the properties of another selected component by type. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Winforms/PropertyTabExample/CPP/class1.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.ComponentModel/PropertyTabAttribute/Overview/class1.cs" id="Snippet1"::: - + ]]> @@ -113,11 +113,11 @@ Initializes a new instance of the class. - . This constructor can be used to derive from this attribute and specify multiple tab types by calling . - + . This constructor can be used to derive from this attribute and specify multiple tab types by calling . + ]]> @@ -313,14 +313,14 @@ A that indicates the scope of this tab. If the scope is , it is shown only for components with the corresponding . If it is , it is shown for all components on the document. Initializes a new instance of the class using the specified type of tab and tab scope. - to specify a property tab. - + to specify a property tab. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Winforms/PropertyTabExample/CPP/class1.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.ComponentModel/PropertyTabAttribute/Overview/class1.cs" id="Snippet1"::: - + ]]> @@ -557,21 +557,21 @@ The scope of each tab. If the scope is , it is shown only for components with the corresponding . If it is , it is shown for all components on the document. Initializes the attribute using the specified names of tab classes and array of tab scopes. - provides a utility function that can be used to set the types of tab classes that this specifies. - + provides a utility function that can be used to set the types of tab classes that this specifies. + ]]> - One or more of the values in is not or . - - -or- - - The length of the and arrays do not match. - - -or- - + One or more of the values in is not or . + + -or- + + The lengths of the and arrays do not match. + + -or- + or is . @@ -632,22 +632,22 @@ The scope of each tab. If the scope is , it is shown only for components with the corresponding . If it is , it is shown for all components on the document. Initializes the attribute using the specified names of tab classes and array of tab scopes. - provides a utility function that can be used to set the types of tab classes that this specifies. - + provides a utility function that can be used to set the types of tab classes that this specifies. + ]]> - One or more of the values in is not or . - - -or- - - The length of the and arrays do not match. - - -or- - - or is . + One or more of the values in is not or . + + -or- + + The lengths of the and arrays do not match. + + -or- + + or is . @@ -688,11 +688,11 @@ Gets the types of tabs that this attribute uses. An array of types indicating the types of tabs that this attribute uses. - . - + . + ]]> The types specified by the property could not be found. diff --git a/xml/System.ComponentModel/TimeSpanConverter.xml b/xml/System.ComponentModel/TimeSpanConverter.xml index 18544e96243..91d32fdefb2 100644 --- a/xml/System.ComponentModel/TimeSpanConverter.xml +++ b/xml/System.ComponentModel/TimeSpanConverter.xml @@ -50,25 +50,25 @@ Provides a type converter to convert objects to and from other representations. - object to and from a string. - - For more information about type converters, see the base class and [How to: Implement a Type Converter](https://learn.microsoft.com/previous-versions/visualstudio/visual-studio-2013/ayybcxe5(v=vs.120)). - + object to and from a string. + + For more information about type converters, see the base class and [How to: Implement a Type Converter](https://learn.microsoft.com/previous-versions/visualstudio/visual-studio-2013/ayybcxe5(v=vs.120)). + > [!NOTE] -> You should never create an instance of a . Instead, call the method of the class. For more information, see the examples in the base class. - - - -## Examples - The following code example converts a variable of type to a string, and vice versa. Both variables are represented in format. - +> You should never create an instance of a . Instead, call the method of the class. For more information, see the examples in the base class. + + + +## Examples + The following code example converts a variable of type to a string, and vice versa. Both variables are represented in format. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Winforms/Converters/CPP/converters.cpp" id="Snippet21"::: :::code language="csharp" source="~/snippets/csharp/System.ComponentModel/BooleanConverter/Overview/converters.cs" id="Snippet21"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/Converters/VB/converters.vb" id="Snippet21"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/Converters/VB/converters.vb" id="Snippet21"::: + ]]> @@ -172,13 +172,13 @@ if this converter can perform the conversion; otherwise, . - object to and from a string. - - The `context` parameter can be used to extract additional information about the environment this converter is being invoked from. This can be `null`, so always check. Also, properties on the context object can return `null`. - + object to and from a string. + + The `context` parameter can be used to extract additional information about the environment this converter is being invoked from. This can be `null`, so always check. Also, properties on the context object can return `null`. + ]]> @@ -239,17 +239,17 @@ if this converter can perform the conversion; otherwise, . - is . - is not a valid value for the target type. + is not a valid value for the target type. Override this method to provide your own conversion requirements. @@ -312,13 +312,13 @@ Converts the given object to a . An that represents the converted value. - object to and from a string. - - The `context` parameter can be used to extract additional information about the environment this converter is being invoked from. This can be `null`, so always check. Also, properties on the context object can return `null`. - + object to and from a string. + + The `context` parameter can be used to extract additional information about the environment this converter is being invoked from. This can be `null`, so always check. Also, properties on the context object can return `null`. + ]]> The conversion cannot be performed. @@ -385,15 +385,15 @@ Converts the given object to another type. The converted object. - on the object if the object is valid and if the destination type is string. If this method cannot convert to the destination type, it will throw a . - - The `context` parameter can be used to extract additional information about the environment this converter is being invoked from. This can be `null`, so always check. Also, properties on the context object can return `null`. - + on the object if the object is valid and if the destination type is string. If this method cannot convert to the destination type, it will throw a . + + The `context` parameter can be used to extract additional information about the environment this converter is being invoked from. This can be `null`, so always check. Also, properties on the context object can return `null`. + ]]> diff --git a/xml/System.Composition/CompositionContext.xml b/xml/System.Composition/CompositionContext.xml index f958bf45dcd..17534df6732 100644 --- a/xml/System.Composition/CompositionContext.xml +++ b/xml/System.Composition/CompositionContext.xml @@ -43,10 +43,10 @@ Initializes a new instance of the class. - class. ]]> @@ -378,7 +378,6 @@ This constructor is protected; it can only be called by classes derived from the if an export was found; otherwise, . - No export was found for . @@ -411,7 +410,7 @@ This constructor is protected; it can only be called by classes derived from the if an export was found; otherwise, . - No export was found for . + No export was found for . @@ -444,7 +443,6 @@ This constructor is protected; it can only be called by classes derived from the if an export was found; otherwise, . - No export was found for . @@ -479,7 +477,7 @@ This constructor is protected; it can only be called by classes derived from the if an export was found; otherwise, . - No export was found for . + No export was found for . diff --git a/xml/System.Configuration/ConfigurationElement.xml b/xml/System.Configuration/ConfigurationElement.xml index 1e91f052c80..a06e7b34f2f 100644 --- a/xml/System.Configuration/ConfigurationElement.xml +++ b/xml/System.Configuration/ConfigurationElement.xml @@ -860,7 +860,7 @@ ]]> - is read-only or locked. + is read-only or locked. diff --git a/xml/System.Configuration/ConfigurationPermission.xml b/xml/System.Configuration/ConfigurationPermission.xml index df4eed6b4d8..8de7bc881ea 100644 --- a/xml/System.Configuration/ConfigurationPermission.xml +++ b/xml/System.Configuration/ConfigurationPermission.xml @@ -42,14 +42,14 @@ Provides a permission structure that allows methods or classes to access configuration files. - class provides a permission structure that allows methods or classes to access configuration files. Also, provides ways to resolve multiple permissions values through such methods as and . - + The class provides a permission structure that allows methods or classes to access configuration files. Also, provides ways to resolve multiple permissions values through such methods as and . + ]]> @@ -165,7 +165,7 @@ The for the given attribute of the given is or is not the type name for . +The attribute of the given is or is not the type name for . -or- @@ -207,11 +207,11 @@ The attribute for the given object and a given object that implements the interface. The logical intersection between the and a given object that implements . - interface, an exception will be thrown if calling the method on the object referenced by the `target` parameter does not return . - + interface, an exception will be thrown if calling the method on the object referenced by the `target` parameter does not return . + ]]> @@ -253,13 +253,13 @@ The attribute for the given if the permission state is equal; otherwise, . - interface, an exception will be thrown if calling the method on the object referenced by the `target` parameter does not return . - - If the object referenced by the `target` parameter is `null`, the comparison is done between the permission state of the object and the value of the enumeration. - + interface, an exception will be thrown if calling the method on the object referenced by the `target` parameter does not return . + + If the object referenced by the `target` parameter is `null`, the comparison is done between the permission state of the object and the value of the enumeration. + ]]> diff --git a/xml/System.Configuration/RsaProtectedConfigurationProvider.xml b/xml/System.Configuration/RsaProtectedConfigurationProvider.xml index e2dc698ebc6..24179122271 100644 --- a/xml/System.Configuration/RsaProtectedConfigurationProvider.xml +++ b/xml/System.Configuration/RsaProtectedConfigurationProvider.xml @@ -337,14 +337,14 @@ The following example shows how to use the standard Exports an RSA key from the key container. To be added. - is a zero-length string, contains only white space, or contains one or more invalid characters as defined by . + is a zero-length string, contains only white space, or contains one or more invalid characters as defined by . - is . + is . The specified path, file name, or both exceed the system-defined maximum length. The specified path is invalid, such as being on an unmapped drive. An error occurred while opening the file. - specified a file that is read-only. + specified a file that is read-only. -or- @@ -352,14 +352,14 @@ The following example shows how to use the standard specified a directory. + specified a directory. -or- The caller does not have the required permission. - The file specified in was not found. + The file specified in was not found. - is in an invalid format. + is in an invalid format. The caller does not have the required permission. Walkthrough: Creating and Exporting an RSA Key Container @@ -401,14 +401,14 @@ The following example shows how to use the standard Imports an RSA key into the key container. To be added. - is a zero-length string, contains only white space, or contains one or more invalid characters as defined by . + is a zero-length string, contains only white space, or contains one or more invalid characters as defined by . - is . + is . The specified path, file name, or both exceed the system-defined maximum length. The specified path is invalid, such as being on an unmapped drive. An error occurred while opening the file. - specified a file that is write-only. + specified a file that is write-only. -or- @@ -416,14 +416,14 @@ The following example shows how to use the standard specified a directory. + specified a directory. -or- The caller does not have the required permission. - The file specified in was not found. + The file specified in was not found. - is in an invalid format. + is in an invalid format. Walkthrough: Creating and Exporting an RSA Key Container diff --git a/xml/System.Data.Common.CommandTrees.ExpressionBuilder/DbExpressionBuilder.xml b/xml/System.Data.Common.CommandTrees.ExpressionBuilder/DbExpressionBuilder.xml index 7bd6b67ea60..88aa677404a 100644 --- a/xml/System.Data.Common.CommandTrees.ExpressionBuilder/DbExpressionBuilder.xml +++ b/xml/System.Data.Common.CommandTrees.ExpressionBuilder/DbExpressionBuilder.xml @@ -125,7 +125,7 @@ The expression produced by is null. -or- -The expression produced by does not have a Boolean result type. +The expression produced by does not have a Boolean result type. @@ -263,7 +263,7 @@ The expression produced by is null. does not have a collection result type. -or- - + The expression produced by does not have a Boolean result type. @@ -479,7 +479,7 @@ The expression produced by does not have a Boolean A new DbCastExpression with the specified argument and target type. To be added. - or is null. + or is null. The specified cast is not valid. @@ -753,7 +753,7 @@ The result of contains a name or expression that is nu does not have a collection result type. -or- - + The result of contains a name or expression that is not valid in an expression binding. @@ -1119,7 +1119,7 @@ The expression produced by is null. or does not have a collection result type. -or- - + The expression produced by does not have a Boolean result type. @@ -1362,11 +1362,11 @@ The expression produced by does not have a Boo Creates a new that groups the elements of the input set according to the specified group keys and applies the given aggregates. A new DbGroupByExpression with the specified input set, grouping keys and aggregates. - @@ -1713,11 +1713,11 @@ The expression produced by does not have a Boo Creates a new that determines whether the given argument is of the specified type or a subtype. A new DbIsOfExpression with the specified instance and type and DbExpressionKind IsOf. - @@ -1751,11 +1751,11 @@ The expression produced by does not have a Boo Creates a new expression that determines whether the given argument is of the specified type, and only that type (not a subtype). A new DbIsOfExpression with the specified instance and type and DbExpressionKind IsOfOnly. - @@ -1797,7 +1797,7 @@ The expression produced by does not have a Boo , , or is null. -or- - + The expression produced by or is null. or does not have a collection result type. @@ -1842,23 +1842,23 @@ The expressions produced by and that projects the specified selector over the sets specified by the outer and inner expressions, joined on an equality condition between the specified outer and inner keys, using InnerJoin as the . A new DbProjectExpression with the specified selector as its projection, and a new DbJoinExpression as its input. The input DbJoinExpression is created with an of InnerJoin, that represents the inner join operation applied to the left and right input sets under a join condition that compares the outer and inner key values for equality. - , or must be an anonymous type with DbExpression-derived properties. The following are examples of supported types for `TSelector`: - -``` -outer.Join(inner, o => o.Property("ID"), i => i.Property("ID"), (o, i) => o.Property("Name")) -``` - - (`TSelector` is ). - -``` -outer.Join(inner, o => o.Property("ID"), i => i.Property("ID"), (o, i) => new { OName = o.Property("Name"), IName = i.Property("Name") }) -``` - - (`TSelector` is an anonymous type with DbExpression-derived properties). - + , or must be an anonymous type with DbExpression-derived properties. The following are examples of supported types for `TSelector`: + +``` +outer.Join(inner, o => o.Property("ID"), i => i.Property("ID"), (o, i) => o.Property("Name")) +``` + + (`TSelector` is ). + +``` +outer.Join(inner, o => o.Property("ID"), i => i.Property("ID"), (o, i) => new { OName = o.Property("Name"), IName = i.Property("Name") }) +``` + + (`TSelector` is an anonymous type with DbExpression-derived properties). + ]]> @@ -1879,7 +1879,7 @@ The result of is null after conversion to DbExpress The expressions produced by and is not comparable for equality. -or- - + The result of is not compatible with SelectMany. @@ -2139,9 +2139,9 @@ The expression produced by does not have a Boo A new DbLikeExpression with the specified input, pattern and a null escape. To be added. - or is null. + or is null. - or does not have a string result type. + or does not have a string result type. @@ -2334,11 +2334,11 @@ The expression produced by does not have a Boo Creates a new representing the navigation of a composition or association relationship. A new DbRelationshipNavigationExpression representing the navigation of the specified from and to relation ends of the specified relation type from the specified navigation source instance. - requires that navigation always occur from a reference, and so `navigateFrom` must always have a reference result type. - + requires that navigation always occur from a reference, and so `navigateFrom` must always have a reference result type. + ]]> @@ -2376,11 +2376,11 @@ The expression produced by does not have a Boo Creates a new representing the navigation of a composition or association relationship. A new DbRelationshipNavigationExpression representing the navigation of the specified from and to relation ends of the specified relation type from the specified navigation source instance. - requires that navigation always occur from a reference, and so `navigateFrom` must always have a reference result type. - + requires that navigation always occur from a reference, and so `navigateFrom` must always have a reference result type. + ]]> @@ -2451,11 +2451,11 @@ The expression produced by does not have a Boo Creates a new . If the type argument is a collection type, the arguments specify the elements of the collection. Otherwise the arguments are used as property or column values in the new instance. A new DbNewInstanceExpression with the specified type and arguments. - @@ -2496,11 +2496,11 @@ The expression produced by does not have a Boo Creates a new . If the type argument is a collection type, the arguments specify the elements of the collection. Otherwise the arguments are used as property or column values in the new instance. A new DbNewInstanceExpression with the specified type and arguments. - @@ -2604,7 +2604,7 @@ The expression produced by does not have a Boo The type metadata for the collection to create. Creates a new that constructs an empty collection of the specified collection type. - A new DbNewInstanceExpression with the specified collection type and an empty list. + A new DbNewInstanceExpression with the specified collection type and an empty arguments list. To be added. is null. @@ -2752,11 +2752,11 @@ The expression produced by does not have a Boo Creates a new that produces a set consisting of the elements of the given input set that are of the specified type. A new DbOfTypeExpression with the specified set argument and type, and an ExpressionKind of . - @@ -2790,11 +2790,11 @@ The expression produced by does not have a Boo Creates a new that produces a set consisting of the elements of the given input set that are of exactly the specified type. A new DbOfTypeExpression with the specified set argument and type, and an ExpressionKind of . - @@ -2913,7 +2913,7 @@ The expression produced by does not have an order-co , or is null. -or- - + The expression produced by is null. does not have a collection result type. @@ -3054,10 +3054,10 @@ The expression produced by does not have an order-co or is null. -or- - + The result of contains a name or expression that is null. - does not have a collection result type. + does not have a collection result type. -or- @@ -3339,11 +3339,11 @@ The result of contains a name or expression that is no Creates a new that encodes a reference to a specific Entity based on key values. A new DbRefExpression that references the element with the specified key values in the given Entity set. - @@ -3379,11 +3379,11 @@ The result of contains a name or expression that is no Creates a new that encodes a reference to a specific Entity based on key values. A new DbRefExpression that references the element with the specified key values in the given Entity set. - @@ -3448,23 +3448,23 @@ The result of contains a name or expression that is no Creates a new that selects the specified expression over the given input set. A new DbProjectExpression that represents the select operation. - , or must be an anonymous type with DbExpression-derived properties. The following are examples of supported types for `TProjection`: - -``` -source.Select(x => x.Property("Name")) -``` - - `TProjection` is ). - -``` -source.Select(x => new { Name = x.Property("Name") }) -``` - - (`TProjection` is an anonymous type with a DbExpression-derived property). - + , or must be an anonymous type with DbExpression-derived properties. The following are examples of supported types for `TProjection`: + +``` +source.Select(x => x.Property("Name")) +``` + + `TProjection` is ). + +``` +source.Select(x => new { Name = x.Property("Name") }) +``` + + (`TProjection` is an anonymous type with a DbExpression-derived property). + ]]> @@ -3545,23 +3545,23 @@ The expression produced by does not have a collection Creates a new that evaluates the given expression once for each element of a given input set, producing a collection of rows with corresponding input and apply columns. Rows for which evaluates to an empty set are not included. A is then created that selects the specified over each row, producing the overall collection of results. An new DbProjectExpression that selects the result of the given selector from a new DbApplyExpression with the specified input and apply bindings and an of CrossApply. - , or must be an anonymous type with DbExpression-derived properties. The following are examples of supported types for `TSelector`: - -``` -source.SelectMany(x => x.Property("RelatedCollection"), (source, apply) => apply.Property("Name")) -``` - - (`TSelector` is ). - -``` -source.SelectMany(x => x.Property("RelatedCollection"), (source, apply) => new { SourceName = source.Property("Name"), RelatedName = apply.Property("Name") }) -``` - - (`TSelector` is an anonymous type with DbExpression-derived properties). - + , or must be an anonymous type with DbExpression-derived properties. The following are examples of supported types for `TSelector`: + +``` +source.SelectMany(x => x.Property("RelatedCollection"), (source, apply) => apply.Property("Name")) +``` + + (`TSelector` is ). + +``` +source.SelectMany(x => x.Property("RelatedCollection"), (source, apply) => new { SourceName = source.Property("Name"), RelatedName = apply.Property("Name") }) +``` + + (`TSelector` is an anonymous type with DbExpression-derived properties). + ]]> @@ -3578,7 +3578,7 @@ The result of is null on conversion to DbExpression does not have a collection result type. -or- - + The expression produced by does not have a collection type. does not have a collection type. @@ -3796,7 +3796,7 @@ The expression produced by is null. , or is null. -or- - + The expression produced by is null. does not have a collection result type. @@ -3852,7 +3852,7 @@ The expression produced by is null. does not have a collection result type. -or- - + The expression produced by does not have an order-comparable result type. @@ -3893,7 +3893,7 @@ The expression produced by is null. does not have a collection result type. -or- - + The expression produced by does not have an order-comparable string result type. is empty or contains only space characters. @@ -4066,11 +4066,11 @@ The expression produced by does not have an order-co Creates a new . A new DbTreatExpression with the specified argument and type. - @@ -4244,7 +4244,7 @@ The expression produced by does not have an order-co or is null. -or- - + The expression produced by is null. The expression produced by does not have a Boolean result type. diff --git a/xml/System.Data.EntityClient/EntityDataReader.xml b/xml/System.Data.EntityClient/EntityDataReader.xml index c677478369e..84c75bf038f 100644 --- a/xml/System.Data.EntityClient/EntityDataReader.xml +++ b/xml/System.Data.EntityClient/EntityDataReader.xml @@ -302,7 +302,7 @@ The buffer into which to copy the data. The index with the buffer to which the data will be copied. The maximum number of characters to read. - Reads a stream of bytes from the specified column, starting at location indicated by , into the buffer, starting at the location indicated by . + Reads a stream of bytes from the specified column, starting at location indicated by , into the buffer, starting at the location indicated by . The actual number of bytes read. To be added. @@ -368,7 +368,7 @@ The buffer into which to copy the data. The index with the buffer to which the data will be copied. The maximum number of characters to read. - Reads a stream of characters from the specified column, starting at location indicated by , into the buffer, starting at the location indicated by . + Reads a stream of characters from the specified column, starting at location indicated by , into the buffer, starting at the location indicated by . The actual number of characters read. To be added. diff --git a/xml/System.Data.Objects/ObjectContext.xml b/xml/System.Data.Objects/ObjectContext.xml index 02424ef05fc..e4669637798 100644 --- a/xml/System.Data.Objects/ObjectContext.xml +++ b/xml/System.Data.Objects/ObjectContext.xml @@ -338,7 +338,7 @@ ]]> - or is . + or is . The from does not match the of the object's . -or- @@ -399,7 +399,7 @@ ]]> - or is . + or is . The from does not match the of the object's . -or- @@ -1395,16 +1395,16 @@ This example constructs an with a specific ProductI The number of rows affected. To be added. - is null or empty + is null or empty. -or- - is not found. - The entity reader does not support this . + is not found. + The entity reader does not support this . -or- - There is a type mismatch on the reader and the . + There is a type mismatch on the reader and the function. @@ -1471,16 +1471,16 @@ This example constructs an with a specific ProductI ]]> - is null or empty + is null or empty -or- - is not found. - The entity reader does not support this . + is not found. + The entity reader does not support this function. -or- - There is a type mismatch on the reader and the . + There is a type mismatch on the reader and the function. Working with Objects (Entity Framework) @@ -1532,16 +1532,16 @@ This example constructs an with a specific ProductI ]]> - is null or empty + is null or empty -or- - is not found. - The entity reader does not support this . + is not found. + The entity reader does not support this function. -or- - There is a type mismatch on the reader and the . + There is a type mismatch on the reader and the function. Working with Objects (Entity Framework) @@ -2288,16 +2288,9 @@ This example gets the from the - - is . is not valid. - - is empty. - - -or- - - An object is not attached to the context. + An object is not attached to the context. Working with Objects (Entity Framework) diff --git a/xml/System.Data.Objects/ObjectQuery`1.xml b/xml/System.Data.Objects/ObjectQuery`1.xml index 363cddf2431..064e169807a 100644 --- a/xml/System.Data.Objects/ObjectQuery`1.xml +++ b/xml/System.Data.Objects/ObjectQuery`1.xml @@ -349,7 +349,7 @@ This example creates a new object tha ]]> - The parameter is or an empty string. + The parameter is or an empty string. -or- @@ -588,7 +588,8 @@ The method can only be applied ]]> The or parameter is . - The is an empty string. + + is an empty string. Querying Data as Objects (Entity Framework) @@ -631,7 +632,7 @@ The method can only be applied applies the projection specified by the `projection` parameter. The returned by the method is always a row type of . Use the method to return values that are simple types, entity types, or complex types. For more information, see [LINQ to Entities](/dotnet/framework/data/adonet/ef/language-reference/linq-to-entities). When a navigation property is included in the projection, the query results include a collection of nested objects. - + ## Examples This example creates a new whose results are data records that contain the `ProductID` fields of the results of this query. diff --git a/xml/System.Data.Odbc/OdbcErrorCollection.xml b/xml/System.Data.Odbc/OdbcErrorCollection.xml index cbff7ef3af1..d1c47a98c38 100644 --- a/xml/System.Data.Odbc/OdbcErrorCollection.xml +++ b/xml/System.Data.Odbc/OdbcErrorCollection.xml @@ -44,19 +44,19 @@ Collects all errors generated by the . This class cannot be inherited. - to collect instances of the class. always contains at least one instance of the class. - - - -## Examples - The following example displays each within the . - + to collect instances of the class. always contains at least one instance of the class. + + + +## Examples + The following example displays each within the . + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_ADO.NET/Classic WebData OdbcError.Message/CS/source.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData OdbcError.Message/VB/source.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData OdbcError.Message/VB/source.vb" id="Snippet1"::: + ]]> Handling and throwing exceptions in .NET @@ -105,19 +105,19 @@ The starting index of . Copies the elements of the into an array, starting at the specified index within the array. - within the collection. - + within the collection. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_ADO.NET/Classic WebData OdbcError.Message/CS/source.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData OdbcError.Message/VB/source.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData OdbcError.Message/VB/source.vb" id="Snippet1"::: + ]]> - The sum of and the number of elements in the is greater than the length of the array. + The sum of and the number of elements in the is greater than the length of the array. The is . - The is not valid for . + The is not valid for . Handling and throwing exceptions in .NET @@ -150,14 +150,14 @@ A 32-bit integer that represents the index in the at which copying starts. Copies all the elements of the current to the specified starting at the specified destination index. - within the collection. - + within the collection. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_ADO.NET/Classic WebData OdbcError.Message/CS/source.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData OdbcError.Message/VB/source.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData OdbcError.Message/VB/source.vb" id="Snippet1"::: + ]]> Handling and throwing exceptions in .NET @@ -191,14 +191,14 @@ Gets the number of errors in the collection. The total number of errors in the collection. - within the . - + within the . + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_ADO.NET/Classic WebData OdbcError.Message/CS/source.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData OdbcError.Message/VB/source.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData OdbcError.Message/VB/source.vb" id="Snippet1"::: + ]]> Handling and throwing exceptions in .NET @@ -295,11 +295,11 @@ if access to the is synchronized (thread safe); otherwise, . - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -331,11 +331,11 @@ For a description of this member, see . An object that can be used to synchronize access to the . - instance is cast to an interface. - + instance is cast to an interface. + ]]> diff --git a/xml/System.Data.Odbc/OdbcParameter.xml b/xml/System.Data.Odbc/OdbcParameter.xml index 171c763c7ba..720acf3ef3e 100644 --- a/xml/System.Data.Odbc/OdbcParameter.xml +++ b/xml/System.Data.Odbc/OdbcParameter.xml @@ -57,39 +57,39 @@ Represents a parameter to an and optionally, its mapping to a . This class cannot be inherited. - through the within the . These parameters are used to select data from the data source and place the data in the . This example assumes that a and an have already been created by using the appropriate schema, commands, and connection. - + through the within the . These parameters are used to select data from the data source and place the data in the . This example assumes that a and an have already been created by using the appropriate schema, commands, and connection. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_ADO.NET/Classic WebData OdbcParameter/CS/source.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData OdbcParameter/VB/source.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData OdbcParameter/VB/source.vb" id="Snippet1"::: + ]]> Working with Commands @@ -126,19 +126,19 @@ OleDbDataReader reader = command.ExecuteReader(); Initializes a new instance of the class. - and sets some of its properties. - + and sets some of its properties. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_ADO.NET/Classic WebData OdbcParameter.OdbcParameter/CS/source.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData OdbcParameter.OdbcParameter/VB/source.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData OdbcParameter.OdbcParameter/VB/source.vb" id="Snippet1"::: + ]]> Working with Commands @@ -172,14 +172,14 @@ OleDbDataReader reader = command.ExecuteReader(); One of the values. Initializes a new instance of the class that uses the parameter name and data type. - and sets some of its properties. - + and sets some of its properties. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_ADO.NET/Classic WebData OdbcParameter.OdbcParameter1/CS/source.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData OdbcParameter.OdbcParameter1/VB/source.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData OdbcParameter.OdbcParameter1/VB/source.vb" id="Snippet1"::: + ]]> The value supplied in the parameter is an invalid back-end data type. @@ -214,17 +214,17 @@ OleDbDataReader reader = command.ExecuteReader(); An object. Initializes a new instance of the class that uses the parameter name and an object. - constructor to specify integer parameter values. Because this overload takes a `value` of type , you must convert the integral value to an type when the value is zero, as the following C# example demonstrates. - -``` -Parameter = new OdbcParameter("@pname", Convert.ToInt32(0)); -``` - - If you do not perform this conversion, the compiler assumes that you are trying to call the constructor overload. - + constructor to specify integer parameter values. Because this overload takes a `value` of type , you must convert the integral value to an type when the value is zero, as the following C# example demonstrates. + +``` +Parameter = new OdbcParameter("@pname", Convert.ToInt32(0)); +``` + + If you do not perform this conversion, the compiler assumes that you are trying to call the constructor overload. + ]]> Working with Commands @@ -260,14 +260,14 @@ Parameter = new OdbcParameter("@pname", Convert.ToInt32(0)); The length of the parameter. Initializes a new instance of the class that uses the parameter name, data type, and length. - and sets some of its properties. - + and sets some of its properties. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_ADO.NET/Classic WebData OdbcParameter.OdbcParameter2/CS/source.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData OdbcParameter.OdbcParameter2/VB/source.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData OdbcParameter.OdbcParameter2/VB/source.vb" id="Snippet1"::: + ]]> The value supplied in the parameter is an invalid back-end data type. @@ -306,14 +306,14 @@ Parameter = new OdbcParameter("@pname", Convert.ToInt32(0)); The name of the source column. Initializes a new instance of the class that uses the parameter name, data type, length, and source column name. - and sets some of its properties. - + and sets some of its properties. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_ADO.NET/Classic WebData OdbcParameter.OdbcParameter3/CS/source.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData OdbcParameter.OdbcParameter3/VB/source.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData OdbcParameter.OdbcParameter3/VB/source.vb" id="Snippet1"::: + ]]> The value supplied in the parameter is an invalid back-end data type. @@ -371,17 +371,17 @@ Parameter = new OdbcParameter("@pname", Convert.ToInt32(0)); An that is the value of the . Initializes a new instance of the class that uses the parameter name, data type, length, source column name, parameter direction, numeric precision, and other properties. - and displays the . - + and displays the . + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_ADO.NET/Classic WebData OdbcParameter.OdbcParameter4/CS/source.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData OdbcParameter.OdbcParameter4/VB/source.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData OdbcParameter.OdbcParameter4/VB/source.vb" id="Snippet1"::: + ]]> - The value supplied in the parameter is an invalid back-end data type. + The value supplied in the parameter is an invalid back-end data type. Working with Commands @@ -435,31 +435,31 @@ Parameter = new OdbcParameter("@pname", Convert.ToInt32(0)); An that is the value of the . Initializes a new instance of the class that uses the parameter name, data type, length, source column name, parameter direction, numeric precision, and other properties. - and displays the . - -```vb -Public Sub CreateOdbcParameter() - Dim parameter As New OdbcParameter("Description", OdbcType.VarChar, 11, ParameterDirection.Output, True, 0, 0, "Description", DataRowVersion.Current, False, "garden hose") - MessageBox.Show(parameter.ToString()) -End Sub -``` - -```csharp -public void CreateOdbcParameter() -{ - OdbcParameter parameter = new OdbcParameter("Description",OdbcType.VarChar, - 11,ParameterDirection.Output,true,0,0,"Description", - DataRowVersion.Current, false, "garden hose"); - MessageBox.Show(parameter.ToString()); -} -``` - + and displays the . + +```vb +Public Sub CreateOdbcParameter() + Dim parameter As New OdbcParameter("Description", OdbcType.VarChar, 11, ParameterDirection.Output, True, 0, 0, "Description", DataRowVersion.Current, False, "garden hose") + MessageBox.Show(parameter.ToString()) +End Sub +``` + +```csharp +public void CreateOdbcParameter() +{ + OdbcParameter parameter = new OdbcParameter("Description",OdbcType.VarChar, + 11,ParameterDirection.Output,true,0,0,"Description", + DataRowVersion.Current, false, "garden hose"); + MessageBox.Show(parameter.ToString()); +} +``` + ]]> - The value supplied in the parameter is an invalid back-end data type. + The value supplied in the parameter is an invalid back-end data type. Working with Commands @@ -508,24 +508,24 @@ public void CreateOdbcParameter() Gets or sets the of the parameter. One of the values. The default is . - and are linked. Therefore, setting the changes the to a supporting . - - For a list of the supported data types, see the appropriate member. For more information, see [DataAdapter Parameters](/dotnet/framework/data/adonet/dataadapter-parameters). - + and are linked. Therefore, setting the changes the to a supporting . + + For a list of the supported data types, see the appropriate member. For more information, see [DataAdapter Parameters](/dotnet/framework/data/adonet/dataadapter-parameters). + > [!NOTE] -> is not supported by the Microsoft .NET Framework Data Provider for ODBC. - - - -## Examples - The following example calls a **Stored Procedure** with three parameters using the ODBC managed provider. - +> is not supported by the Microsoft .NET Framework Data Provider for ODBC. + + + +## Examples + The following example calls a **Stored Procedure** with three parameters using the ODBC managed provider. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_ADO.NET/Classic WebData OdbcParameter.DbType/CS/source.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData OdbcParameter.DbType/VB/source.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData OdbcParameter.DbType/VB/source.vb" id="Snippet1"::: + ]]> The property was not set to a valid . @@ -573,41 +573,41 @@ public void CreateOdbcParameter() Gets or sets a value that indicates whether the parameter is input-only, output-only, bidirectional, or a stored procedure return value parameter. One of the values. The default is . - is `Output`, and execution of the associated does not return a value, the will contain a null value. Null values are handled using the class. - - `Output`, `InputOut`, and `ReturnValue` parameters returned by calling cannot be accessed until you call or `Dispose` on the . - - - -## Examples - The following example creates an and sets some of its properties. - -```vb -Public Sub CreateMyProc(connection As OdbcConnection) - - Dim command As OdbcCommand = connection.CreateCommand() - command.CommandText = "{ call MyProc(?,?,?) }" - command.Parameters.Add("", OdbcType.Int).Value = 1 - command.Parameters.Add("", OdbcType.Decimal).Value = 2 - command.Parameters.Add("", OdbcType.Decimal).Value = 3 - -End Sub -``` - -```csharp -public void CreateMyProc(OdbcConnection connection) -{ - OdbcCommand command = connection.CreateCommand(); - command.CommandText = "{ call MyProc(?,?,?) }"; - command.Parameters.Add("", OdbcType.Int).Value = 1; - command.Parameters.Add("", OdbcType.Decimal).Value = 2; - command.Parameters.Add("", OdbcType.Decimal).Value = 3; -} -``` - + is `Output`, and execution of the associated does not return a value, the will contain a null value. Null values are handled using the class. + + `Output`, `InputOut`, and `ReturnValue` parameters returned by calling cannot be accessed until you call or `Dispose` on the . + + + +## Examples + The following example creates an and sets some of its properties. + +```vb +Public Sub CreateMyProc(connection As OdbcConnection) + + Dim command As OdbcCommand = connection.CreateCommand() + command.CommandText = "{ call MyProc(?,?,?) }" + command.Parameters.Add("", OdbcType.Int).Value = 1 + command.Parameters.Add("", OdbcType.Decimal).Value = 2 + command.Parameters.Add("", OdbcType.Decimal).Value = 3 + +End Sub +``` + +```csharp +public void CreateMyProc(OdbcConnection connection) +{ + OdbcCommand command = connection.CreateCommand(); + command.CommandText = "{ call MyProc(?,?,?) }"; + command.Parameters.Add("", OdbcType.Int).Value = 1; + command.Parameters.Add("", OdbcType.Decimal).Value = 2; + command.Parameters.Add("", OdbcType.Decimal).Value = 3; +} +``` + ]]> The property was not set to one of the valid values. @@ -661,33 +661,33 @@ public void CreateMyProc(OdbcConnection connection) if null values are accepted; otherwise . The default is . - class. - - - -## Examples - The following example creates an and sets some of its properties. - -```vb -Public Sub CreateOdbcParameter() - Dim parameter As New OdbcParameter("Description", OdbcType.VarChar, 88) - parameter.IsNullable = True - parameter.Direction = ParameterDirection.Output -End Sub -``` - -```csharp -public void CreateOdbcParameter() -{ - OdbcParameter parameter = new OdbcParameter("Description", OdbcType.VarChar, 88); - parameter.IsNullable = true; - parameter.Direction = ParameterDirection.Output; -} -``` - + class. + + + +## Examples + The following example creates an and sets some of its properties. + +```vb +Public Sub CreateOdbcParameter() + Dim parameter As New OdbcParameter("Description", OdbcType.VarChar, 88) + parameter.IsNullable = True + parameter.Direction = ParameterDirection.Output +End Sub +``` + +```csharp +public void CreateOdbcParameter() +{ + OdbcParameter parameter = new OdbcParameter("Description", OdbcType.VarChar, 88); + parameter.IsNullable = true; + parameter.Direction = ParameterDirection.Output; +} +``` + ]]> Working with Commands @@ -732,13 +732,13 @@ public void CreateOdbcParameter() Gets or sets the of the parameter. An value that is the of the parameter. The default is . - and are linked. Therefore, setting the changes the to a supporting . - - For a list of the supported data types, see the appropriate member. For more information, see [DataAdapter Parameters](/dotnet/framework/data/adonet/dataadapter-parameters). - + and are linked. Therefore, setting the changes the to a supporting . + + For a list of the supported data types, see the appropriate member. For more information, see [DataAdapter Parameters](/dotnet/framework/data/adonet/dataadapter-parameters). + ]]> Working with Commands @@ -781,48 +781,48 @@ public void CreateOdbcParameter() Gets or sets the name of the . The name of the . The default is an empty string (""). - and the actual parameters accepted by the stored procedure or parameterized SQL statement correspond to each other based on the order in which the objects are inserted into the collection instead of by parameter name. Parameter names can be supplied, but will be ignored during parameter object binding. - - - -## Examples - The following example assumes that the data source has a table name **MyTable** and a stored procedure named MyProc that is defined as: - -``` -CREATE TABLE MyTable (col1 int, col2 smallmoney, col3 decimal) -CREATE PROC MyProc (@p1 int, @p2 smallmoney, @p3 decimal) AS INSERT INTO MyTable VALUES (@p1, @p2, @p3) -``` - - The following example creates parameters and calls the MyProc stored procedure: - -```vb -Public Sub CreateMyProc(connection As OdbcConnection) - - Dim command As OdbcCommand = connection.CreateCommand() - - command.CommandText = "{ call MyProc(?,?,?) }" - command.Parameters.Add("", OdbcType.Int).Value = 1 - command.Parameters.Add("", OdbcType.Decimal).Value = 2 - command.Parameters.Add("", OdbcType.Decimal).Value = 3 - -End Sub -``` - -```csharp -public void CreateMyProc(OdbcConnection connection) -{ - OdbcCommand command = myConnection.CreateCommand(); - - command.CommandText = "{ call MyProc(?,?,?) }"; - command.Parameters.Add("", OdbcType.Int).Value = 1; - command.Parameters.Add("", OdbcType.Decimal).Value = 2; - command.Parameters.Add("", OdbcType.Decimal).Value = 3; -} -``` - + and the actual parameters accepted by the stored procedure or parameterized SQL statement correspond to each other based on the order in which the objects are inserted into the collection instead of by parameter name. Parameter names can be supplied, but will be ignored during parameter object binding. + + + +## Examples + The following example assumes that the data source has a table name **MyTable** and a stored procedure named MyProc that is defined as: + +``` +CREATE TABLE MyTable (col1 int, col2 smallmoney, col3 decimal) +CREATE PROC MyProc (@p1 int, @p2 smallmoney, @p3 decimal) AS INSERT INTO MyTable VALUES (@p1, @p2, @p3) +``` + + The following example creates parameters and calls the MyProc stored procedure: + +```vb +Public Sub CreateMyProc(connection As OdbcConnection) + + Dim command As OdbcCommand = connection.CreateCommand() + + command.CommandText = "{ call MyProc(?,?,?) }" + command.Parameters.Add("", OdbcType.Int).Value = 1 + command.Parameters.Add("", OdbcType.Decimal).Value = 2 + command.Parameters.Add("", OdbcType.Decimal).Value = 3 + +End Sub +``` + +```csharp +public void CreateMyProc(OdbcConnection connection) +{ + OdbcCommand command = myConnection.CreateCommand(); + + command.CommandText = "{ call MyProc(?,?,?) }"; + command.Parameters.Add("", OdbcType.Int).Value = 1; + command.Parameters.Add("", OdbcType.Decimal).Value = 2; + command.Parameters.Add("", OdbcType.Decimal).Value = 3; +} +``` + ]]> Working with Commands @@ -862,40 +862,40 @@ public void CreateMyProc(OdbcConnection connection) Gets or sets the number of digits used to represent the property. The maximum number of digits used to represent the property. The default value is 0, which indicates that the data provider sets the precision for . - property only affects parameters whose is `Decimal` or `Numeric`. For other data types, is ignored. - + property only affects parameters whose is `Decimal` or `Numeric`. For other data types, is ignored. + > [!NOTE] -> Use of this property to coerce data passed to the database is not supported. To round, truncate, or otherwise coerce data before passing it to the database, use the class that is part of the `System` namespace prior to assigning a value to the parameter's `Value` property. - - - -## Examples - The following example creates an and sets some of its properties. - -```vb -Public Sub CreateOdbcParameter() - Dim parameter As New OdbcParameter("Price", OdbcType.Decimal) - parameter.Value = 3.1416 - parameter.Precision = 8 - parameter.Scale = 4 -End Sub -``` - -```csharp -public void CreateOdbcParameter() - { - OdbcParameter parameter = new OdbcParameter("Price", OdbcType.Decimal); - parameter.Value = 3.1416; - parameter.Precision = 8; - parameter.Scale = 4; - } -``` - +> Use of this property to coerce data passed to the database is not supported. To round, truncate, or otherwise coerce data before passing it to the database, use the class that is part of the `System` namespace prior to assigning a value to the parameter's `Value` property. + + + +## Examples + The following example creates an and sets some of its properties. + +```vb +Public Sub CreateOdbcParameter() + Dim parameter As New OdbcParameter("Price", OdbcType.Decimal) + parameter.Value = 3.1416 + parameter.Precision = 8 + parameter.Scale = 4 +End Sub +``` + +```csharp +public void CreateOdbcParameter() + { + OdbcParameter parameter = new OdbcParameter("Price", OdbcType.Decimal); + parameter.Value = 3.1416; + parameter.Precision = 8; + parameter.Scale = 4; + } +``` + ]]> Working with Commands @@ -925,13 +925,13 @@ public void CreateOdbcParameter() Resets the type associated with this . - and properties of the . - - Calling resets to its default value (String). - + and properties of the . + + Calling resets to its default value (String). + ]]> Working with Commands @@ -961,11 +961,11 @@ public void CreateOdbcParameter() Resets the type associated with this . - and properties of the . - + and properties of the . + ]]> Working with Commands @@ -1005,47 +1005,47 @@ public void CreateOdbcParameter() Gets or sets the number of decimal places to which is resolved. The number of decimal places to which is resolved. The default is 0. - property is used only for decimal and numeric input parameters. - - The effect of setting this property to a value other than the value in the database depends on the implementation of the data provider and may return an error code, or truncate or round data. - - The property only affects parameters whose is `Decimal` or `Numeric`. For other data types, is ignored. - - When using SQL Server Native Client 10 (or later) to bind a parameter whose type is Decimal, Numeric, VarNumeric, DBDate, or DBTimeStamp, you must manually specify an appropriate Scale value. - + property is used only for decimal and numeric input parameters. + + The effect of setting this property to a value other than the value in the database depends on the implementation of the data provider and may return an error code, or truncate or round data. + + The property only affects parameters whose is `Decimal` or `Numeric`. For other data types, is ignored. + + When using SQL Server Native Client 10 (or later) to bind a parameter whose type is Decimal, Numeric, VarNumeric, DBDate, or DBTimeStamp, you must manually specify an appropriate Scale value. + > [!NOTE] -> Use of this property to coerce data passed to the database is not supported. To round, truncate, or otherwise coerce data before passing it to the database, use the class that is part of the `System` namespace prior to assigning a value to the parameter's `Value` property. - +> Use of this property to coerce data passed to the database is not supported. To round, truncate, or otherwise coerce data before passing it to the database, use the class that is part of the `System` namespace prior to assigning a value to the parameter's `Value` property. + > [!NOTE] -> .NET Framework data providers that are included with the .NET Framework version 1.0 do not verify the `scale` of parameter values. This can cause modified data being inserted at the data source. If you are using .NET Framework version 1.0, validate the `scale` of `decimal` values before setting the parameter value. When you use .NET Framework version 1.1 or later versions, `scale` values that exceed the `decimal` parameter scale might only be truncated in scale, if that is the behavior of the underlying ODBC driver. - - - -## Examples - The following example creates an and sets some of its properties. - -```vb -Public Sub CreateOdbcParameter() - Dim parameter As New OdbcParameter("Price", OdbcType.Decimal) - parameter.Value = 3.1416 - parameter.Precision = 8 - parameter.Scale = 4 -End Sub -``` - -```csharp -public void CreateOdbcParameter() - { - OdbcParameter parameter = new OdbcParameter("Price", OdbcType.Decimal); - parameter.Value = 3.1416; - parameter.Precision = 8; - parameter.Scale = 4; - } -``` - +> .NET Framework data providers that are included with the .NET Framework version 1.0 do not verify the `scale` of parameter values. This can cause modified data being inserted at the data source. If you are using .NET Framework version 1.0, validate the `scale` of `decimal` values before setting the parameter value. When you use .NET Framework version 1.1 or later versions, `scale` values that exceed the `decimal` parameter scale might only be truncated in scale, if that is the behavior of the underlying ODBC driver. + + + +## Examples + The following example creates an and sets some of its properties. + +```vb +Public Sub CreateOdbcParameter() + Dim parameter As New OdbcParameter("Price", OdbcType.Decimal) + parameter.Value = 3.1416 + parameter.Precision = 8 + parameter.Scale = 4 +End Sub +``` + +```csharp +public void CreateOdbcParameter() + { + OdbcParameter parameter = new OdbcParameter("Price", OdbcType.Decimal); + parameter.Value = 3.1416; + parameter.Precision = 8; + parameter.Scale = 4; + } +``` + ]]> Working with Commands @@ -1088,50 +1088,50 @@ public void CreateOdbcParameter() Gets or sets the maximum size of the data within the column. The maximum size of the data within the column. The default value is inferred from the parameter value. - property is used for binary and string types. - - For nonstring data types and ANSI string data, the property refers to the number of bytes. For Unicode string data, refers to the number of characters. The count for strings does not include the terminating character. - - For variable-length data types, `Size` describes the maximum amount of data to transmit to the server. For example, for a Unicode string value, `Size` could be used to limit the amount of data sent to the server to the first one hundred characters. - - For bidirectional and output parameters, and return values, you must set the value of `Size`. This is not required for input parameters, and if not explicitly set, the value of is inferred from the actual size of the specified parameter when a parameterized statement is executed. - - The , , and properties of a parameter can be inferred by setting . Therefore, you are not required to specify them. However, they are not exposed in property settings. For example, if the size of the parameter has been inferred, `Size` does not contain inferred value after statement execution. - + property is used for binary and string types. + + For nonstring data types and ANSI string data, the property refers to the number of bytes. For Unicode string data, refers to the number of characters. The count for strings does not include the terminating character. + + For variable-length data types, `Size` describes the maximum amount of data to transmit to the server. For example, for a Unicode string value, `Size` could be used to limit the amount of data sent to the server to the first one hundred characters. + + For bidirectional and output parameters, and return values, you must set the value of `Size`. This is not required for input parameters, and if not explicitly set, the value of is inferred from the actual size of the specified parameter when a parameterized statement is executed. + + The , , and properties of a parameter can be inferred by setting . Therefore, you are not required to specify them. However, they are not exposed in property settings. For example, if the size of the parameter has been inferred, `Size` does not contain inferred value after statement execution. + > [!NOTE] -> For an `OdbcParameter` with a of `ParameterDirection.Output`, `ParameterDirection.InputOutput`, or `ParameterDirection.ReturnValue`, an exception is thrown when the command is executed if the size of the value returned by the data source exceeds the specified `Size` of the . - - For fixed-length data types, the value of `Size` is ignored. It can be retrieved for informational purposes, and returns the maximum amount of bytes the provider uses when transmitting the value of the parameter to the server. - - - -## Examples - The following example creates an and sets some of its properties. - -```vb -Public Sub CreateOdbcParameter() - Dim myValue As String = "12 foot scarf - multiple colors, one previous owner" - Dim parameter As New OdbcParameter("Description", OdbcType.VarChar) - parameter.Direction = ParameterDirection.Output - parameter.Size = myValue.Length - parameter.Value = myValue -End Sub -``` - -```csharp -public void CreateOdbcParameter() - { - string myValue = "12 foot scarf - multiple colors, one previous owner"; - OdbcParameter parameter = new OdbcParameter("Description", OdbcType.VarChar); - parameter.Direction = ParameterDirection.Output; - parameter.Size = myValue.Length; - parameter.Value = myValue; - } -``` - +> For an `OdbcParameter` with a of `ParameterDirection.Output`, `ParameterDirection.InputOutput`, or `ParameterDirection.ReturnValue`, an exception is thrown when the command is executed if the size of the value returned by the data source exceeds the specified `Size` of the . + + For fixed-length data types, the value of `Size` is ignored. It can be retrieved for informational purposes, and returns the maximum amount of bytes the provider uses when transmitting the value of the parameter to the server. + + + +## Examples + The following example creates an and sets some of its properties. + +```vb +Public Sub CreateOdbcParameter() + Dim myValue As String = "12 foot scarf - multiple colors, one previous owner" + Dim parameter As New OdbcParameter("Description", OdbcType.VarChar) + parameter.Direction = ParameterDirection.Output + parameter.Size = myValue.Length + parameter.Value = myValue +End Sub +``` + +```csharp +public void CreateOdbcParameter() + { + string myValue = "12 foot scarf - multiple colors, one previous owner"; + OdbcParameter parameter = new OdbcParameter("Description", OdbcType.VarChar); + parameter.Direction = ParameterDirection.Output; + parameter.Size = myValue.Length; + parameter.Value = myValue; + } +``` + ]]> Working with Commands @@ -1174,33 +1174,33 @@ public void CreateOdbcParameter() Gets or sets the name of the source column mapped to the and used for loading or returning the . The name of the source column that will be used to set the value of this parameter. The default is an empty string (""). - is set to anything other than an empty string, the value of the parameter is retrieved from the column with the `SourceColumn` name. If is set to `Input`, the value is taken from the . If `Direction` is set to `Output`, the value is taken from the data source. A `Direction` of `InputOutput` is a combination of both. - - For more information about how to use the property, see [DataAdapter Parameters](/dotnet/framework/data/adonet/dataadapter-parameters) and [Updating Data Sources with DataAdapters](/dotnet/framework/data/adonet/updating-data-sources-with-dataadapters). - - - -## Examples - The following example creates an and sets some of its properties. - -```vb -Public Sub CreateOdbcParameter() - Dim parameter As New OdbcParameter("Description", OdbcType.VarChar, 88) - parameter.SourceColumn = "Description" -End Sub -``` - -```csharp -public void CreateOdbcParameter() - { - OdbcParameter parameter = new OdbcParameter("Description", OdbcType.VarChar, 88); - parameter.SourceColumn = "Description"; - } -``` - + is set to anything other than an empty string, the value of the parameter is retrieved from the column with the `SourceColumn` name. If is set to `Input`, the value is taken from the . If `Direction` is set to `Output`, the value is taken from the data source. A `Direction` of `InputOutput` is a combination of both. + + For more information about how to use the property, see [DataAdapter Parameters](/dotnet/framework/data/adonet/dataadapter-parameters) and [Updating Data Sources with DataAdapters](/dotnet/framework/data/adonet/updating-data-sources-with-dataadapters). + + + +## Examples + The following example creates an and sets some of its properties. + +```vb +Public Sub CreateOdbcParameter() + Dim parameter As New OdbcParameter("Description", OdbcType.VarChar, 88) + parameter.SourceColumn = "Description" +End Sub +``` + +```csharp +public void CreateOdbcParameter() + { + OdbcParameter parameter = new OdbcParameter("Description", OdbcType.VarChar, 88); + parameter.SourceColumn = "Description"; + } +``` + ]]> Working with Commands @@ -1231,26 +1231,26 @@ public void CreateOdbcParameter() if the source column is nullable; if it is not. - is used by the to correctly generate update commands when dealing with nullable columns. Generally, use of is limited to developers inheriting from . - - uses this property to determine whether the source column is nullable, and sets this property to `true` if it is nullable, and `false` if it is not. When is generating its Update statement, it examines the for each parameter. If the property is `true`, generates a WHERE clauses like the following example. In this query expression, "FieldName" represents the name of the field: - -``` -((@IsNull_FieldName = 1 AND FieldName IS NULL) OR - (FieldName = @Original_FieldName)) -``` - - If for the field is false, generates the following WHERE clause: - -``` -FieldName = @OriginalFieldName -``` - - In addition, @IsNull_FieldName contains 1 if the source field contains null, and 0 if it does not. This mechanism allows for a performance optimization in SQL Server, and provides for common code that works across multiple providers. - + is used by the to correctly generate update commands when dealing with nullable columns. Generally, use of is limited to developers inheriting from . + + uses this property to determine whether the source column is nullable, and sets this property to `true` if it is nullable, and `false` if it is not. When is generating its Update statement, it examines the for each parameter. If the property is `true`, generates a WHERE clauses like the following example. In this query expression, "FieldName" represents the name of the field: + +``` +((@IsNull_FieldName = 1 AND FieldName IS NULL) OR + (FieldName = @Original_FieldName)) +``` + + If for the field is false, generates the following WHERE clause: + +``` +FieldName = @OriginalFieldName +``` + + In addition, @IsNull_FieldName contains 1 if the source field contains null, and 0 if it does not. This mechanism allows for a performance optimization in SQL Server, and provides for common code that works across multiple providers. + ]]> Working with Commands @@ -1293,35 +1293,35 @@ FieldName = @OriginalFieldName Gets or sets the to use when you load . One of the values. The default is Current. - during an operation to determine whether the parameter value is set to Current or Original. This allows primary keys to be updated. - - This property is set to the version of the used by either the `Item` property (`DataRow` indexer), or the method. - - - -## Examples - The following example creates an and sets some of its properties. - -```vb -Public Sub CreateOdbcParameter() - Dim parameter As New OdbcParameter("Description", OdbcType.VarChar, 88) - parameter.SourceColumn = "Description" - parameter.SourceVersion = DataRowVersion.Current -End Sub -``` - -```csharp -public void CreateOdbcParameter() - { - OdbcParameter parameter = new OdbcParameter("Description", OdbcType.VarChar, 88); - parameter.SourceColumn = "Description"; - parameter.SourceVersion = DataRowVersion.Current; - } -``` - + during an operation to determine whether the parameter value is set to Current or Original. This allows primary keys to be updated. + + This property is set to the version of the used by either the `Item` property (`DataRow` indexer), or the method. + + + +## Examples + The following example creates an and sets some of its properties. + +```vb +Public Sub CreateOdbcParameter() + Dim parameter As New OdbcParameter("Description", OdbcType.VarChar, 88) + parameter.SourceColumn = "Description" + parameter.SourceVersion = DataRowVersion.Current +End Sub +``` + +```csharp +public void CreateOdbcParameter() + { + OdbcParameter parameter = new OdbcParameter("Description", OdbcType.VarChar, 88); + parameter.SourceColumn = "Description"; + parameter.SourceVersion = DataRowVersion.Current; + } +``` + ]]> Working with Commands @@ -1357,11 +1357,11 @@ public void CreateOdbcParameter() For a description of this member, see . A new that is a copy of this instance. - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1445,39 +1445,39 @@ public void CreateOdbcParameter() Gets or sets the value of the parameter. An that is the value of the parameter. The default value is null. - that is sent to the server. For output and return-value parameters, the value is set on completion of the and after the is closed. - - When you send a null parameter value to the server, the user must specify , not null. A null value in the system is an empty object that has no value. is used to represent null values. If the parameter is used to call a stored procedure with parameters that have default values, setting to null causes the default value to be used. - - If the application specifies the database type, the bound value is converted to that type when the provider sends the data to the server. The provider tries to convert any type of value if it supports the interface. Conversion errors may result if the specified type is not compatible with the value. - - Both the and properties can be inferred by setting . If applicable, the size, precision, and scale is also inferred from when the parameterized statement is executed. However, inferred values are not exposed to the user. - - The property is overwritten by the `Update` method. - - - -## Examples - The following example creates an and sets some of its properties. - -```vb -Public Sub CreateOdbcParameter() - Dim parameter As New OdbcParameter("Description", OdbcType.VarChar, 88) - parameter.Value = "garden hose" -End Sub -``` - -```csharp -public void CreateOdbcParameter() - { - OdbcParameter parameter = new OdbcParameter("Description", OdbcType.VarChar, 88); - parameter.Value = "garden hose"; - } -``` - + that is sent to the server. For output and return-value parameters, the value is set on completion of the and after the is closed. + + When you send a null parameter value to the server, the user must specify , not null. A null value in the system is an empty object that has no value. is used to represent null values. If the parameter is used to call a stored procedure with parameters that have default values, setting to null causes the default value to be used. + + If the application specifies the database type, the bound value is converted to that type when the provider sends the data to the server. The provider tries to convert any type of value if it supports the interface. Conversion errors may result if the specified type is not compatible with the value. + + Both the and properties can be inferred by setting . If applicable, the size, precision, and scale is also inferred from when the parameterized statement is executed. However, inferred values are not exposed to the user. + + The property is overwritten by the `Update` method. + + + +## Examples + The following example creates an and sets some of its properties. + +```vb +Public Sub CreateOdbcParameter() + Dim parameter As New OdbcParameter("Description", OdbcType.VarChar, 88) + parameter.Value = "garden hose" +End Sub +``` + +```csharp +public void CreateOdbcParameter() + { + OdbcParameter parameter = new OdbcParameter("Description", OdbcType.VarChar, 88); + parameter.Value = "garden hose"; + } +``` + ]]> Working with Commands diff --git a/xml/System.Data.OleDb/OleDbParameter.xml b/xml/System.Data.OleDb/OleDbParameter.xml index 66a38446184..c3230a1f009 100644 --- a/xml/System.Data.OleDb/OleDbParameter.xml +++ b/xml/System.Data.OleDb/OleDbParameter.xml @@ -60,39 +60,39 @@ Represents a parameter to an and optionally its mapping to a column. This class cannot be inherited. - through the collection within the . These parameters are used to select data from the data source and place the data in the . This example assumes that a and an have already been created by using the appropriate schema, commands, and connection. - + through the collection within the . These parameters are used to select data from the data source and place the data in the . This example assumes that a and an have already been created by using the appropriate schema, commands, and connection. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_ADO.NET/Classic WebData OleDbParameter Example/CS/source.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData OleDbParameter Example/VB/source.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData OleDbParameter Example/VB/source.vb" id="Snippet1"::: + ]]> Working with Commands @@ -129,14 +129,14 @@ OleDbDataReader reader = command.ExecuteReader(); Initializes a new instance of the class. - and sets some of its properties. - + and sets some of its properties. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_ADO.NET/Classic WebData OleDbParameter.OleDbParameter Example/CS/source.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData OleDbParameter.OleDbParameter Example/VB/source.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData OleDbParameter.OleDbParameter Example/VB/source.vb" id="Snippet1"::: + ]]> Working with Commands @@ -170,19 +170,19 @@ OleDbDataReader reader = command.ExecuteReader(); One of the values. Initializes a new instance of the class that uses the parameter name and data type. - and are inferred from the value of the `dataType` parameter. - - - -## Examples - The following example creates an and sets some of its properties. - + and are inferred from the value of the `dataType` parameter. + + + +## Examples + The following example creates an and sets some of its properties. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_ADO.NET/Classic WebData OleDbParameter.OleDbParameter1 Example/CS/source.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData OleDbParameter.OleDbParameter1 Example/VB/source.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData OleDbParameter.OleDbParameter1 Example/VB/source.vb" id="Snippet1"::: + ]]> The value supplied in the parameter is an invalid back-end data type. @@ -217,25 +217,25 @@ OleDbDataReader reader = command.ExecuteReader(); The value of the new object. Initializes a new instance of the class that uses the parameter name and the value of the new . - constructor to specify integer parameter values. Because this overload takes a `value` of type , you must convert the integral value to an type when the value is zero, as the following C# example demonstrates. - -```csharp -Parameter = new OleDbParameter("@pname", Convert.ToInt32(0)); -``` - - If you do not perform this conversion, the compiler assumes that you are trying to call the constructor overload. - - - -## Examples - The following example creates an . - + constructor to specify integer parameter values. Because this overload takes a `value` of type , you must convert the integral value to an type when the value is zero, as the following C# example demonstrates. + +```csharp +Parameter = new OleDbParameter("@pname", Convert.ToInt32(0)); +``` + + If you do not perform this conversion, the compiler assumes that you are trying to call the constructor overload. + + + +## Examples + The following example creates an . + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_ADO.NET/Classic WebData OleDbParameter.OleDbParameter5 Example/CS/source.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData OleDbParameter.OleDbParameter5 Example/VB/source.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData OleDbParameter.OleDbParameter5 Example/VB/source.vb" id="Snippet1"::: + ]]> Working with Commands @@ -271,19 +271,19 @@ Parameter = new OleDbParameter("@pname", Convert.ToInt32(0)); The length of the parameter. Initializes a new instance of the class that uses the parameter name, data type, and length. - is inferred from the value of the `dataType` parameter if it is not explicitly set in the `size` parameter. - - - -## Examples - The following example creates an and sets some of its properties. - + is inferred from the value of the `dataType` parameter if it is not explicitly set in the `size` parameter. + + + +## Examples + The following example creates an and sets some of its properties. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_ADO.NET/Classic WebData OleDbParameter.OleDbParameter2 Example/CS/source.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData OleDbParameter.OleDbParameter2 Example/VB/source.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData OleDbParameter.OleDbParameter2 Example/VB/source.vb" id="Snippet1"::: + ]]> The value supplied in the parameter is an invalid back-end data type. @@ -322,19 +322,19 @@ Parameter = new OleDbParameter("@pname", Convert.ToInt32(0)); The name of the source column. Initializes a new instance of the class that uses the parameter name, data type, length, and source column name. - is inferred from the value of the `dataType` parameter if it is not explicitly set in the `size` parameter. - - - -## Examples - The following example creates an and sets some of its properties. - + is inferred from the value of the `dataType` parameter if it is not explicitly set in the `size` parameter. + + + +## Examples + The following example creates an and sets some of its properties. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_ADO.NET/Classic WebData OleDbParameter.OleDbParameter3 Example/CS/source.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData OleDbParameter.OleDbParameter3 Example/VB/source.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData OleDbParameter.OleDbParameter3 Example/VB/source.vb" id="Snippet1"::: + ]]> The value supplied in the parameter is an invalid back-end data type. @@ -392,22 +392,22 @@ Parameter = new OleDbParameter("@pname", Convert.ToInt32(0)); An that is the value of the . Initializes a new instance of the class that uses the parameter name, data type, length, source column name, parameter direction, numeric precision, and other properties. - and are inferred from the value of the `dataType` parameter if they are not explicitly set in the `size` and `precision` parameters. - - - -## Examples - The following example creates an and displays the . - + and are inferred from the value of the `dataType` parameter if they are not explicitly set in the `size` and `precision` parameters. + + + +## Examples + The following example creates an and displays the . + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_ADO.NET/Classic WebData OleDbParameter.OleDbParameter4 Example/CS/source.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData OleDbParameter.OleDbParameter4 Example/VB/source.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData OleDbParameter.OleDbParameter4 Example/VB/source.vb" id="Snippet1"::: + ]]> - The value supplied in the parameter is an invalid back-end data type. + The value supplied in the parameter is an invalid back-end data type. Working with Commands @@ -461,22 +461,22 @@ Parameter = new OleDbParameter("@pname", Convert.ToInt32(0)); An that is the value of the . Initializes a new instance of the class that uses the parameter name, data type, length, source column name, parameter direction, numeric precision, and other properties. - and are inferred from the value of the `dataType` parameter if they are not explicitly set in the `size` and `precision` parameters. - - - -## Examples - The following example creates an and displays the . - + and are inferred from the value of the `dataType` parameter if they are not explicitly set in the `size` and `precision` parameters. + + + +## Examples + The following example creates an and displays the . + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_ADO.NET/Classic WebData OleDbParameter.OleDbParameter4 Example/CS/source.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData OleDbParameter.OleDbParameter4 Example/VB/source.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData OleDbParameter.OleDbParameter4 Example/VB/source.vb" id="Snippet1"::: + ]]> - The value supplied in the parameter is an invalid back-end data type. + The value supplied in the parameter is an invalid back-end data type. Working with Commands @@ -529,21 +529,21 @@ Parameter = new OleDbParameter("@pname", Convert.ToInt32(0)); Gets or sets the of the parameter. One of the values. The default is . - and are linked. Therefore, setting the changes the to a supporting . - - For a list of the supported data types, see the appropriate member. For more information, see [DataAdapter Parameters](/dotnet/framework/data/adonet/dataadapter-parameters). - - - -## Examples - The following example creates an and sets some of its properties. - + and are linked. Therefore, setting the changes the to a supporting . + + For a list of the supported data types, see the appropriate member. For more information, see [DataAdapter Parameters](/dotnet/framework/data/adonet/dataadapter-parameters). + + + +## Examples + The following example creates an and sets some of its properties. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_ADO.NET/Classic WebData OleDbParameter.DbType Example/CS/source.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData OleDbParameter.DbType Example/VB/source.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData OleDbParameter.DbType Example/VB/source.vb" id="Snippet1"::: + ]]> The property was not set to a valid . @@ -595,33 +595,33 @@ Parameter = new OleDbParameter("@pname", Convert.ToInt32(0)); Gets or sets a value that indicates whether the parameter is input-only, output-only, bidirectional, or a stored procedure return-value parameter. One of the values. The default is . - is output, and execution of the associated does not return a value, the contains a null value. - - `Output`, `InputOut`, and `ReturnValue` parameters returned by calling cannot be accessed until you call or **Dispose** on the . - - - -## Examples - The following example creates an and sets some of its properties. - -```vb -Public Sub CreateOleDbParameter() - Dim parameter As New OleDbParameter("Description", OleDbType.VarChar, 88) - parameter.Direction = ParameterDirection.Output -End Sub 'CreateOleDbParameter -``` - -```csharp -public void CreateOleDbParameter() - { - OleDbParameter parameter = new OleDbParameter("Description", OleDbType.VarChar, 88); - parameter.Direction = ParameterDirection.Output; - } -``` - + is output, and execution of the associated does not return a value, the contains a null value. + + `Output`, `InputOut`, and `ReturnValue` parameters returned by calling cannot be accessed until you call or **Dispose** on the . + + + +## Examples + The following example creates an and sets some of its properties. + +```vb +Public Sub CreateOleDbParameter() + Dim parameter As New OleDbParameter("Description", OleDbType.VarChar, 88) + parameter.Direction = ParameterDirection.Output +End Sub 'CreateOleDbParameter +``` + +```csharp +public void CreateOleDbParameter() + { + OleDbParameter parameter = new OleDbParameter("Description", OleDbType.VarChar, 88); + parameter.Direction = ParameterDirection.Output; + } +``` + ]]> The property was not set to one of the valid values. @@ -679,33 +679,33 @@ public void CreateOleDbParameter() if null values are accepted; otherwise . The default is . - class. - - - -## Examples - The following example creates an and sets some of its properties. - -```vb -Public Sub CreateOleDbParameter() - Dim parameter As New OleDbParameter("Description", OleDbType.VarChar, 88) - parameter.IsNullable = True - parameter.Direction = ParameterDirection.Output -End Sub 'CreateOleDbParameter -``` - -```csharp -public void CreateOleDbParameter() - { - OleDbParameter parameter = new OleDbParameter("Description", OleDbType.VarChar, 88); - parameter.IsNullable = true; - parameter.Direction = ParameterDirection.Output; - } -``` - + class. + + + +## Examples + The following example creates an and sets some of its properties. + +```vb +Public Sub CreateOleDbParameter() + Dim parameter As New OleDbParameter("Description", OleDbType.VarChar, 88) + parameter.IsNullable = True + parameter.Direction = ParameterDirection.Output +End Sub 'CreateOleDbParameter +``` + +```csharp +public void CreateOleDbParameter() + { + OleDbParameter parameter = new OleDbParameter("Description", OleDbType.VarChar, 88); + parameter.IsNullable = true; + parameter.Direction = ParameterDirection.Output; + } +``` + ]]> Working with Commands @@ -754,13 +754,13 @@ public void CreateOleDbParameter() Gets or sets the of the parameter. The of the parameter. The default is . - and are linked. Therefore, setting the changes the to a supporting . - - For a list of the supported data types, see the appropriate member. For more information, see [DataAdapter Parameters](/dotnet/framework/data/adonet/dataadapter-parameters). - + and are linked. Therefore, setting the changes the to a supporting . + + For a list of the supported data types, see the appropriate member. For more information, see [DataAdapter Parameters](/dotnet/framework/data/adonet/dataadapter-parameters). + ]]> Working with Commands @@ -811,31 +811,31 @@ public void CreateOleDbParameter() Gets or sets the name of the . The name of the . The default is an empty string (""). - and sets some of its properties. - -```vb -Public Sub CreateOleDbParameter() - Dim parameter As New OleDbParameter("Description", OleDbType.VarChar, 88) - parameter.Direction = ParameterDirection.Output -End Sub 'CreateOleDbParameter -``` - -```csharp -public void CreateOleDbParameter() - { - OleDbParameter parameter = new OleDbParameter("Description", OleDbType.VarChar, 88); - parameter.Direction = ParameterDirection.Output; - } -``` - + and sets some of its properties. + +```vb +Public Sub CreateOleDbParameter() + Dim parameter As New OleDbParameter("Description", OleDbType.VarChar, 88) + parameter.Direction = ParameterDirection.Output +End Sub 'CreateOleDbParameter +``` + +```csharp +public void CreateOleDbParameter() + { + OleDbParameter parameter = new OleDbParameter("Description", OleDbType.VarChar, 88); + parameter.Direction = ParameterDirection.Output; + } +``` + ]]> Working with Commands @@ -879,47 +879,47 @@ public void CreateOleDbParameter() Gets or sets the maximum number of digits used to represent the property. The maximum number of digits used to represent the property. The default value is 0, which indicates that the data provider sets the precision for . - property is only used for decimal and numeric input parameters. - - The property should be set only for `Decimal` and `Numeric` parameters prior to calling the method of the . - - Setting this property to a value other than the value in the database depends on the implementation of the data provider and may return an error code, truncate, or round data. - - The `Precision` property only affects parameters whose is `Decimal`, `Numeric`, or `VarNumeric`. For other data types, `Precision` is ignored. - + property is only used for decimal and numeric input parameters. + + The property should be set only for `Decimal` and `Numeric` parameters prior to calling the method of the . + + Setting this property to a value other than the value in the database depends on the implementation of the data provider and may return an error code, truncate, or round data. + + The `Precision` property only affects parameters whose is `Decimal`, `Numeric`, or `VarNumeric`. For other data types, `Precision` is ignored. + > [!NOTE] -> Use of this property to coerce data passed to the database is not supported. To round, truncate, or otherwise coerce data before passing it to the database, use the class that is part of the `System` namespace prior to assigning a value to the parameter's `Value` property. - +> Use of this property to coerce data passed to the database is not supported. To round, truncate, or otherwise coerce data before passing it to the database, use the class that is part of the `System` namespace prior to assigning a value to the parameter's `Value` property. + > [!NOTE] -> .NET Framework data providers that are included with the .NET Framework version 1.0 do not verify the or of parameter values. This can cause truncated data to be inserted at the data source. If you are using .NET Framework version 1.0, validate the and of values before setting the parameter value. values that exceed the parameter scale are still truncated. - - - -## Examples - The following example creates an and sets some of its properties. - -```vb -Public Sub CreateOleDbParameter() - Dim parameter As New OleDbParameter("Price", OleDbType.Decimal) - parameter.Value = 3.1416 - parameter.Precision = 8 - parameter.Scale = 4 -End Sub 'CreateOleDbParameter -``` - -```csharp -public void CreateOleDbParameter() - { - OleDbParameter parameter = new OleDbParameter("Price", OleDbType.Decimal); - parameter.Value = 3.1416; - parameter.Precision = 8; - parameter.Scale = 4; - } -``` - +> .NET Framework data providers that are included with the .NET Framework version 1.0 do not verify the or of parameter values. This can cause truncated data to be inserted at the data source. If you are using .NET Framework version 1.0, validate the and of values before setting the parameter value. values that exceed the parameter scale are still truncated. + + + +## Examples + The following example creates an and sets some of its properties. + +```vb +Public Sub CreateOleDbParameter() + Dim parameter As New OleDbParameter("Price", OleDbType.Decimal) + parameter.Value = 3.1416 + parameter.Precision = 8 + parameter.Scale = 4 +End Sub 'CreateOleDbParameter +``` + +```csharp +public void CreateOleDbParameter() + { + OleDbParameter parameter = new OleDbParameter("Price", OleDbType.Decimal); + parameter.Value = 3.1416; + parameter.Precision = 8; + parameter.Scale = 4; + } +``` + ]]> Working with Commands @@ -949,11 +949,11 @@ public void CreateOleDbParameter() Resets the type associated with this . - and properties of the . - + and properties of the . + ]]> @@ -986,11 +986,11 @@ public void CreateOleDbParameter() Resets the type associated with this . - and properties of the . - + and properties of the . + ]]> @@ -1037,45 +1037,45 @@ public void CreateOleDbParameter() Gets or sets the number of decimal places to which is resolved. The number of decimal places to which is resolved. The default is 0. - property is only used for decimal and numeric input parameters before calling the method of the and to specify numeric output parameters. - - Setting this property to a value other than the value in the database depends on the implementation of the data provider and may return an error code, truncate, or round data. - - When using SQL Server Native Client 10 (or later), to bind a parameter whose type is `Decimal`, `Numeric`, `VarNumeric`, `DBDate`, or `DBTimeStamp`, you must manually specify an appropriate scale value. - + property is only used for decimal and numeric input parameters before calling the method of the and to specify numeric output parameters. + + Setting this property to a value other than the value in the database depends on the implementation of the data provider and may return an error code, truncate, or round data. + + When using SQL Server Native Client 10 (or later), to bind a parameter whose type is `Decimal`, `Numeric`, `VarNumeric`, `DBDate`, or `DBTimeStamp`, you must manually specify an appropriate scale value. + > [!NOTE] -> Use of this property to coerce data passed to the database is not supported. To round, truncate, or otherwise coerce data before passing it to the database, use the class that is part of the `System` namespace prior to assigning a value to the parameter's `Value` property. - +> Use of this property to coerce data passed to the database is not supported. To round, truncate, or otherwise coerce data before passing it to the database, use the class that is part of the `System` namespace prior to assigning a value to the parameter's `Value` property. + > [!NOTE] -> .NET Framework data providers that are included with the .NET Framework version 1.0 do not verify the or of parameter values. This can cause truncated data to be inserted at the data source. If you are using .NET Framework version 1.0, validate the and of values before setting the parameter value. values that exceed the parameter scale are still truncated. - - - -## Examples - The following example creates an and sets some of its properties. - -```vb -Public Sub CreateOleDbParameter() - Dim parameter As New OleDbParameter("Price", OleDbType.Decimal) - parameter.Value = 3.1416 - parameter.Precision = 8 - parameter.Scale = 4 -End Sub 'CreateOleDbParameter -``` - -```csharp -public void CreateOleDbParameter() - { - OleDbParameter parameter = new OleDbParameter("Price", OleDbType.Decimal); - parameter.Value = 3.1416; - parameter.Precision = 8; - parameter.Scale = 4; - } -``` - +> .NET Framework data providers that are included with the .NET Framework version 1.0 do not verify the or of parameter values. This can cause truncated data to be inserted at the data source. If you are using .NET Framework version 1.0, validate the and of values before setting the parameter value. values that exceed the parameter scale are still truncated. + + + +## Examples + The following example creates an and sets some of its properties. + +```vb +Public Sub CreateOleDbParameter() + Dim parameter As New OleDbParameter("Price", OleDbType.Decimal) + parameter.Value = 3.1416 + parameter.Precision = 8 + parameter.Scale = 4 +End Sub 'CreateOleDbParameter +``` + +```csharp +public void CreateOleDbParameter() + { + OleDbParameter parameter = new OleDbParameter("Price", OleDbType.Decimal); + parameter.Value = 3.1416; + parameter.Precision = 8; + parameter.Scale = 4; + } +``` + ]]> Working with Commands @@ -1122,49 +1122,49 @@ public void CreateOleDbParameter() Gets or sets the maximum size, in bytes, of the data within the column. The maximum size, in bytes, of the data within the column. The default value is inferred from the parameter value. - property is used for binary and string types. - - For nonstring data types and ANSI string data, the property refers to the number of bytes. For Unicode string data, refers to the number of characters. The count for strings does not include the terminating character. - - For variable-length data types, describes the maximum amount of data to transmit to the server. For example, for a Unicode string value, could be used to limit the amount of data sent to the server to the first 100 characters. - - For bidirectional and output parameters, and return values, you must set the value of . This is not required for input parameters, and if not explicitly set, the value of is inferred from the actual size of the specified parameter when a parameterized statement is executed. - - The , , and properties of a parameter can be inferred by setting . Therefore, you are not required to specify them. However, they are not exposed in property settings. For example, if the size of the parameter has been inferred, does not contain the inferred value after statement execution. - - For fixed-length data types, the value of is ignored. It can be retrieved for informational purposes, and returns the maximum amount of bytes the provider uses when transmitting the value of the parameter to the server. - - If the size of the value supplied for an exceeds the specified , the of the contains the specified value, truncated to the size of the . - - - -## Examples - The following example creates an and sets some of its properties. - -```vb -Public Sub CreateOleDbParameter() - Dim myValue As String = "12 foot scarf - multiple colors, one previous owner" - Dim parameter As New OleDbParameter("Description", OleDbType.VarChar) - parameter.Direction = ParameterDirection.Output - parameter.Size = myValue.Length - parameter.Value = myValue -End Sub 'CreateOleDbParameter -``` - -```csharp -public void CreateOleDbParameter() - { - string myValue = "12 foot scarf - multiple colors, one previous owner"; - OleDbParameter parameter = new OleDbParameter("Description", OleDbType.VarChar); - parameter.Direction = ParameterDirection.Output; - parameter.Size = myValue.Length; - parameter.Value = myValue; - } -``` - + property is used for binary and string types. + + For nonstring data types and ANSI string data, the property refers to the number of bytes. For Unicode string data, refers to the number of characters. The count for strings does not include the terminating character. + + For variable-length data types, describes the maximum amount of data to transmit to the server. For example, for a Unicode string value, could be used to limit the amount of data sent to the server to the first 100 characters. + + For bidirectional and output parameters, and return values, you must set the value of . This is not required for input parameters, and if not explicitly set, the value of is inferred from the actual size of the specified parameter when a parameterized statement is executed. + + The , , and properties of a parameter can be inferred by setting . Therefore, you are not required to specify them. However, they are not exposed in property settings. For example, if the size of the parameter has been inferred, does not contain the inferred value after statement execution. + + For fixed-length data types, the value of is ignored. It can be retrieved for informational purposes, and returns the maximum amount of bytes the provider uses when transmitting the value of the parameter to the server. + + If the size of the value supplied for an exceeds the specified , the of the contains the specified value, truncated to the size of the . + + + +## Examples + The following example creates an and sets some of its properties. + +```vb +Public Sub CreateOleDbParameter() + Dim myValue As String = "12 foot scarf - multiple colors, one previous owner" + Dim parameter As New OleDbParameter("Description", OleDbType.VarChar) + parameter.Direction = ParameterDirection.Output + parameter.Size = myValue.Length + parameter.Value = myValue +End Sub 'CreateOleDbParameter +``` + +```csharp +public void CreateOleDbParameter() + { + string myValue = "12 foot scarf - multiple colors, one previous owner"; + OleDbParameter parameter = new OleDbParameter("Description", OleDbType.VarChar); + parameter.Direction = ParameterDirection.Output; + parameter.Size = myValue.Length; + parameter.Value = myValue; + } +``` + ]]> Working with Commands @@ -1215,33 +1215,33 @@ public void CreateOleDbParameter() Gets or sets the name of the source column mapped to the and used for loading or returning the . The name of the source column mapped to the . The default is an empty string. - is set to anything other than an empty string, the value of the parameter is retrieved from the column with the name. If is set to `Input`, the value is taken from the . If is set to `Output`, the value is taken from the data source. A of `InputOutput` is a combination of both. - - For more information about how to use the property, see [DataAdapter Parameters](/dotnet/framework/data/adonet/dataadapter-parameters) and [Updating Data Sources with DataAdapters](/dotnet/framework/data/adonet/updating-data-sources-with-dataadapters). - - - -## Examples - The following example creates an and sets some of its properties. - -```vb -Public Sub CreateOleDbParameter() - Dim parameter As New OleDbParameter("Description", OleDbType.VarChar, 88) - parameter.SourceColumn = "Description" -End Sub 'CreateOleDbParameter -``` - -```csharp -public void CreateOleDbParameter() - { - OleDbParameter parameter = new OleDbParameter("Description", OleDbType.VarChar, 88); - parameter.SourceColumn = "Description"; - } -``` - + is set to anything other than an empty string, the value of the parameter is retrieved from the column with the name. If is set to `Input`, the value is taken from the . If is set to `Output`, the value is taken from the data source. A of `InputOutput` is a combination of both. + + For more information about how to use the property, see [DataAdapter Parameters](/dotnet/framework/data/adonet/dataadapter-parameters) and [Updating Data Sources with DataAdapters](/dotnet/framework/data/adonet/updating-data-sources-with-dataadapters). + + + +## Examples + The following example creates an and sets some of its properties. + +```vb +Public Sub CreateOleDbParameter() + Dim parameter As New OleDbParameter("Description", OleDbType.VarChar, 88) + parameter.SourceColumn = "Description" +End Sub 'CreateOleDbParameter +``` + +```csharp +public void CreateOleDbParameter() + { + OleDbParameter parameter = new OleDbParameter("Description", OleDbType.VarChar, 88); + parameter.SourceColumn = "Description"; + } +``` + ]]> Working with Commands @@ -1272,26 +1272,26 @@ public void CreateOleDbParameter() if the source column is nullable; if it is not. - is used by the to correctly generate update commands when dealing with nullable columns. Generally, use of is limited to developers inheriting from . - - uses this property to determine whether the source column is nullable, and sets this property to `true` if it is nullable, and `false` if it is not. When is generating its Update statement, it examines the for each parameter. If the property is `true`, generates a WHERE clauses like the following (in this query expression, "FieldName" represents the name of the field): - -``` -((@IsNull_FieldName = 1 AND FieldName IS NULL) OR - (FieldName = @Original_FieldName)) -``` - - If for the field is false, generates the following WHERE clause: - -``` -FieldName = @OriginalFieldName -``` - - In addition, @IsNull_FieldName contains 1 if the source field contains null, and 0 if it does not. This mechanism allows for a performance optimization in SQL Server, and provides for common code that works across multiple providers. - + is used by the to correctly generate update commands when dealing with nullable columns. Generally, use of is limited to developers inheriting from . + + uses this property to determine whether the source column is nullable, and sets this property to `true` if it is nullable, and `false` if it is not. When is generating its Update statement, it examines the for each parameter. If the property is `true`, generates a WHERE clauses like the following (in this query expression, "FieldName" represents the name of the field): + +``` +((@IsNull_FieldName = 1 AND FieldName IS NULL) OR + (FieldName = @Original_FieldName)) +``` + + If for the field is false, generates the following WHERE clause: + +``` +FieldName = @OriginalFieldName +``` + + In addition, @IsNull_FieldName contains 1 if the source field contains null, and 0 if it does not. This mechanism allows for a performance optimization in SQL Server, and provides for common code that works across multiple providers. + ]]> Working with Commands @@ -1338,33 +1338,33 @@ FieldName = @OriginalFieldName Gets or sets the to use when you load . One of the values. The default is . - during an update operation to determine whether the parameter value is set to `Current` or `Original`. This lets primary keys be updated. This property is set to the version of the used by the property, or the method of the object. - - - -## Examples - The following example creates an and sets some of its properties. - -```vb -Public Sub CreateOleDbParameter() - Dim parameter As New OleDbParameter("Description", OleDbType.VarChar, 88) - parameter.SourceColumn = "Description" - parameter.SourceVersion = DataRowVersion.Current -End Sub -``` - -```csharp -public void CreateOleDbParameter() - { - OleDbParameter parameter = new OleDbParameter("Description", OleDbType.VarChar, 88); - parameter.SourceColumn = "Description"; - parameter.SourceVersion = DataRowVersion.Current; - } -``` - + during an update operation to determine whether the parameter value is set to `Current` or `Original`. This lets primary keys be updated. This property is set to the version of the used by the property, or the method of the object. + + + +## Examples + The following example creates an and sets some of its properties. + +```vb +Public Sub CreateOleDbParameter() + Dim parameter As New OleDbParameter("Description", OleDbType.VarChar, 88) + parameter.SourceColumn = "Description" + parameter.SourceVersion = DataRowVersion.Current +End Sub +``` + +```csharp +public void CreateOleDbParameter() + { + OleDbParameter parameter = new OleDbParameter("Description", OleDbType.VarChar, 88); + parameter.SourceColumn = "Description"; + parameter.SourceVersion = DataRowVersion.Current; + } +``` + ]]> The property was not set to one of the values. @@ -1401,11 +1401,11 @@ public void CreateOleDbParameter() For a description of this member, see . A new that is a copy of this instance. - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1489,39 +1489,39 @@ public void CreateOleDbParameter() Gets or sets the value of the parameter. An that is the value of the parameter. The default value is null. - that is sent to the server. For output and return value parameters, the value is set on completion of the and after the is closed. - - When you send a null parameter value to the server, you must specify , not null. The null value in the system is an empty object that has no value. is used to represent null values. - - If the application specifies the database type, the bound value is converted to that type when the provider sends the data to the server. The provider tries to convert any type of value if it supports the interface. Conversion errors may result if the specified type is not compatible with the value. - - Both the and properties can be inferred by setting the Value. - - The property is overwritten by the Update method of . - - - -## Examples - The following example creates an and sets some of its properties. - -```vb -Public Sub CreateOleDbParameter() - Dim parameter As New OleDbParameter("Description", OleDbType.VarChar, 88) - parameter.Value = "garden hose" -End Sub 'CreateOleDbParameter -``` - -```csharp -public void CreateOleDbParameter() - { - OleDbParameter parameter = new OleDbParameter("Description", OleDbType.VarChar, 88); - parameter.Value = "garden hose"; - } -``` - + that is sent to the server. For output and return value parameters, the value is set on completion of the and after the is closed. + + When you send a null parameter value to the server, you must specify , not null. The null value in the system is an empty object that has no value. is used to represent null values. + + If the application specifies the database type, the bound value is converted to that type when the provider sends the data to the server. The provider tries to convert any type of value if it supports the interface. Conversion errors may result if the specified type is not compatible with the value. + + Both the and properties can be inferred by setting the Value. + + The property is overwritten by the Update method of . + + + +## Examples + The following example creates an and sets some of its properties. + +```vb +Public Sub CreateOleDbParameter() + Dim parameter As New OleDbParameter("Description", OleDbType.VarChar, 88) + parameter.Value = "garden hose" +End Sub 'CreateOleDbParameter +``` + +```csharp +public void CreateOleDbParameter() + { + OleDbParameter parameter = new OleDbParameter("Description", OleDbType.VarChar, 88); + parameter.Value = "garden hose"; + } +``` + ]]> Working with Commands diff --git a/xml/System.Data.OracleClient/OracleBoolean.xml b/xml/System.Data.OracleClient/OracleBoolean.xml index c574441480d..8d95d5e959c 100644 --- a/xml/System.Data.OracleClient/OracleBoolean.xml +++ b/xml/System.Data.OracleClient/OracleBoolean.xml @@ -22,13 +22,13 @@ Represents the value returned from a database comparison operation between Oracle data types, and exposes methods used to perform data type conversions. - structure and a standard **Boolean** value is that, where a standard `Boolean` has two possible values, `true` and `false`, an structure has three possible values, , , or . - - An structure does not map to an Oracle `Boolean` data type; it is exposed as a convenience support class. - + structure and a standard **Boolean** value is that, where a standard `Boolean` has two possible values, `true` and `false`, an structure has three possible values, , , or . + + An structure does not map to an Oracle `Boolean` data type; it is exposed as a convenience support class. + ]]> @@ -86,11 +86,11 @@ The to be used as the initial value of the structure. Initializes a new instance of the structure using the specified integer. - is `false`; otherwise it is `true`. - + is `false`; otherwise it is `true`. + ]]> @@ -120,10 +120,10 @@ An structure. An structure. Computes the bitwise AND of two specified structures. - The result of the logical AND operation as shown in the following table. - - Value of Value of Result - + The result of the logical AND operation as shown in the following table. + + Value of Value of Result + To be added. @@ -154,31 +154,31 @@ An object to compare, or a null reference ( in Visual Basic). Compares this structure to a specified object and returns an indication of their relative values. - A signed number indicating the relative values of the instance and value. - - Value - - Description - - A negative integer - - This instance is less than . - - Zero - - This instance is equal to . - - A positive integer - - This instance is greater than , or is a null reference ( in Visual Basic). - + A signed number indicating the relative values of the instance and value. + + Value + + Description + + A negative integer + + This instance is less than . + + Zero + + This instance is equal to . + + A positive integer + + This instance is greater than , or is a null reference ( in Visual Basic). + - , regardless of its value, is considered greater than a null reference (`Nothing` in Visual Basic). - + , regardless of its value, is considered greater than a null reference (`Nothing` in Visual Basic). + ]]> @@ -269,11 +269,11 @@ Represents a false value that can be assigned to the property of an instance of the structure. - field is an structure constant. - + field is an structure constant. + ]]> @@ -328,11 +328,11 @@ if is , otherwise . - is , this property still is `false`. - + is , this property still is `false`. + ]]> @@ -388,11 +388,11 @@ if is ; otherwise, . - is , this property still is `false`. - + is , this property still is `false`. + ]]> @@ -449,11 +449,11 @@ Represents a null value that can be assigned to the property of an instance of the structure. - field is an structure constant. - + field is an structure constant. + ]]> @@ -481,11 +481,11 @@ Represents a value of one that can be assigned to the property of an instance of the structure. - field is an structure constant. - + field is an structure constant. + ]]> @@ -542,10 +542,10 @@ An structure. An structure. Computes the bitwise AND of two specified structures. - The result of the logical AND operation as shown in the following table. - - Value of Value of Result - + The result of the logical AND operation as shown in the following table. + + Value of Value of Result + ]]> @@ -577,10 +577,10 @@ An structure. An structure. Computes the bitwise OR of its two operands. - The result of the bitwise OR operation as shown in the following table. - - Value of Value of Result - + The result of the bitwise OR operation as shown in the following table. + + Value of Value of Result + ]]> @@ -643,10 +643,10 @@ An structure. An structure. Performs a bitwise exclusive-OR operation on the supplied parameters. - The results of the bitwise XOR operation as shown in the following table. - - Value of Value of Result - + The results of the bitwise XOR operation as shown in the following table. + + Value of Value of Result + ]]> @@ -715,11 +715,11 @@ Converts the parameter to an structure. A new structure whose value equals the property of the parameter. - is 0, the value of is `false`; otherwise, the value of the is `true`. - + is 0, the value of is `false`; otherwise, the value of the is `true`. + ]]> @@ -950,10 +950,10 @@ An structure. An structure. Performs a bitwise OR operation on the two specified structures. - The result of the bitwise OR operation as shown in the following table. - - Value of Value of Result - + The result of the bitwise OR operation as shown in the following table. + + Value of Value of Result + To be added. @@ -1029,11 +1029,11 @@ Represents a true value that can be assigned to the property of an instance of the structure. - field is an structure constant. - + field is an structure constant. + ]]> @@ -1095,10 +1095,10 @@ An structure. An structure. Performs a bitwise exclusive-OR operation on the supplied parameters. - The results of the logical XOR operation as shown in the following table. - - Value of Value of Result - + The results of the logical XOR operation as shown in the following table. + + Value of Value of Result + To be added. @@ -1123,11 +1123,11 @@ Represents a value of zero that can be assigned to the property of an instance of the structure. - field is an structure constant. - + field is an structure constant. + ]]> diff --git a/xml/System.Data.OracleClient/OracleLob.xml b/xml/System.Data.OracleClient/OracleLob.xml index 50bf01f1ea0..3a1987684fc 100644 --- a/xml/System.Data.OracleClient/OracleLob.xml +++ b/xml/System.Data.OracleClient/OracleLob.xml @@ -28,87 +28,87 @@ Represents a large object binary () data type stored on an Oracle server. This class cannot be inherited. - differs from an in that the data is stored on the server instead of in a physical file in the operating system. It can also be a read-write object, unlike an , which is always read-only. - - An may be one of these data types. - -|OracleType data type|Description| -|--------------------------|-----------------| -|`Blob`|An Oracle `BLOB` data type that contains binary data with a maximum size of 4 gigabytes (GB). This maps to an of type .| -|`Clob`|An Oracle `CLOB` data type that contains character data, based on the default character set on the server, with a maximum size of 4 GB. This maps to .| -|`NClob`|An Oracle `NCLOB` data type that contains character data, based on the national character set on the server with a maximum size of 4 GB. This maps to .| - - A .NET application developer can retrieve the Oracle `LOB` values into basic .NET data types, such as of type and , or the specialized data type. The class supports reading data from and writing to the Oracle `LOB` in the Oracle database. - - The following are the main characteristics of an data type that distinguish it from basic .NET data types: - -- After you retrieve the Oracle `LOB` value from the Oracle database into the class, you can change the `LOB` data in an open transaction and your changes are directly reflected to the database. If you retrieve the Oracle `LOB` value into an of type or and update these arrays, your changes are not reflected to the database. - -- When you use the class to access a chunk of a `LOB` value, only that chunk is passed from the Oracle database to the client. When you use the method to access a chunk of a `LOB` value, the entire contents of the value are passed from the Oracle database to the client. - - To obtain an object, call the method. - - You can construct an that is NULL using this format: - + differs from an in that the data is stored on the server instead of in a physical file in the operating system. It can also be a read-write object, unlike an , which is always read-only. + + An may be one of these data types. + +|OracleType data type|Description| +|--------------------------|-----------------| +|`Blob`|An Oracle `BLOB` data type that contains binary data with a maximum size of 4 gigabytes (GB). This maps to an of type .| +|`Clob`|An Oracle `CLOB` data type that contains character data, based on the default character set on the server, with a maximum size of 4 GB. This maps to .| +|`NClob`|An Oracle `NCLOB` data type that contains character data, based on the national character set on the server with a maximum size of 4 GB. This maps to .| + + A .NET application developer can retrieve the Oracle `LOB` values into basic .NET data types, such as of type and , or the specialized data type. The class supports reading data from and writing to the Oracle `LOB` in the Oracle database. + + The following are the main characteristics of an data type that distinguish it from basic .NET data types: + +- After you retrieve the Oracle `LOB` value from the Oracle database into the class, you can change the `LOB` data in an open transaction and your changes are directly reflected to the database. If you retrieve the Oracle `LOB` value into an of type or and update these arrays, your changes are not reflected to the database. + +- When you use the class to access a chunk of a `LOB` value, only that chunk is passed from the Oracle database to the client. When you use the method to access a chunk of a `LOB` value, the entire contents of the value are passed from the Oracle database to the client. + + To obtain an object, call the method. + + You can construct an that is NULL using this format: + ```csharp -OracleLob myLob = OracleLob.Null; +OracleLob myLob = OracleLob.Null; ``` ```vb Dim myLob As OracleLob = OracleLob.Null ``` - - This technique is used primarily to test whether a `LOB` returned from the server is NULL, as this example illustrates: - + + This technique is used primarily to test whether a `LOB` returned from the server is NULL, as this example illustrates: + ```csharp -if (myLob == OracleLob.Null) +if (myLob == OracleLob.Null) ``` ```vb If (myLob = OracleLob.Null) Then ``` - - A NULL `LOB` behaves similarly to a zero-byte `LOB` in that succeeds and always returns zero bytes. - - Selecting a `LOB` column that contains a null value returns . - - You must begin a transaction before obtaining a temporary `LOB`. Otherwise, the may fail to obtain data later. - - You can also open a temporary `LOB` in Oracle by calling the DBMS_LOB.CREATETEMPORARY system stored procedure and binding a `LOB` output parameter. On the client side, a temporary `LOB` behaves like a table-based `LOB`. For example, to update the temporary `LOB`, it must be enclosed in a transaction. - + + A NULL `LOB` behaves similarly to a zero-byte `LOB` in that succeeds and always returns zero bytes. + + Selecting a `LOB` column that contains a null value returns . + + You must begin a transaction before obtaining a temporary `LOB`. Otherwise, the may fail to obtain data later. + + You can also open a temporary `LOB` in Oracle by calling the DBMS_LOB.CREATETEMPORARY system stored procedure and binding a `LOB` output parameter. On the client side, a temporary `LOB` behaves like a table-based `LOB`. For example, to update the temporary `LOB`, it must be enclosed in a transaction. + The following example demonstrates how to open a temporary `LOB`: - + ```csharp -var connection = new OracleConnection("server=MyServer; integrated security=yes;"); -connection.Open(); -OracleTransaction transaction = connection.BeginTransaction(); -OracleCommand command = connection.CreateCommand(); -command.Transaction = transaction; -command.CommandText = "declare xx blob; begin dbms_lob.createtemporary(xx, false, 0); :tempblob := xx; end;"; -command.Parameters.Add(new OracleParameter("tempblob", OracleType.Blob)).Direction = ParameterDirection.Output; -command.ExecuteNonQuery(); -var tempLob = (OracleLob)command.Parameters[0].Value; -var tempbuff = new byte[10000]; -tempLob.BeginBatch(OracleLobOpenMode.ReadWrite); -tempLob.Write(tempbuff,0,tempbuff.Length); -tempLob.EndBatch(); -command.Parameters.Clear(); -command.CommandText = "MyTable.MyProc"; -command.CommandType = CommandType.StoredProcedure; -command.Parameters.Add(new OracleParameter("ImportDoc", OracleType.Blob)).Value = tempLob; -command.ExecuteNonQuery(); -transaction.Commit(); -connection.Close(); -``` - +var connection = new OracleConnection("server=MyServer; integrated security=yes;"); +connection.Open(); +OracleTransaction transaction = connection.BeginTransaction(); +OracleCommand command = connection.CreateCommand(); +command.Transaction = transaction; +command.CommandText = "declare xx blob; begin dbms_lob.createtemporary(xx, false, 0); :tempblob := xx; end;"; +command.Parameters.Add(new OracleParameter("tempblob", OracleType.Blob)).Direction = ParameterDirection.Output; +command.ExecuteNonQuery(); +var tempLob = (OracleLob)command.Parameters[0].Value; +var tempbuff = new byte[10000]; +tempLob.BeginBatch(OracleLobOpenMode.ReadWrite); +tempLob.Write(tempbuff,0,tempbuff.Length); +tempLob.EndBatch(); +command.Parameters.Clear(); +command.CommandText = "MyTable.MyProc"; +command.CommandType = CommandType.StoredProcedure; +command.Parameters.Add(new OracleParameter("ImportDoc", OracleType.Blob)).Value = tempLob; +command.ExecuteNonQuery(); +transaction.Commit(); +connection.Close(); +``` + > [!NOTE] -> The inherited method fails if used with character data, and an is thrown. Use the method instead. -> -> Temporary `LOB`s are only closed when the connection is closed, but with pooling and under load, temporary `LOB`s do not close. This can be resolved by disposing the temporary `LOB`, by invoking `tempLob.Dispose()`. - +> The inherited method fails if used with character data, and an is thrown. Use the method instead. +> +> Temporary `LOB`s are only closed when the connection is closed, but with pooling and under load, temporary `LOB`s do not close. This can be resolved by disposing the temporary `LOB`, by invoking `tempLob.Dispose()`. + ]]> @@ -137,18 +137,18 @@ connection.Close(); The from which to append data. Appends data from the specified to the current . - , the destination must also be an . - + , the destination must also be an . + > [!NOTE] -> In this release, a write operation to a read-only `LOB` might succeed, but does not update the `LOB` on the server. In this case, however, the local copy of the `LOB` is updated. Therefore, later read operations on the object might return the results of the write operation. - +> In this release, a write operation to a read-only `LOB` might succeed, but does not update the `LOB` on the server. In this case, however, the local copy of the `LOB` is updated. Therefore, later read operations on the object might return the results of the write operation. + ]]> The source is null. @@ -187,13 +187,13 @@ connection.Close(); Prevents server-side triggers from firing while performing multiple read operations. - mode; therefore, the `LOB` can only be read from, not written to, until the corresponding call to . To perform batch writes to the `LOB`, call with . - - Calling more than one time within the same transaction currently throws the Oracle "ORA-22293: LOB already opened in the same transaction" error. In addition, if you obtain the `LOB` using another , and the original caller has not called the method, the same error is generated. Therefore, you must call the method when you are finished using the . - + mode; therefore, the `LOB` can only be read from, not written to, until the corresponding call to . To perform batch writes to the `LOB`, call with . + + Calling more than one time within the same transaction currently throws the Oracle "ORA-22293: LOB already opened in the same transaction" error. In addition, if you obtain the `LOB` using another , and the original caller has not called the method, the same error is generated. Therefore, you must call the method when you are finished using the . + ]]> The connection is closed. @@ -225,13 +225,13 @@ connection.Close(); Mode (one of the values) in which the can be accessed between this call and the corresponding call. Prevents server-side triggers from firing while performing multiple read and write operations in the specified access mode. - more than one time within the same transaction currently throws the Oracle "ORA-22293: LOB already opened in the same transaction" error. In addition, if you obtain the `LOB` using another , and the original caller has not called the method, the same error is generated. Therefore, you must call the method when you are finished using the . - + more than one time within the same transaction currently throws the Oracle "ORA-22293: LOB already opened in the same transaction" error. In addition, if you obtain the `LOB` using another , and the original caller has not called the method, the same error is generated. Therefore, you must call the method when you are finished using the . + ]]> The connection is closed. @@ -308,11 +308,11 @@ connection.Close(); Always returns true, regardless of whether the supports writing or not. Always returns , regardless of whether an opened or undisposed supports writing or not, if a is closed or disposed. - @@ -338,11 +338,11 @@ connection.Close(); Gets a value indicating the minimum number of bytes to retrieve from or send to the server during a read/write operation. The minimum number of bytes to retrieve or send. - property is not a setting of the .NET Framework Data Provider for Oracle. Instead, it is the value that the Oracle Call Interface (OCI) uses when communicating with the server. Use to ensure that client-side chunks are the same size. Reading or writing in smaller chunks does not cache data, and causes a less-optimized round trip to the server, because a full packet is not received or sent. - + property is not a setting of the .NET Framework Data Provider for Oracle. Instead, it is the value that the Oracle Call Interface (OCI) uses when communicating with the server. Use to ensure that client-side chunks are the same size. Reading or writing in smaller chunks does not cache data, and causes a less-optimized round trip to the server, because a full packet is not received or sent. + ]]> The connection is closed. @@ -375,11 +375,11 @@ connection.Close(); Creates a new object that references the same Oracle as the original object. A new object that references the same Oracle as the original object. - object initially have the same values as those of the original object. However, after the is complete, each object is independent from the other. For example, changing the value of the property on the original does not change the value of on the copy. - + object initially have the same values as those of the original object. However, after the is complete, each object is independent from the other. For example, changing the value of the property on the original does not change the value of on the copy. + ]]> The connection is closed. @@ -466,20 +466,20 @@ connection.Close(); Copies from this to a destination . The number of bytes copied. This excludes any padded bytes. - , the destination must also be an . - - If the destination offset is beyond the end of destination `LOB`, the `LOB` to which the data is being copied is extended. The space between the end of the `LOB` and the destination offset beyond the end is padded with zeros for `BLOB` data types and spaces for `CLOB` and `NCLOB` data types. - - To write to the `LOB`, you must have retrieved the `LOB` using the FOR UPDATE clause in the SQL SELECT statement, and you must have a local transaction started. - + , the destination must also be an . + + If the destination offset is beyond the end of destination `LOB`, the `LOB` to which the data is being copied is extended. The space between the end of the `LOB` and the destination offset beyond the end is padded with zeros for `BLOB` data types and spaces for `CLOB` and `NCLOB` data types. + + To write to the `LOB`, you must have retrieved the `LOB` using the FOR UPDATE clause in the SQL SELECT statement, and you must have a local transaction started. + > [!NOTE] -> In this release, a write operation to a read-only `LOB` might succeed, but not update the `LOB` on the server. In this case, however, the local copy of the `LOB` will be updated. Therefore, later read operations on the object might return the results of the write operation. -> -> The `CopyTo` method does not clear the contents of the destination `OracleLob` before performing the copy operation. - +> In this release, a write operation to a read-only `LOB` might succeed, but not update the `LOB` on the server. In this case, however, the local copy of the `LOB` will be updated. Therefore, later read operations on the object might return the results of the write operation. +> +> The `CopyTo` method does not clear the contents of the destination `OracleLob` before performing the copy operation. + ]]> The specified in the parameter is null. @@ -515,31 +515,31 @@ connection.Close(); Copies from this to a destination with the specified amount of data. The number of bytes copied. This excludes any padded bytes. - , the destination must also be an . - - If the destination offset is beyond the end of destination `LOB`, the `LOB` to which the data is being copied is extended. The space between the end of `LOB` and destination offset beyond the end is padded with zeros for `BLOB` data types and spaces for `CLOB` and `NCLOB` data types. - - To write to the `LOB`, you must have retrieved the `LOB` using the FOR UPDATE clause in the SQL SELECT statement, and you must have a local transaction started. - + , the destination must also be an . + + If the destination offset is beyond the end of destination `LOB`, the `LOB` to which the data is being copied is extended. The space between the end of `LOB` and destination offset beyond the end is padded with zeros for `BLOB` data types and spaces for `CLOB` and `NCLOB` data types. + + To write to the `LOB`, you must have retrieved the `LOB` using the FOR UPDATE clause in the SQL SELECT statement, and you must have a local transaction started. + > [!NOTE] -> In this release, a write operation to a read-only `LOB` might succeed, but does not update the `LOB` on the server. In this case, however, the local copy of the `LOB` is updated. Therefore, later read operations on the object might return the results of the write operation. -> -> The `CopyTo` method does not clear the contents of the destination `OracleLob` before performing the copy operation. - +> In this release, a write operation to a read-only `LOB` might succeed, but does not update the `LOB` on the server. In this case, however, the local copy of the `LOB` is updated. Therefore, later read operations on the object might return the results of the write operation. +> +> The `CopyTo` method does not clear the contents of the destination `OracleLob` before performing the copy operation. + ]]> The specified in the parameter is full. - A value specified in the parameter is less than zero or greater than 4 gigabytes. - - -or- - - A value specified in the parameter for a or data type is not even. - - -or- - + A value specified in the parameter is less than zero or greater than 4 gigabytes. + + -or- + + A value specified in the parameter for a or data type is not even. + + -or- + You must specify and data types as an even number of bytes. The operation is not within a transaction, the object is null, or the connection is closed. An Oracle error has occurred. @@ -577,27 +577,27 @@ connection.Close(); Copies from this to a destination with the specified amount of data, and the source offset. The number of bytes copied. This excludes any padded bytes. - , the destination must also be an . - - If the destination offset is beyond the end of destination `LOB`, the `LOB` to which the data is being copied is extended. The space between the end of `LOB` and destination offset beyond the end is padded with zeros for `BLOB` data types and spaces for `CLOB` and `NCLOB` data types. - - To write to the `LOB`, you must have retrieved the `LOB` using the FOR UPDATE clause in the SQL SELECT statement, and you must have a local transaction started. - + , the destination must also be an . + + If the destination offset is beyond the end of destination `LOB`, the `LOB` to which the data is being copied is extended. The space between the end of `LOB` and destination offset beyond the end is padded with zeros for `BLOB` data types and spaces for `CLOB` and `NCLOB` data types. + + To write to the `LOB`, you must have retrieved the `LOB` using the FOR UPDATE clause in the SQL SELECT statement, and you must have a local transaction started. + > [!NOTE] -> In this release, a write operation to a read-only `LOB` might succeed, but does not update the `LOB` on the server. In this case, however, the local copy of the `LOB` is updated. Therefore, later read operations on the object might return the results of the write operation. -> -> The `CopyTo` method does not clear the contents of the destination `OracleLob` before performing the copy operation. - +> In this release, a write operation to a read-only `LOB` might succeed, but does not update the `LOB` on the server. In this case, however, the local copy of the `LOB` is updated. Therefore, later read operations on the object might return the results of the write operation. +> +> The `CopyTo` method does not clear the contents of the destination `OracleLob` before performing the copy operation. + ]]> The specified in the parameter is full. - A value specified in the , , or parameter is less than zero or greater than 4 gigabytes. - - -or- - + A value specified in the , , or parameter is less than zero or greater than 4 gigabytes. + + -or- + A value specified in the , , or parameter for a or data type is not even. The operation is not within a transaction, the object is null, or the connection is closed. An Oracle error has occurred. @@ -673,11 +673,11 @@ connection.Close(); Allows server-side triggers to resume firing after performing multiple write operations. - method before you begin performing write operations on the . - + method before you begin performing write operations on the . + ]]> The connection is closed. @@ -716,16 +716,16 @@ connection.Close(); Erases all data from this . The number of bytes erased. - does not truncate data. The `LOB` length remains the same for a `BLOB` data type, and the erased data is replaced by 0x00. `CLOB` and `NCLOB` data types are replaced by spaces. - - To write to the `LOB`, you must have retrieved the `LOB` using the FOR UPDATE clause in the SQL SELECT statement, and you must have a local transaction started. - + does not truncate data. The `LOB` length remains the same for a `BLOB` data type, and the erased data is replaced by 0x00. `CLOB` and `NCLOB` data types are replaced by spaces. + + To write to the `LOB`, you must have retrieved the `LOB` using the FOR UPDATE clause in the SQL SELECT statement, and you must have a local transaction started. + > [!NOTE] -> In this release, a write operation to a read-only `LOB` might succeed, but does not update the `LOB` on the server. In this case, however, the local copy of the `LOB` is updated. Therefore, later read operations on the object might return the results of the write operation. - +> In this release, a write operation to a read-only `LOB` might succeed, but does not update the `LOB` on the server. In this case, however, the local copy of the `LOB` is updated. Therefore, later read operations on the object might return the results of the write operation. + ]]> The operation is not within a transaction, the object is null, or the connection is closed. @@ -760,18 +760,18 @@ connection.Close(); Erases the specified amount of data from this . The number of bytes erased. - . Therefore, specifying a value greater than that returned by the property succeeds; however only erases to the end of the . (Similarly, if a negative value is passed to `offset`, will succeed, but only erase starting from the beginning of the .) This behavior is different from that of the and methods, and offers the advantage of being able to erase all data from the value specified by `offset` without making an additional roundtrip to the server to verify the actual size. - - does not truncate data. The `LOB` length remains the same for a `BLOB` data type, and the erased data is replaced by 0x00. `CLOB` and `NCLOB` data types are replaced by spaces. - - To write to the `LOB`, you must have retrieved the `LOB` using the FOR UPDATE clause in the SQL SELECT statement, and you must have a local transaction started. - + . Therefore, specifying a value greater than that returned by the property succeeds; however only erases to the end of the . (Similarly, if a negative value is passed to `offset`, will succeed, but only erase starting from the beginning of the .) This behavior is different from that of the and methods, and offers the advantage of being able to erase all data from the value specified by `offset` without making an additional roundtrip to the server to verify the actual size. + + does not truncate data. The `LOB` length remains the same for a `BLOB` data type, and the erased data is replaced by 0x00. `CLOB` and `NCLOB` data types are replaced by spaces. + + To write to the `LOB`, you must have retrieved the `LOB` using the FOR UPDATE clause in the SQL SELECT statement, and you must have a local transaction started. + > [!NOTE] -> In this release, a write operation to a read-only `LOB` might succeed, but does not update the `LOB` on the server. In this case, however, the local copy of the `LOB` is updated. Therefore, later read operations on the object might return the results of the write operation. - +> In this release, a write operation to a read-only `LOB` might succeed, but does not update the `LOB` on the server. In this case, however, the local copy of the `LOB` is updated. Therefore, later read operations on the object might return the results of the write operation. + ]]> The operation is not within a transaction, the object is null, or the connection is closed. @@ -800,11 +800,11 @@ connection.Close(); Not currently supported. - @@ -831,11 +831,11 @@ connection.Close(); if application called the method, otherwise . - An Oracle error has occurred. @@ -890,33 +890,33 @@ connection.Close(); if the is a temporary , otherwise . - The connection is closed. @@ -945,11 +945,11 @@ connection.Close Gets a value that returns the size of the . The size of the in bytes. - is always returned in bytes for all data types. - + is always returned in bytes for all data types. + ]]> The connection is closed. @@ -978,17 +978,17 @@ connection.Close Gets a value that returns the data type. One of the data types. - may be one of the following data types. - -|OracleType data type|Description| -|--------------------------|-----------------| -|`Blob`|An Oracle `BLOB` data type that contains binary data with a maximum size of 4 gigabytes. This maps to an of type .| -|`Clob`|An Oracle `CLOB` data type that contains character data, based on the default character set on the server, with a maximum size of 4 gigabytes. This maps to .| -|`NClob`|An Oracle `NCLOB` data type that contains character data, based on the national character set on the server with a maximum size of 4 gigabytes. This maps to .| - + may be one of the following data types. + +|OracleType data type|Description| +|--------------------------|-----------------| +|`Blob`|An Oracle `BLOB` data type that contains binary data with a maximum size of 4 gigabytes. This maps to an of type .| +|`Clob`|An Oracle `CLOB` data type that contains character data, based on the default character set on the server, with a maximum size of 4 gigabytes. This maps to .| +|`NClob`|An Oracle `NCLOB` data type that contains character data, based on the national character set on the server with a maximum size of 4 gigabytes. This maps to .| + ]]> @@ -1013,23 +1013,23 @@ connection.Close Represents a null object. - that is NULL using this format: - -``` -OracleLob myLob = OracleLOB.Null; -``` - - This technique is used primarily to test whether a `LOB` returned from the server is NULL, as this example illustrates: - -``` -If(myLob == OracleLob.Null) -``` - - A NULL `LOB` behaves similarly to a zero byte `LOB` in that succeeds and always returns zero bytes. - + that is NULL using this format: + +``` +OracleLob myLob = OracleLOB.Null; +``` + + This technique is used primarily to test whether a `LOB` returned from the server is NULL, as this example illustrates: + +``` +If(myLob == OracleLob.Null) +``` + + A NULL `LOB` behaves similarly to a zero byte `LOB` in that succeeds and always returns zero bytes. + ]]> @@ -1055,13 +1055,13 @@ If(myLob == OracleLob.Null) Gets the current read position in the stream. The current position within the stream. - property to determine whether the stream supports seeking. - - Seeking to any location beyond the length of the stream is supported. Seeking to an odd position for `CLOB` and `NCLOB` data types is also supported. For more information, see the Remarks section of the property. - + property to determine whether the stream supports seeking. + + Seeking to any location beyond the length of the stream is supported. Seeking to an odd position for `CLOB` and `NCLOB` data types is also supported. For more information, see the Remarks section of the property. + ]]> The connection is closed. @@ -1097,85 +1097,84 @@ If(myLob == OracleLob.Null) Reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read. The total number of bytes read into the buffer. This may be less than the number of bytes requested if that many bytes are not currently available, or zero (0) if the end of the stream has been reached. - method reads a maximum of `count` bytes from the current stream and stores them in `buffer` beginning at `offset`. The current position within the stream is advanced by the number of bytes read; however, if an exception occurs, the current position within the stream remains unchanged. returns the number of bytes read. The return value is zero only if the position is currently at the end of the stream. will block until at least one byte of data can be read, in the event that no data is available. returns 0 if you attempt to read from a `LOB` when the current position is at the end of `LOB`. can return fewer bytes than requested even if the end of the stream has not been reached. - - The .NET Framework Data Provider for Oracle handles all `CLOB` and `NCLOB` data as Unicode. Therefore, when accessing `CLOB` and `NCLOB` data types, you are always dealing with the number of bytes, where each character is 2 bytes. For example, if a string of text containing three characters is saved as an `NCLOB` on an Oracle server where the character set is 4 bytes per character, and you perform a `Read` operation, you specify the length of the string as 6 bytes, although it is stored as 12 bytes on the server. - - The following example demonstrates how to read objects. - + method reads a maximum of `count` bytes from the current stream and stores them in `buffer` beginning at `offset`. The current position within the stream is advanced by the number of bytes read; however, if an exception occurs, the current position within the stream remains unchanged. returns the number of bytes read. The return value is zero only if the position is currently at the end of the stream. will block until at least one byte of data can be read, in the event that no data is available. returns 0 if you attempt to read from a `LOB` when the current position is at the end of `LOB`. can return fewer bytes than requested even if the end of the stream has not been reached. + + The .NET Framework Data Provider for Oracle handles all `CLOB` and `NCLOB` data as Unicode. Therefore, when accessing `CLOB` and `NCLOB` data types, you are always dealing with the number of bytes, where each character is 2 bytes. For example, if a string of text containing three characters is saved as an `NCLOB` on an Oracle server where the character set is 4 bytes per character, and you perform a `Read` operation, you specify the length of the string as 6 bytes, although it is stored as 12 bytes on the server. + + The following example demonstrates how to read objects. + ```csharp -public static void ReadLobExample(OracleCommand command) -{ - int actual = 0; - - // Select some data. - // Table Schema: - // "CREATE TABLE TableWithLobs (a int, b BLOB, c CLOB, d NCLOB)"; - // "INSERT INTO TableWithLobs values (1, 'AA', 'AAA', N'AAAA')"; - command.CommandText = "SELECT * FROM TableWithLobs"; - OracleDataReader reader = command.ExecuteReader(); - using(reader) - { - // Obtain the first row of data. - reader.Read(); - // Obtain the LOBs (all 3 varieties). - OracleLob BLOB = reader.GetOracleLob(1); - OracleLob CLOB = reader.GetOracleLob(2); - OracleLob NCLOB = reader.GetOracleLob(3); - - // Example - Reading binary data (in chunks). - var buffer = new byte[100]; - while((actual = BLOB.Read(buffer, 0, buffer.Length)) > 0) - Console.WriteLine(BLOB.LobType + ".Read(" + buffer + ", " + buffer.Length + ") => " + actual); - - // Example - Reading CLOB/NCLOB data (in chunks). - // Note: You can read character data as raw Unicode bytes (using OracleLob.Read as in the above example). - // However, because the OracleLob object inherits directly from the.NET stream object, - // all the existing classes that manipulate streams can also be used. For example, the - // .NET StreamReader makes converting the raw bytes into actual characters easier. - var streamreader = new StreamReader(CLOB, Encoding.Unicode); - var cbuffer = new char[100]; - while((actual = streamreader.Read(cbuffer, 0, cbuffer.Length)) >0) - Console.WriteLine(CLOB.LobType + ".Read(" + new string(cbuffer, 0, actual) + ", " + cbuffer.Length + ") => " + actual); - - //Example - Reading data (all at once). - //You could use StreamReader.ReadToEnd to obtain all the string data,or simply - //call OracleLob.Value to obtain a contiguous allocation of all the data. - Console.WriteLine(NCLOB.LobType + ".Value => " + NCLOB.Value); - } -} -``` - - You can construct an that is NULL using this format: - +public static void ReadLobExample(OracleCommand command) +{ + int actual = 0; + + // Select some data. + // Table Schema: + // "CREATE TABLE TableWithLobs (a int, b BLOB, c CLOB, d NCLOB)"; + // "INSERT INTO TableWithLobs values (1, 'AA', 'AAA', N'AAAA')"; + command.CommandText = "SELECT * FROM TableWithLobs"; + OracleDataReader reader = command.ExecuteReader(); + using(reader) + { + // Obtain the first row of data. + reader.Read(); + // Obtain the LOBs (all 3 varieties). + OracleLob BLOB = reader.GetOracleLob(1); + OracleLob CLOB = reader.GetOracleLob(2); + OracleLob NCLOB = reader.GetOracleLob(3); + + // Example - Reading binary data (in chunks). + var buffer = new byte[100]; + while((actual = BLOB.Read(buffer, 0, buffer.Length)) > 0) + Console.WriteLine(BLOB.LobType + ".Read(" + buffer + ", " + buffer.Length + ") => " + actual); + + // Example - Reading CLOB/NCLOB data (in chunks). + // Note: You can read character data as raw Unicode bytes (using OracleLob.Read as in the above example). + // However, because the OracleLob object inherits directly from the.NET stream object, + // all the existing classes that manipulate streams can also be used. For example, the + // .NET StreamReader makes converting the raw bytes into actual characters easier. + var streamreader = new StreamReader(CLOB, Encoding.Unicode); + var cbuffer = new char[100]; + while((actual = streamreader.Read(cbuffer, 0, cbuffer.Length)) >0) + Console.WriteLine(CLOB.LobType + ".Read(" + new string(cbuffer, 0, actual) + ", " + cbuffer.Length + ") => " + actual); + + //Example - Reading data (all at once). + //You could use StreamReader.ReadToEnd to obtain all the string data,or simply + //call OracleLob.Value to obtain a contiguous allocation of all the data. + Console.WriteLine(NCLOB.LobType + ".Value => " + NCLOB.Value); + } +} +``` + + You can construct an that is NULL using this format: + ```csharp -OracleLob myLob = OracleLob.Null; +OracleLob myLob = OracleLob.Null; ``` - - This technique is used primarily to test whether a `LOB` returned from the server is NULL, as the following example illustrates. - + This technique is used primarily to test whether a `LOB` returned from the server is NULL, as the following example illustrates. + ```csharp -if (myLob == OracleLob.Null) -``` - - A NULL `LOB` behaves similarly to a zero byte `LOB` in that succeeds and always returns zero bytes. - +if (myLob == OracleLob.Null) +``` + + A NULL `LOB` behaves similarly to a zero byte `LOB` in that succeeds and always returns zero bytes. + ]]> The is a null reference ( in Visual Basic). - A value in the or parameter is not positive. - - -or- - - The sum of the offset and count parameters is larger than the buffer length. - - -or- - - A value specified in the or parameter is less than zero or greater than 4 gigabytes. + A value in the or parameter is not positive. + + -or- + + The sum of the offset and count parameters is larger than the buffer length. + + -or- + + A value specified in the parameter is less than zero or greater than 4 gigabytes. The operation is not within a transaction, the object is null, or the connection is closed. The object was closed or disposed. An Oracle error has occurred. @@ -1208,13 +1207,13 @@ if (myLob == OracleLob.Null) Sets the position on the current stream. The new position within the current stream. - property. - + property. + ]]> The parameter does not contain a valid value. @@ -1247,26 +1246,26 @@ if (myLob == OracleLob.Null) The desired length of the current stream in bytes. For and data types, this must be an even number. Sets the length of the stream to a value less than the current length. - stream fails, and returns "Message: ORA-22926: specified trim length is greater than current LOB value's length" from the Oracle server. - - A stream must support both writing and seeking for to function. - - The .NET Framework Data Provider for Oracle handles all `CLOB` and `NCLOB` data as Unicode. Therefore, when accessing `CLOB` and `NCLOB` data types, you are always dealing with the number of bytes, where each character is 2 bytes. For example, if a string of text containing three characters is saved as an `NCLOB` on an Oracle server where the character set is 4 bytes per character, and you perform a `SetLength` operation, you specify the length of the string as 6 bytes, although it is stored as 12 bytes on the server. - - To write to the `LOB`, you must have retrieved the `LOB` using the FOR UPDATE clause in the SQL SELECT statement, and you must have a local transaction started. - + stream fails, and returns "Message: ORA-22926: specified trim length is greater than current LOB value's length" from the Oracle server. + + A stream must support both writing and seeking for to function. + + The .NET Framework Data Provider for Oracle handles all `CLOB` and `NCLOB` data as Unicode. Therefore, when accessing `CLOB` and `NCLOB` data types, you are always dealing with the number of bytes, where each character is 2 bytes. For example, if a string of text containing three characters is saved as an `NCLOB` on an Oracle server where the character set is 4 bytes per character, and you perform a `SetLength` operation, you specify the length of the string as 6 bytes, although it is stored as 12 bytes on the server. + + To write to the `LOB`, you must have retrieved the `LOB` using the FOR UPDATE clause in the SQL SELECT statement, and you must have a local transaction started. + > [!NOTE] -> A write operation to a read-only `LOB` might succeed, but does not update the `LOB` on the server. In this case, however, the local copy of the `LOB` is updated. Therefore, later read operations on the object might return the results of the write operation. - +> A write operation to a read-only `LOB` might succeed, but does not update the `LOB` on the server. In this case, however, the local copy of the `LOB` is updated. Therefore, later read operations on the object might return the results of the write operation. + ]]> - A value specified in the parameter for a or data type is not even. - - -or- - + A value specified in the parameter for a or data type is not even. + + -or- + A value specified in the parameter is less than zero or greater than 4 gigabytes. The operation is not within a transaction, the object is null, or the connection is closed. The object was closed or disposed. @@ -1294,14 +1293,14 @@ if (myLob == OracleLob.Null) Gets the common language runtime stream value equivalent of the underlying value. For , an array of type . For and , a . For null data, . - data types, returns the entire underlying data as a contiguous array of type `Byte[]`. For and data types, returns all the data as a `String` data type. For null data, returns . By comparing the returned values, you can distinguish among empty data, null data, and data. - + data types, returns the entire underlying data as a contiguous array of type `Byte[]`. For and data types, returns all the data as a `String` data type. For null data, returns . By comparing the returned values, you can distinguish among empty data, null data, and data. + > [!NOTE] -> A benefit of using `LOB` data types is the capability to retrieve large amounts of data in chunks at the client. However, when you use , you obtain all the data for the `LOB` column as one contiguous chunk, which can significantly increase application overhead. - +> A benefit of using `LOB` data types is the capability to retrieve large amounts of data in chunks at the client. However, when you use , you obtain all the data for the `LOB` column as one contiguous chunk, which can significantly increase application overhead. + ]]> The object was closed or disposed. @@ -1336,81 +1335,81 @@ if (myLob == OracleLob.Null) The number of bytes to be written to the current stream. For and data types, this must be an even number. Writes a sequence of bytes to the current stream, and advances the current position within this stream by the number of bytes written. - objects: - + ```csharp -public static void WriteLobExample(OracleCommand command) -{ - // Note: Updating LOB data requires a transaction. - command.Transaction = command.Connection.BeginTransaction(); - // Select some data. - // Table Schema: - // "CREATE TABLE tablewithlobs (a int, b BLOB, c BLOB)"; - // "INSERT INTO tablewithlobs values (1, 'AA', 'AAA')"; - command.CommandText = "SELECT * FROM TableWithLobs FOR UPDATE"; - OracleDataReader reader = command.ExecuteReader(); - using(reader) - { - // Obtain the first row of data. - reader.Read(); - // Obtain both LOBs. - OracleLob BLOB1 = reader.GetOracleLob(1); - OracleLob BLOB2 = reader.GetOracleLob(2); - // Perform any desired operations on the LOB, (read, position, and so on). - // ... - // Example - Writing binary data (directly to the backend). - // To write, you can use any of the stream classes, or write raw binary data using - // the OracleLob write method. Writing character vs. binary is the same; - // however note that character is always in terms of Unicode byte counts - // (for example: even number of bytes - 2 bytes for every Unicode character). - var buffer = new byte[100]; - buffer[0] = 0xCC; - buffer[1] = 0xDD; - BLOB1.Write(buffer, 0, 2); - BLOB1.Position = 0; - Console.WriteLine(BLOB1.LobType + ".Write(" + buffer + ", 0, 2) => " + BLOB1.Value); - - // Example - Copying data into another LOB. - long actual = BLOB1.CopyTo(BLOB2); - Console.WriteLine(BLOB1.LobType + ".CopyTo(" + BLOB2.Value + ") => " + actual); - - // Commit the transaction now that everything succeeded. - // Note: On error, Transaction.Dispose is called (from the using statement) - // and will automatically roll-back the pending transaction. - command.Transaction.Commit(); - } -} -``` - +public static void WriteLobExample(OracleCommand command) +{ + // Note: Updating LOB data requires a transaction. + command.Transaction = command.Connection.BeginTransaction(); + // Select some data. + // Table Schema: + // "CREATE TABLE tablewithlobs (a int, b BLOB, c BLOB)"; + // "INSERT INTO tablewithlobs values (1, 'AA', 'AAA')"; + command.CommandText = "SELECT * FROM TableWithLobs FOR UPDATE"; + OracleDataReader reader = command.ExecuteReader(); + using(reader) + { + // Obtain the first row of data. + reader.Read(); + // Obtain both LOBs. + OracleLob BLOB1 = reader.GetOracleLob(1); + OracleLob BLOB2 = reader.GetOracleLob(2); + // Perform any desired operations on the LOB, (read, position, and so on). + // ... + // Example - Writing binary data (directly to the backend). + // To write, you can use any of the stream classes, or write raw binary data using + // the OracleLob write method. Writing character vs. binary is the same; + // however note that character is always in terms of Unicode byte counts + // (for example: even number of bytes - 2 bytes for every Unicode character). + var buffer = new byte[100]; + buffer[0] = 0xCC; + buffer[1] = 0xDD; + BLOB1.Write(buffer, 0, 2); + BLOB1.Position = 0; + Console.WriteLine(BLOB1.LobType + ".Write(" + buffer + ", 0, 2) => " + BLOB1.Value); + + // Example - Copying data into another LOB. + long actual = BLOB1.CopyTo(BLOB2); + Console.WriteLine(BLOB1.LobType + ".CopyTo(" + BLOB2.Value + ") => " + actual); + + // Commit the transaction now that everything succeeded. + // Note: On error, Transaction.Dispose is called (from the using statement) + // and will automatically roll-back the pending transaction. + command.Transaction.Commit(); + } +} +``` + > [!NOTE] -> A write operation to a read-only `LOB` might succeed, but does not update the `LOB` on the server. In this case, however, the local copy of the `LOB` is updated. Therefore, later read operations on the object might return the results of the write operation. - +> A write operation to a read-only `LOB` might succeed, but does not update the `LOB` on the server. In this case, however, the local copy of the `LOB` is updated. Therefore, later read operations on the object might return the results of the write operation. + ]]> The parameter is a null reference ( in Visual Basic). - A value in the or parameter is not positive. - - -or- - - The sum of the and parameters is larger than the length. - - -or- - - A value specified in the or parameter is less than zero or greater than 4 gigabytes. - - -or- - + A value in the or parameter is not positive. + + -or- + + The sum of the and parameters is larger than the length. + + -or- + + A value specified in the or parameter is less than zero or greater than 4 gigabytes. + + -or- + You must specify and data types as an even number of bytes. The operation is not within a transaction, the object is null, or the connection is closed. The object was closed or disposed. @@ -1440,18 +1439,18 @@ public static void WriteLobExample(OracleCommand command) The byte to write to the stream. Writes a byte to the current position in the stream, and advances the position within the stream by one byte. - [!NOTE] -> A write operation to a read-only `LOB` might succeed, but does not update the `LOB` on the server. In this case, however, the local copy of the `LOB` is updated. Therefore, later read operations on the object might return the results of the write operation. - +> A write operation to a read-only `LOB` might succeed, but does not update the `LOB` on the server. In this case, however, the local copy of the `LOB` is updated. Therefore, later read operations on the object might return the results of the write operation. + ]]> diff --git a/xml/System.Data.SqlTypes/SqlFileStream.xml b/xml/System.Data.SqlTypes/SqlFileStream.xml index 7955e4beb8a..5050842df6f 100644 --- a/xml/System.Data.SqlTypes/SqlFileStream.xml +++ b/xml/System.Data.SqlTypes/SqlFileStream.xml @@ -31,22 +31,22 @@ Exposes SQL Server data that is stored with the FILESTREAM column attribute as a sequence of bytes. - class is used to work with `varbinary(max)` data stored with the FILESTREAM attribute in a SQL Server 2008 database. You must install the .NET Framework 3.5 SP1 (or later) to use to work with FILESTREAM data. - - Specifying the FILESTREAM attribute on a `varbinary(max)` column causes SQL Server to store the data in the local NTFS file system instead of in the database file. Transact-SQL statements provide data manipulation capabilities within the server, and Win32 file system interfaces provide streaming access to the data. - + class is used to work with `varbinary(max)` data stored with the FILESTREAM attribute in a SQL Server 2008 database. You must install the .NET Framework 3.5 SP1 (or later) to use to work with FILESTREAM data. + + Specifying the FILESTREAM attribute on a `varbinary(max)` column causes SQL Server to store the data in the local NTFS file system instead of in the database file. Transact-SQL statements provide data manipulation capabilities within the server, and Win32 file system interfaces provide streaming access to the data. + > [!NOTE] -> Individual files stored in a FILESTREAM column cannot be opened directly from the NTFS file system. Streaming FILESTREAM data works only in the context of a SQL Server transaction. - - The class is derived from the class, which represents an abstraction of a sequence of bytes from some arbitrary data source such as a file or a block of memory. You can read from a FILESTREAM by transferring data from a stream into a data structure such as an array of bytes. You can write to a FILESTREAM by transferring the data from a data structure into a stream. You can also seek within the stream, which allows you to query and modify data at the current position within the stream. - - For conceptual documentation and code examples, see [FILESTREAM Data](/dotnet/framework/data/adonet/sql/filestream-data). - - For documentation about setting up and configuring FILESTREAM data on SQL Server, see [Designing and Implementing FILESTREAM Storage](https://go.microsoft.com/fwlink/?LinkId=121499) in SQL Server 2008 Books Online. - +> Individual files stored in a FILESTREAM column cannot be opened directly from the NTFS file system. Streaming FILESTREAM data works only in the context of a SQL Server transaction. + + The class is derived from the class, which represents an abstraction of a sequence of bytes from some arbitrary data source such as a file or a block of memory. You can read from a FILESTREAM by transferring data from a stream into a data structure such as an array of bytes. You can write to a FILESTREAM by transferring the data from a data structure into a stream. You can also seek within the stream, which allows you to query and modify data at the current position within the stream. + + For conceptual documentation and code examples, see [FILESTREAM Data](/dotnet/framework/data/adonet/sql/filestream-data). + + For documentation about setting up and configuring FILESTREAM data on SQL Server, see [Designing and Implementing FILESTREAM Storage](https://go.microsoft.com/fwlink/?LinkId=121499) in SQL Server 2008 Books Online. + ]]> FILESTREAM Data @@ -62,19 +62,19 @@ Initializes a new instance of the class. - | -|Write|| -|ReadWrite| and | - - For more information about CAS, see [Code Access Security and ADO.NET](/dotnet/framework/data/adonet/code-access-security). - + | +|Write|| +|ReadWrite| and | + + For more information about CAS, see [Code Access Security and ADO.NET](/dotnet/framework/data/adonet/code-access-security). + ]]> FILESTREAM Data @@ -105,32 +105,34 @@ The logical path to the file. The path can be retrieved by using the Transact-SQL Pathname function on the underlying FILESTREAM column in the table. The transaction context for the object. Applications should return the byte array returned by calling the GET_FILESTREAM_TRANSACTION_CONTEXT method. - The access mode to use when opening the file. Supported enumeration values are , , and . - - When using , the object can be used to read all of the existing data. - - When using , points to a zero byte file. Existing data will be overwritten when the object is closed and the transaction is committed. - + The access mode to use when opening the file. Supported enumeration values are , , and . + + When using , the object can be used to read all of the existing data. + + When using , points to a zero byte file. Existing data will be overwritten when the object is closed and the transaction is committed. + When using , the points to a file which has all the existing data in it. The handle is positioned at the beginning of the file. You can use one of the methods to move the handle position within the file to write or append new data. Initializes a new instance of the class. - is a null reference, or is null. - is an empty string (""), contains only white space, or contains one or more invalid characters. - - begins with "\\\\.\\", for example "\\\\.\PHYSICALDRIVE0 ". - - The handle returned by the call to NTCreateFile is not of type FILE_TYPE_DISK. - - contains an unsupported value. + is an empty string (""), contains only white space, or contains one or more invalid characters. + +-OR- + + begins with "\\\\.\\", for example "\\\\.\PHYSICALDRIVE0 ". + +-OR- + + The handle returned by the call to NTCreateFile is not of type FILE_TYPE_DISK. The file cannot be found. An I/O error occurred. The caller does not have the required permission. @@ -167,33 +169,33 @@ The logical path to the file. The path can be retrieved by using the Transact-SQL Pathname function on the underlying FILESTREAM column in the table. The transaction context for the object. When set to null, an implicit transaction will be used for the object. Applications should return the byte array returned by calling the GET_FILESTREAM_TRANSACTION_CONTEXT method. - The access mode to use when opening the file. Supported enumeration values are , , and . - - When using , the object can be used to read all of the existing data. - - When using , points to a zero byte file. Existing data will be overwritten when the object is closed and the transaction is committed. - + The access mode to use when opening the file. Supported enumeration values are , , and . + + When using , the object can be used to read all of the existing data. + + When using , points to a zero byte file. Existing data will be overwritten when the object is closed and the transaction is committed. + When using , the points to a file which has all the existing data in it. The handle is positioned at the beginning of the file. You can use one of the methods to move the handle position within the file to write or append new data. Specifies the option to use while opening the file. Supported values are , , , and . The allocation size to use while creating a file. If set to 0, the default value is used. Initializes a new instance of the class. - is a null reference, or is null. - is an empty string (""), contains only white space, or contains one or more invalid characters. - - begins with "\\\\.\\", for example "\\\\.\PHYSICALDRIVE0 ". - - The handle returned by call to NTCreateFile is not of type FILE_TYPE_DISK. - + is an empty string (""), contains only white space, or contains one or more invalid characters. + + begins with "\\\\.\\", for example "\\\\.\PHYSICALDRIVE0 ". + + The handle returned by call to NTCreateFile is not of type FILE_TYPE_DISK. + contains an unsupported value. The file cannot be found. An I/O error occurred. @@ -240,11 +242,11 @@ Begins an asynchronous read operation. An that represents the asynchronous read, which could still be pending. - property to determine whether the current instance supports reading. - + property to determine whether the current instance supports reading. + ]]> Reading data is not supported on the stream. @@ -287,11 +289,11 @@ Begins an asynchronous write operation. An that represents the asynchronous write, which could still be pending. - property to determine whether the current instance supports writing. - + property to determine whether the current instance supports writing. + ]]> Writing data is not supported on the stream. @@ -679,11 +681,11 @@ This method calls . Reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read. The total number of bytes read into the buffer. This can be less than the number of bytes requested if that many bytes are not currently available, or zero (0) if the end of the stream has been reached. - property to determine whether the current instance supports writing. - + property to determine whether the current instance supports writing. + ]]> The object does not support reading of data. @@ -715,11 +717,11 @@ This method calls . Reads a byte from the stream and advances the position within the stream by one byte, or returns -1 if at the end of the stream. The unsigned byte cast to an , or -1 if at the end of the stream. - property to determine whether the current instance supports reading. - + property to determine whether the current instance supports reading. + ]]> The object does not support reading of data. @@ -819,11 +821,11 @@ This method calls . The desired length of the current stream in bytes. Sets the length of the current stream. - property to determine whether the current instance supports reading. - + property to determine whether the current instance supports reading. + ]]> The object does not support reading of data. @@ -852,7 +854,7 @@ This method calls . Gets or sets the transaction context for this object. - The array that was passed to the constructor for this object. + The transaction context array that was passed to the constructor for this object. To be added. FILESTREAM Data @@ -888,11 +890,11 @@ This method calls . The number of bytes to be written to the current stream. Writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written. - property to determine whether the current instance supports writing. - + property to determine whether the current instance supports writing. + ]]> The object does not support writing of data. @@ -926,11 +928,11 @@ This method calls . The byte to write to the stream. Writes a byte to the current position in the stream and advances the position within the stream by one byte. - property to determine whether the current instance supports writing. - + property to determine whether the current instance supports writing. + ]]> The object does not support writing of data. diff --git a/xml/System.Data/DataRelationCollection.xml b/xml/System.Data/DataRelationCollection.xml index 3dd08767d67..e3c23fcdf72 100644 --- a/xml/System.Data/DataRelationCollection.xml +++ b/xml/System.Data/DataRelationCollection.xml @@ -73,17 +73,17 @@ Represents the collection of objects for this . - object enables navigation between related parent/child objects. - - You create a object by defining it as a property of either the or the , instead of by directly using a constructor. (Use the property of the , or the property of the .) - - To access the collection, use the property of the object. - - As soon as the collection exists you can manage the objects it contains by using methods such as , , and . - + object enables navigation between related parent/child objects. + + You create a object by defining it as a property of either the or the , instead of by directly using a constructor. (Use the property of the , or the property of the .) + + To access the collection, use the property of the object. + + As soon as the collection exists you can manage the objects it contains by using methods such as , , and . + ]]> This type is safe for multithreaded read operations. You must synchronize any write operations. @@ -182,13 +182,13 @@ The to add to the collection. Adds a to the . - event occurs. - - When a object is added to the collection, and objects are created by default if they do not already exist. - + event occurs. + + When a object is added to the collection, and objects are created by default if they do not already exist. + ]]> The parameter is a null value. @@ -243,11 +243,11 @@ Creates a with a specified parent and child column, and adds it to the collection. The created relation. - object is added to the collection, and objects are created by default if they do not already exist. - + object is added to the collection, and objects are created by default if they do not already exist. + ]]> Adding DataRelations @@ -298,14 +298,13 @@ Creates a with the specified parent and child columns, and adds it to the collection. The created relation. - object is added to the collection, and objects are created by default if they do not already exist. - + object is added to the collection, and objects are created by default if they do not already exist. + ]]> - The argument is a null value. The relation already belongs to this collection, or it belongs to another collection. The collection already has a relation with the same name. (The comparison is not case sensitive.) The relation has entered an invalid state since it was created. @@ -367,11 +366,11 @@ Creates a with the specified name, and parent and child columns, and adds it to the collection. The created relation. - object is added to the collection, and objects are created by default if they do not already exist. - + object is added to the collection, and objects are created by default if they do not already exist. + ]]> Adding DataRelations @@ -432,19 +431,19 @@ Creates a with the specified name and arrays of parent and child columns, and adds it to the collection. The created . - event occurs. - - When a object is added to the collection, and objects are created by default if they do not already exist. - - - -## Examples + event occurs. + + When a object is added to the collection, and objects are created by default if they do not already exist. + + + +## Examples :::code language="csharp" source="~/snippets/csharp/VS_Snippets_ADO.NET/Classic WebData DataRelationCollection.Add1 Example/CS/source.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData DataRelationCollection.Add1 Example/VB/source.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData DataRelationCollection.Add1 Example/VB/source.vb" id="Snippet1"::: + ]]> The relation name is a null value. @@ -512,11 +511,11 @@ Creates a with the specified name, parent and child columns, with optional constraints according to the value of the parameter, and adds it to the collection. The created relation. - object is added to the collection, and objects are created by default if they do not already exist. To prevent this, you can set `createConstraints` to false. - + object is added to the collection, and objects are created by default if they do not already exist. To prevent this, you can set `createConstraints` to false. + ]]> Adding DataRelations @@ -580,11 +579,11 @@ Creates a with the specified name, arrays of parent and child columns, and value specifying whether to create a constraint, and adds it to the collection. The created relation. - object is added to the collection, and objects are created by default if they do not already exist. - + object is added to the collection, and objects are created by default if they do not already exist. + ]]> The relation name is a null value. @@ -692,17 +691,17 @@ The array of objects to add to the collection. Copies the elements of the specified array to the end of the collection. - has been called, `AddRange` does not add any objects to the collection until is called. At the time that `EndInit` is called, the collection will be populated with the items specified in the most recent call to `AddRange`. If `AddRange` is called multiple times within a `BeginInit` / `EndInit` sequence, only those items specified in the most recent call to `AddRange` are added. - - - -## Examples + has been called, `AddRange` does not add any objects to the collection until is called. At the time that `EndInit` is called, the collection will be populated with the items specified in the most recent call to `AddRange`. If `AddRange` is called multiple times within a `BeginInit` / `EndInit` sequence, only those items specified in the most recent call to `AddRange` are added. + + + +## Examples :::code language="csharp" source="~/snippets/csharp/VS_Snippets_ADO.NET/Classic WebData DataRelationCollection.AddRange Example/CS/source.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData DataRelationCollection.AddRange Example/VB/source.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData DataRelationCollection.AddRange Example/VB/source.vb" id="Snippet1"::: + ]]> Adding DataRelations @@ -1241,11 +1240,11 @@ A that contains the event data. Raises the event. - @@ -1300,11 +1299,11 @@ A that contains the event data. Raises the event. - @@ -1367,11 +1366,11 @@ The relation to remove. Removes the specified relation from the collection. - event is fired if the remove operation succeeds. Note that removing the relation does not remove any associated constraint objects. - + event is fired if the remove operation succeeds. Note that removing the relation does not remove any associated constraint objects. + ]]> The relation is a null value. @@ -1421,11 +1420,11 @@ The name of the relation to remove. Removes the relation with the specified name from the collection. - event is fired if the remove operation succeeds. - + event is fired if the remove operation succeeds. + ]]> The collection does not have a relation with the specified name. @@ -1474,11 +1473,11 @@ The index of the relation to remove. Removes the relation at the specified index from the collection. - event is fired if the remove operation succeeds. - + event is fired if the remove operation succeeds. + ]]> The collection does not have a relation at the specified index. diff --git a/xml/System.Data/DataRow.xml b/xml/System.Data/DataRow.xml index 3c8c04a059f..28b8341a02a 100644 --- a/xml/System.Data/DataRow.xml +++ b/xml/System.Data/DataRow.xml @@ -53,25 +53,25 @@ Represents a row of data in a . - and objects are primary components of a . Use the object and its properties and methods to retrieve and evaluate; and insert, delete, and update the values in the . The represents the actual objects in the , and the contains the objects that describe the schema of the . Use the overloaded property to return or set the value of a . - - Use the and properties to determine the status of a particular row value, and the property to determine the state of the row relative to its parent . - - To create a new , use the method of the object. After creating a new , use the method to add the new to the . Finally, call the method of the object to confirm the addition. For more information about adding data to a , see [Adding Data to a DataTable](/dotnet/framework/data/adonet/dataset-datatable-dataview/adding-data-to-a-datatable). - - You can delete a from the by calling the method of the , or by calling the method of the object. The method removes the row from the collection. In contrast, marks the for removal. The actual removal occurs when you call method. By calling , you can programmatically check which rows are marked for removal before actually deleting them. For more information, see [DataRow Deletion](/dotnet/framework/data/adonet/dataset-datatable-dataview/datarow-deletion). - - - -## Examples - The following example creates a new by calling the method of the object. - + and objects are primary components of a . Use the object and its properties and methods to retrieve and evaluate; and insert, delete, and update the values in the . The represents the actual objects in the , and the contains the objects that describe the schema of the . Use the overloaded property to return or set the value of a . + + Use the and properties to determine the status of a particular row value, and the property to determine the state of the row relative to its parent . + + To create a new , use the method of the object. After creating a new , use the method to add the new to the . Finally, call the method of the object to confirm the addition. For more information about adding data to a , see [Adding Data to a DataTable](/dotnet/framework/data/adonet/dataset-datatable-dataview/adding-data-to-a-datatable). + + You can delete a from the by calling the method of the , or by calling the method of the object. The method removes the row from the collection. In contrast, marks the for removal. The actual removal occurs when you call method. By calling , you can programmatically check which rows are marked for removal before actually deleting them. For more information, see [DataRow Deletion](/dotnet/framework/data/adonet/dataset-datatable-dataview/datarow-deletion). + + + +## Examples + The following example creates a new by calling the method of the object. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_ADO.NET/Classic WebData DataRow Example/CS/source.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData DataRow Example/VB/source.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData DataRow Example/VB/source.vb" id="Snippet1"::: + ]]> This type is safe for multithreaded read operations. You must synchronize any write operations. @@ -167,23 +167,23 @@ Commits all the changes made to this row since the last time was called. - , the method is implicitly called to end any edits. If the of the row was Added or Modified, the becomes Unchanged. If the was Deleted, the row is removed. - - See the method for more information. - - The class also has an method which affects changes made to the whole table. For more information and a code example that demonstrates how to accept and reject changes to individual data rows, see [AcceptChanges and RejectChanges](/dotnet/framework/data/adonet/dataset-datatable-dataview/acceptchanges-and-rejectchanges). - - - -## Examples - The following example first creates a new with one column, and then creates a single . As the is created, added, modified, and deleted, its is printed. - + , the method is implicitly called to end any edits. If the of the row was Added or Modified, the becomes Unchanged. If the was Deleted, the row is removed. + + See the method for more information. + + The class also has an method which affects changes made to the whole table. For more information and a code example that demonstrates how to accept and reject changes to individual data rows, see [AcceptChanges and RejectChanges](/dotnet/framework/data/adonet/dataset-datatable-dataview/acceptchanges-and-rejectchanges). + + + +## Examples + The following example first creates a new with one column, and then creates a single . As the is created, added, modified, and deleted, its is printed. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_ADO.NET/Classic WebData DataRow.AcceptChanges Example/CS/source.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData DataRow.AcceptChanges Example/VB/source.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData DataRow.AcceptChanges Example/VB/source.vb" id="Snippet1"::: + ]]> The row does not belong to the table. @@ -243,26 +243,26 @@ Starts an edit operation on a object. - method to put a into edit mode. In this mode, events are temporarily suspended, letting the user make changes to more than one row without triggering validation rules. For example, if you must make sure that the value of the column for a total amount is equal to the values for the debit and credit columns in a row, you can put each row into edit mode to suspend the validation of the row values until the user tries to commit the values. - - The method is called implicitly when the user changes the value of a data-bound control; the method is called implicitly when you invoke the method for the object. While in this edit mode, the stores representations of the original and new proposed values. Therefore, as long as the method has not been called, you can retrieve either the original or proposed version by passing either `DataRowVersion.Original` or `DataRowVersion.Proposed` for the `version` parameter of the property. You can also cancel any edits at this point by invoking the method. - - To see if the row contains an original or proposed value, call the method. - + method to put a into edit mode. In this mode, events are temporarily suspended, letting the user make changes to more than one row without triggering validation rules. For example, if you must make sure that the value of the column for a total amount is equal to the values for the debit and credit columns in a row, you can put each row into edit mode to suspend the validation of the row values until the user tries to commit the values. + + The method is called implicitly when the user changes the value of a data-bound control; the method is called implicitly when you invoke the method for the object. While in this edit mode, the stores representations of the original and new proposed values. Therefore, as long as the method has not been called, you can retrieve either the original or proposed version by passing either `DataRowVersion.Original` or `DataRowVersion.Proposed` for the `version` parameter of the property. You can also cancel any edits at this point by invoking the method. + + To see if the row contains an original or proposed value, call the method. + > [!NOTE] -> The method temporarily suspends events, but the `delete` operation does not. - - - -## Examples - The example creates a simple with one and five objects, and a . A event handler is also added to monitor when the row's value is changing. After invoking on the existing rows, the constraint and event are temporarily disabled and the original and proposed values are printed. The is again invoked to set two rows to the same value. When is called, the is enforced on the identical values. - +> The method temporarily suspends events, but the `delete` operation does not. + + + +## Examples + The example creates a simple with one and five objects, and a . A event handler is also added to monitor when the row's value is changing. After invoking on the existing rows, the constraint and event are temporarily disabled and the original and proposed values are printed. The is again invoked to set two rows to the same value. When is called, the is enforced on the identical values. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_ADO.NET/Classic WebData DataRow.BeginEdit Example/CS/source.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData DataRow.BeginEdit Example/VB/source.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData DataRow.BeginEdit Example/VB/source.vb" id="Snippet1"::: + ]]> The method was called inside the event. @@ -320,19 +320,19 @@ Cancels the current edit on the row. - method for more information. - - - -## Examples - The following example edits the value of one column in the last row of a control. The example uses the , , methods to edit the column's value and commit the change to the row. - + method for more information. + + + +## Examples + The following example edits the value of one column in the last row of a control. The example uses the , , methods to edit the column's value and commit the change to the row. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_ADO.NET/Classic WebData DataRow.CancelEdit Example/CS/source.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData DataRow.CancelEdit Example/VB/source.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData DataRow.CancelEdit Example/VB/source.vb" id="Snippet1"::: + ]]> The method was called inside the event. @@ -384,23 +384,23 @@ Clears the errors for the row. This includes the and errors set with . - and to set and return errors for individual columns. - - Set the property to set an error that applies to the whole row. - - To determine whether any errors exist for the columns collection, use the method. Consequently, you can use the method to retrieve all the columns with errors. - - - -## Examples - The following example uses the to look for errors. If the row has errors, the method returns the array of columns with errors that can then be resolved. The method is then called to clear all errors. - + and to set and return errors for individual columns. + + Set the property to set an error that applies to the whole row. + + To determine whether any errors exist for the columns collection, use the method. Consequently, you can use the method to retrieve all the columns with errors. + + + +## Examples + The following example uses the to look for errors. If the row has errors, the method returns the array of columns with errors that can then be resolved. The method is then called to clear all errors. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_ADO.NET/Classic WebData DataRow.ClearErrors Example/CS/source.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData DataRow.ClearErrors Example/VB/source.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData DataRow.ClearErrors Example/VB/source.vb" id="Snippet1"::: + ]]> @@ -450,28 +450,28 @@ Deletes the . - of the row is Added, the becomes `Detached` and the row is removed from the table when you call . - - The becomes `Deleted` after you use the method on an existing . It remains `Deleted` until you call . At this time, the is removed from the table. - - should not be called in a foreach loop while iterating through a object. modifies the state of the collection. - - A deleted row can be undeleted by invoking . - + of the row is Added, the becomes `Detached` and the row is removed from the table when you call . + + The becomes `Deleted` after you use the method on an existing . It remains `Deleted` until you call . At this time, the is removed from the table. + + should not be called in a foreach loop while iterating through a object. modifies the state of the collection. + + A deleted row can be undeleted by invoking . + > [!NOTE] -> The method temporarily suspends events, but the delete operation does not. - - - -## Examples - The following example creates a simple with two columns and ten rows. After deleting several items with the method, one of the rows is undeleted by invoking . - +> The method temporarily suspends events, but the delete operation does not. + + + +## Examples + The following example creates a simple with two columns and ten rows. After deleting several items with the method, one of the rows is undeleted by invoking . + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_ADO.NET/Classic WebData DataRow.Delete Example/CS/source.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData DataRow.Delete Example/VB/source.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData DataRow.Delete Example/VB/source.vb" id="Snippet1"::: + ]]> The has already been deleted. @@ -525,19 +525,19 @@ Ends the edit occurring on the row. - event. - - - -## Examples - The following example uses the method to end the edit of a value if the validation function returns true. - + event. + + + +## Examples + The following example uses the method to end the edit of a value if the validation function returns true. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_ADO.NET/Classic WebData DataRow.CancelEdit Example/CS/source.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData DataRow.CancelEdit Example/VB/source.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData DataRow.CancelEdit Example/VB/source.vb" id="Snippet1"::: + ]]> The method was called inside the event. @@ -614,19 +614,19 @@ Gets the child rows of this using the specified . An array of objects or an array of length zero. - also contains a collection of objects that is returned by the property. - - - -## Examples - The following example uses the to return the child objects for every child in a . The value of each column in the row is then printed. - + also contains a collection of objects that is returned by the property. + + + +## Examples + The following example uses the to return the child objects for every child in a . The value of each column in the row is then printed. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_ADO.NET/Classic WebData DataRow.GetChildRows2 Example/CS/source.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData DataRow.GetChildRows2 Example/VB/source.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData DataRow.GetChildRows2 Example/VB/source.vb" id="Snippet1"::: + ]]> The relation and row do not belong to the same table. @@ -690,11 +690,11 @@ Gets the child rows of a using the specified of a . An array of objects or an array of length zero. - also contains a collection of objects that is returned by the property. - + also contains a collection of objects that is returned by the property. + ]]> The relation and row do not belong to the same table. @@ -753,23 +753,23 @@ Gets the child rows of a using the specified , and . An array of objects. - also contains a collection of objects that is returned by the property. - - Use the property to determine whether the that you want exists. - - If is specified, the version that is used depends on the of the row on which `GetChildRows` is invoked. If the row on which `GetChildRows` is invoked has a `RowState` of `Modified`, `New`, or `Unchanged`, the version of the row is used for fetching related child rows with matching values in their Current versions. If the row on which `GetChildRows` is invoked has a `RowState` of `Deleted`, the version of the row is used for fetching related child rows with matching values in their original versions. - - - -## Examples - The following example uses the to return the child objects for every child in a . The value of each column with the specified version in the row is then printed. - + also contains a collection of objects that is returned by the property. + + Use the property to determine whether the that you want exists. + + If is specified, the version that is used depends on the of the row on which `GetChildRows` is invoked. If the row on which `GetChildRows` is invoked has a `RowState` of `Modified`, `New`, or `Unchanged`, the version of the row is used for fetching related child rows with matching values in their Current versions. If the row on which `GetChildRows` is invoked has a `RowState` of `Deleted`, the version of the row is used for fetching related child rows with matching values in their original versions. + + + +## Examples + The following example uses the to return the child objects for every child in a . The value of each column with the specified version in the row is then printed. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_ADO.NET/Classic WebData DataRow.GetChildRows3 Example/CS/source.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData DataRow.GetChildRows3 Example/VB/source.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData DataRow.GetChildRows3 Example/VB/source.vb" id="Snippet1"::: + ]]> The relation and row do not belong to the same table. @@ -837,19 +837,18 @@ Gets the child rows of a using the specified of a , and . An array of objects or an array of length zero. - also contains a collection of objects that is returned by the property. - - Use the property to determine whether the that you want exists. - - If is specified, the version that is used depends on the of the row on which `GetChildRows` is invoked. If the row on which `GetChildRows` is invoked has a `RowState` of `Modified`, `New`, or `Unchanged`, the version of the row is used for fetching related child rows with matching values in their Current versions. If the row on which `GetChildRows` is invoked has a `RowState` of `Deleted`, the version of the row is used for fetching related child rows with matching values in their original versions. - + also contains a collection of objects that is returned by the property. + + Use the property to determine whether the that you want exists. + + If is specified, the version that is used depends on the of the row on which `GetChildRows` is invoked. If the row on which `GetChildRows` is invoked has a `RowState` of `Modified`, `New`, or `Unchanged`, the version of the row is used for fetching related child rows with matching values in their Current versions. If the row on which `GetChildRows` is invoked has a `RowState` of `Deleted`, the version of the row is used for fetching related child rows with matching values in their original versions. + ]]> The relation and row do not belong to the same table. - The is . The row does not belong to the table. The row does not have the requested . @@ -906,23 +905,23 @@ Gets the error description of the specified . The text of the error description. - method to set column errors. - - To determine whether any errors exist for the columns collection, use the method. Consequently, you can use the method to retrieve all the columns with errors. Alternatively, the method of the returns all rows with errors. - - To clear all errors for the columns collection, use the method. - - - -## Examples - The following example sets an error description for a specified . - + method to set column errors. + + To determine whether any errors exist for the columns collection, use the method. Consequently, you can use the method to retrieve all the columns with errors. Alternatively, the method of the returns all rows with errors. + + To clear all errors for the columns collection, use the method. + + + +## Examples + The following example sets an error description for a specified . + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_ADO.NET/Classic WebData DataRow.SetColumnError Example/CS/source.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData DataRow.SetColumnError Example/VB/source.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData DataRow.SetColumnError Example/VB/source.vb" id="Snippet1"::: + ]]> @@ -978,23 +977,23 @@ Gets the error description for the column specified by index. The text of the error description. - method to set column errors. - - To determine whether any errors exist for the columns collection, use the method. Consequently, you can use the method to retrieve all the columns with errors. - - To clear all errors for the columns collection, use the method. - - - -## Examples - The following example sets an error description for a specified . - + method to set column errors. + + To determine whether any errors exist for the columns collection, use the method. Consequently, you can use the method to retrieve all the columns with errors. + + To clear all errors for the columns collection, use the method. + + + +## Examples + The following example sets an error description for a specified . + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_ADO.NET/Classic WebData DataRow.SetColumnError Example/CS/source.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData DataRow.SetColumnError Example/VB/source.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData DataRow.SetColumnError Example/VB/source.vb" id="Snippet1"::: + ]]> The argument is out of range. @@ -1050,23 +1049,23 @@ Gets the error description for a column, specified by name. The text of the error description. - method to set column errors. - - To determine whether any errors exist for the columns collection, use the method. Consequently, you can use the method to retrieve all the columns with errors. - - To clear all errors for the columns collection, use the method. - - - -## Examples - The following example sets an error description for a specified . - + method to set column errors. + + To determine whether any errors exist for the columns collection, use the method. Consequently, you can use the method to retrieve all the columns with errors. + + To clear all errors for the columns collection, use the method. + + + +## Examples + The following example sets an error description for a specified . + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_ADO.NET/Classic WebData DataRow.SetColumnError Example/CS/source.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData DataRow.SetColumnError Example/VB/source.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData DataRow.SetColumnError Example/VB/source.vb" id="Snippet1"::: + ]]> @@ -1118,21 +1117,21 @@ Gets an array of columns that have errors. An array of objects that contain errors. - lets you reduce the number of objects that must be processed for errors by returning only those columns that have an error. Errors can be set to individual columns with the method. To further reduce the number of processing, examine the property of the class to determine whether a has errors before invoking . - - Use the method to clear all errors on the row. This includes the . - - - -## Examples - The following example uses the to look for errors. If the row has errors, the method returns the array of columns with errors that can then be resolved. The method is then called to clear all errors. - + lets you reduce the number of objects that must be processed for errors by returning only those columns that have an error. Errors can be set to individual columns with the method. To further reduce the number of processing, examine the property of the class to determine whether a has errors before invoking . + + Use the method to clear all errors on the row. This includes the . + + + +## Examples + The following example uses the to look for errors. If the row has errors, the method returns the array of columns with errors that can then be resolved. The method is then called to clear all errors. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_ADO.NET/Classic WebData DataRow.ClearErrors Example/CS/source.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData DataRow.ClearErrors Example/VB/source.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData DataRow.ClearErrors Example/VB/source.vb" id="Snippet1"::: + ]]> @@ -1196,25 +1195,25 @@ Gets the parent row of a using the specified . The parent of the current row. - , the collection of all parent objects for the data set is returned by the method. - - The also contains a collection of objects, returned by the property. - - - -## Examples - The following example uses the to return the child objects for every child in a . The value of each column in the row is then printed. - + , the collection of all parent objects for the data set is returned by the method. + + The also contains a collection of objects, returned by the property. + + + +## Examples + The following example uses the to return the child objects for every child in a . The value of each column in the row is then printed. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_ADO.NET/Classic WebData DataRow.GetParentRow2 Example/CS/source.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData DataRow.GetParentRow2 Example/VB/source.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData DataRow.GetParentRow2 Example/VB/source.vb" id="Snippet1"::: + ]]> - The does not belong to the . - + The does not belong to the . + -or- The row is . @@ -1271,21 +1270,21 @@ Gets the parent row of a using the specified of a . The parent of the current row. - , the collection of all parent objects for the data set is returned by the method. - - The also contains a collection of objects, returned by the property. - - - -## Examples - The following example uses the to print a value from each parent row of each in a . - + , the collection of all parent objects for the data set is returned by the method. + + The also contains a collection of objects, returned by the property. + + + +## Examples + The following example uses the to print a value from each parent row of each in a . + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_ADO.NET/Classic WebData DataRow.GetParentRow Example/CS/source.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData DataRow.GetParentRow Example/VB/source.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData DataRow.GetParentRow Example/VB/source.vb" id="Snippet1"::: + ]]> The relation and row do not belong to the same table. @@ -1338,27 +1337,27 @@ Gets the parent row of a using the specified , and . The parent of the current row. - , the collection of all parent objects for the data set is returned by the method. - - The also contains a collection of objects, returned by the property. - - Use the property to determine whether the that you want exists. - - - -## Examples - The following example uses the to return the child objects for every child in a . The value of each column in the row is then printed. - + , the collection of all parent objects for the data set is returned by the method. + + The also contains a collection of objects, returned by the property. + + Use the property to determine whether the that you want exists. + + + +## Examples + The following example uses the to return the child objects for every child in a . The value of each column in the row is then printed. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_ADO.NET/Classic WebData DataRow.GetParentRow3 Example/CS/source.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData DataRow.GetParentRow3 Example/VB/source.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData DataRow.GetParentRow3 Example/VB/source.vb" id="Snippet1"::: + ]]> - The row is . - + The row is . + -or- The does not belong to this table's parent relations. @@ -1419,27 +1418,26 @@ Gets the parent row of a using the specified of a , and . The parent of the current row. - , the collection of all parent objects for the data set is returned by the method. - - The also contains a collection of objects, returned by the property. - - Use the property to determine whether the that you want exists. - - - -## Examples - The following example uses the to print a value from each parent row of each in a . - + , the collection of all parent objects for the data set is returned by the method. + + The also contains a collection of objects, returned by the property. + + Use the property to determine whether the that you want exists. + + + +## Examples + The following example uses the to print a value from each parent row of each in a . + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_ADO.NET/Classic WebData DataRow.GetParentRow1 Example/CS/source.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData DataRow.GetParentRow1 Example/VB/source.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData DataRow.GetParentRow1 Example/VB/source.vb" id="Snippet1"::: + ]]> The relation and row do not belong to the same table. - The is . A child row has multiple parents. The row does not belong to the table. The row does not have the requested . @@ -1505,20 +1503,20 @@ Gets the parent rows of a using the specified . An array of objects or an array of length zero. - , the collection of all parent objects for the data set is returned by the method. - - The also contains a collection of objects, returned by the property. - - - -## Examples - The following example uses the to return the child objects for every child in a . The value of each column in the row is then printed. - - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData DataRow.GetParentRows2 Example/VB/source.vb" id="Snippet1"::: - + , the collection of all parent objects for the data set is returned by the method. + + The also contains a collection of objects, returned by the property. + + + +## Examples + The following example uses the to return the child objects for every child in a . The value of each column in the row is then printed. + + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData DataRow.GetParentRows2 Example/VB/source.vb" id="Snippet1"::: + ]]> The does not belong to this row's . @@ -1582,13 +1580,13 @@ Gets the parent rows of a using the specified of a . An array of objects or an array of length zero. - , the collection of all parent objects for the data set is returned by the method. - - The also contains a collection of objects, returned by the property. - + , the collection of all parent objects for the data set is returned by the method. + + The also contains a collection of objects, returned by the property. + ]]> The relation and row do not belong to the same table. @@ -1647,22 +1645,22 @@ Gets the parent rows of a using the specified , and . An array of objects or an array of length zero. - , the collection of all parent objects for the data set is returned by the method. - - The also contains a collection of objects, returned by the property. - - Use the property to determine whether the that you want exists. - - - -## Examples - The following example uses the to return the child objects for every child in a . The value of each column in the row is then printed. - - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData DataRow.GetParentRows3 Example/VB/source.vb" id="Snippet1"::: - + , the collection of all parent objects for the data set is returned by the method. + + The also contains a collection of objects, returned by the property. + + Use the property to determine whether the that you want exists. + + + +## Examples + The following example uses the to return the child objects for every child in a . The value of each column in the row is then printed. + + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData DataRow.GetParentRows3 Example/VB/source.vb" id="Snippet1"::: + ]]> The does not belong to this row's . @@ -1729,19 +1727,18 @@ Gets the parent rows of a using the specified of a , and . An array of objects or an array of length zero. - , the collection of all parent objects for the data set is returned by the method. - - The also contains a collection of objects, returned by the property. - - Use the property to determine whether the that you want exists. - + , the collection of all parent objects for the data set is returned by the method. + + The also contains a collection of objects, returned by the property. + + Use the property to determine whether the that you want exists. + ]]> The relation and row do not belong to the same table. - The is . The row does not belong to the table. The row does not have the requested . @@ -1785,27 +1782,27 @@ if the row contains an error; otherwise, . - object in the row contains an error, or if the property of the is not an empty string. - - When validating data, you can set an error on any column in a row. Such a column, when displayed in the control, is marked with a red exclamation point to signal to the user that the column is in error. - - Use to set an error on any column. - - Use the and `GetColumnsInError` methods to return columns with errors. - - The method clears all errors for the row. - - - -## Examples - The following example uses the to look for errors. If the row has errors, the method returns the array of columns with errors that can then be resolved. The method is then called to clear all errors. - + object in the row contains an error, or if the property of the is not an empty string. + + When validating data, you can set an error on any column in a row. Such a column, when displayed in the control, is marked with a red exclamation point to signal to the user that the column is in error. + + Use to set an error on any column. + + Use the and `GetColumnsInError` methods to return columns with errors. + + The method clears all errors for the row. + + + +## Examples + The following example uses the to look for errors. If the row has errors, the method returns the array of columns with errors that can then be resolved. The method is then called to clear all errors. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_ADO.NET/Classic WebData DataRow.HasErrors Example/CS/source.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData DataRow.HasErrors Example/VB/source.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData DataRow.HasErrors Example/VB/source.vb" id="Snippet1"::: + ]]> @@ -1858,18 +1855,18 @@ if the version exists; otherwise, . - method for more information. - - - -## Examples - The following example uses the method to determine whether the current value of a column and the proposed value are the same. If so, the edit is canceled. Otherwise, the method is called to end the edit. - - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData DataRow.HasVersion Example/VB/source.vb" id="Snippet1"::: - + method for more information. + + + +## Examples + The following example uses the method to determine whether the current value of a column and the proposed value are the same. If so, the edit is canceled. Otherwise, the method is called to end the edit. + + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData DataRow.HasVersion Example/VB/source.vb" id="Snippet1"::: + ]]> @@ -1935,13 +1932,13 @@ if the column contains a null value; otherwise, . - . If the row is set to a null value, the value is not printed. - - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData DataRow.IsNull2 Example/VB/source.vb" id="Snippet1"::: - + . If the row is set to a null value, the value is not printed. + + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData DataRow.IsNull2 Example/VB/source.vb" id="Snippet1"::: + ]]> @@ -1992,13 +1989,13 @@ if the column contains a null value; otherwise, . - method to determine whether the value is null. - - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData DataRow.IsNull Example/VB/source.vb" id="Snippet1"::: - + method to determine whether the value is null. + + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData DataRow.IsNull Example/VB/source.vb" id="Snippet1"::: + ]]> No column corresponds to the index specified by . @@ -2048,13 +2045,13 @@ if the column contains a null value; otherwise, . - method to determine whether the value is null. - - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData DataRow.IsNull1 Example/VB/source.vb" id="Snippet1"::: - + method to determine whether the value is null. + + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData DataRow.IsNull1 Example/VB/source.vb" id="Snippet1"::: + ]]> The column specified by cannot be found. @@ -2166,20 +2163,20 @@ Gets or sets the data stored in the specified . An that contains the data. - event. - - If this is an immediate edit, see for the exceptions that can be generated. - - - -## Examples - The following examples demonstrate the use of the property to get and set the value of a specific column index. The first example gets the value of the first column in any row that a user clicks in a control. The second sets a value passed as an argument to the method. - - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData DataRow.this2 Example/VB/source.vb" id="Snippet1"::: - + event. + + If this is an immediate edit, see for the exceptions that can be generated. + + + +## Examples + The following examples demonstrate the use of the property to get and set the value of a specific column index. The first example gets the value of the first column in any row that a user clicks in a control. The second sets a value passed as an argument to the method. + + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData DataRow.this2 Example/VB/source.vb" id="Snippet1"::: + ]]> The column does not belong to this table. @@ -2230,21 +2227,21 @@ Gets or sets the data stored in the column specified by index. An that contains the data. - event. - - If this is an edit, see for the exceptions that can be generated. - - - -## Examples - The following examples demonstrate the use of the property to get and set the value of a specific column index. The first example gets the value of the first column in any row that a user clicks in a control. - + event. + + If this is an edit, see for the exceptions that can be generated. + + + +## Examples + The following examples demonstrate the use of the property to get and set the value of a specific column index. The first example gets the value of the first column in any row that a user clicks in a control. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_ADO.NET/Classic WebData DataRow.this Example/CS/source.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData DataRow.this Example/VB/source.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData DataRow.this Example/VB/source.vb" id="Snippet1"::: + ]]> Occurs when you try to set a value on a deleted row. @@ -2294,21 +2291,21 @@ Gets or sets the data stored in the column specified by name. An that contains the data. - event. - - If this is an immediate edit, see for the exceptions that can be generated. - - - -## Examples - The following examples demonstrate the use of the property to get and set the value of a specific column index. The first example gets the value of the first column in any row that a user clicks in a control. The second sets a value passed as an argument to the method. - + event. + + If this is an immediate edit, see for the exceptions that can be generated. + + + +## Examples + The following examples demonstrate the use of the property to get and set the value of a specific column index. The first example gets the value of the first column in any row that a user clicks in a control. The second sets a value passed as an argument to the method. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_ADO.NET/Classic WebData DataRow.this1 Example/CS/source.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData DataRow.this1 Example/VB/source.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData DataRow.this1 Example/VB/source.vb" id="Snippet1"::: + ]]> The column specified by cannot be found. @@ -2361,23 +2358,23 @@ Gets the specified version of data stored in the specified . An that contains the data. - property. The `version` argument describes the state of the data that is contained by the column relative to the column's original value. - - When you set the property, an exception is generated if an exception occurs in the event. - - If this is an immediate edit, see for the exceptions that can be generated. - - - -## Examples - The following example gets the current value of a clicked cell in the control. - + property. The `version` argument describes the state of the data that is contained by the column relative to the column's original value. + + When you set the property, an exception is generated if an exception occurs in the event. + + If this is an immediate edit, see for the exceptions that can be generated. + + + +## Examples + The following example gets the current value of a clicked cell in the control. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_ADO.NET/Classic WebData DataRow.this5 Example/CS/source.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData DataRow.this5 Example/VB/source.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData DataRow.this5 Example/VB/source.vb" id="Snippet1"::: + ]]> The column does not belong to the table. @@ -2430,29 +2427,29 @@ Gets the data stored in the column, specified by index and version of the data to retrieve. An that contains the data. - method; similarly, the method must be called to commit the edit. After you call the method, and before you call the method, internal representations of the original and new proposed values are stored. Therefore, until you call the , you can use the `version` argument to specify which version of a column's value you need, either the `DataRowVersion.Original` or `DataRowVersion.Proposed`. However, as soon as you call the method, the version of the column reverts to `DataRowVersion.Original`. If the row is new, you can also pass `DataRowVersion.Default` for the parameter to retrieve the column's default value. When passing `DataRowVersion.Current`, the property returns the current value, whatever its version may be. - + method; similarly, the method must be called to commit the edit. After you call the method, and before you call the method, internal representations of the original and new proposed values are stored. Therefore, until you call the , you can use the `version` argument to specify which version of a column's value you need, either the `DataRowVersion.Original` or `DataRowVersion.Proposed`. However, as soon as you call the method, the version of the column reverts to `DataRowVersion.Original`. If the row is new, you can also pass `DataRowVersion.Default` for the parameter to retrieve the column's default value. When passing `DataRowVersion.Current`, the property returns the current value, whatever its version may be. + > [!NOTE] -> The method is called implicitly when you change the value of a data-bound control or when a object is added to the ; the method is called implicitly when you call the following methods: the method of the object, the method of the object, or the method. - - By contrast, the enumeration `Current` returns the version of the data after the method has been called. - - The `version` argument should not be confused with the property. The `version` argument describes the state of the data that is contained by the column relative to the column's original value. The property describes the state of the whole row relative to its parent . - - When you set the property, an exception is generated if an exception occurs in the event. - - If this is an immediate edit, see for the exceptions that can be generated. - - - -## Examples - The following example gets the current value of a column through the property of the object. - - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData DataRow.this3 Example/VB/source.vb" id="Snippet1"::: - +> The method is called implicitly when you change the value of a data-bound control or when a object is added to the ; the method is called implicitly when you call the following methods: the method of the object, the method of the object, or the method. + + By contrast, the enumeration `Current` returns the version of the data after the method has been called. + + The `version` argument should not be confused with the property. The `version` argument describes the state of the data that is contained by the column relative to the column's original value. The property describes the state of the whole row relative to its parent . + + When you set the property, an exception is generated if an exception occurs in the event. + + If this is an immediate edit, see for the exceptions that can be generated. + + + +## Examples + The following example gets the current value of a column through the property of the object. + + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData DataRow.this3 Example/VB/source.vb" id="Snippet1"::: + ]]> The argument is out of range. @@ -2505,23 +2502,23 @@ Gets the specified version of data stored in the named column. An that contains the data. - property. The `version` argument describes the state of the data that is contained by the column relative to the column's original value. The property describes the state of the whole row relative to its parent . - - When you set the property, an exception is generated if an exception occurs in the event. - - If this is an immediate edit, see for the exceptions that can be generated. - - - -## Examples - The following example gets the current version of data at a clicked cell of a control. - + property. The `version` argument describes the state of the data that is contained by the column relative to the column's original value. The property describes the state of the whole row relative to its parent . + + When you set the property, an exception is generated if an exception occurs in the event. + + If this is an immediate edit, see for the exceptions that can be generated. + + + +## Examples + The following example gets the current version of data at a clicked cell of a control. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_ADO.NET/Classic WebData DataRow.this4 Example/CS/source.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData DataRow.this4 Example/VB/source.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData DataRow.this4 Example/VB/source.vb" id="Snippet1"::: + ]]> The column specified by cannot be found. @@ -2576,21 +2573,21 @@ Gets or sets all the values for this row through an array. An array of type . - indicates that no value was specified. - - Users can generate exceptions in the event or the event. - - - -## Examples - The following examples show how to get and set values using the property. - + indicates that no value was specified. + + Users can generate exceptions in the event or the event. + + + +## Examples + The following examples show how to get and set values using the property. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_ADO.NET/Classic WebData DataRow.ItemArray Example/CS/source.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData DataRow.ItemArray Example/VB/source.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData DataRow.ItemArray Example/VB/source.vb" id="Snippet1"::: + ]]> The array is larger than the number of columns in the table. @@ -2642,19 +2639,19 @@ Rejects all changes made to the row since was last called. - method, the method is implicitly called to cancel any edits. If is deleted or modified, the row reverts to its previous values, and becomes unchanged. If the is added, the row is removed. - - - -## Examples - The following example creates a simple with 2 columns and 10 rows. After several items are deleted with the method, one of the rows is undeleted by invoking . - + method, the method is implicitly called to cancel any edits. If is deleted or modified, the row reverts to its previous values, and becomes unchanged. If the is added, the row is removed. + + + +## Examples + The following example creates a simple with 2 columns and 10 rows. After several items are deleted with the method, one of the rows is undeleted by invoking . + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_ADO.NET/Classic WebData DataRow.Delete Example/CS/source.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData DataRow.Delete Example/VB/source.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData DataRow.Delete Example/VB/source.vb" id="Snippet1"::: + ]]> The row does not belong to the table. @@ -2700,19 +2697,19 @@ Gets or sets the custom error description for a row. The text describing an error. - property to first determine whether a contains errors. - - - -## Examples - The following example sets error text for ten rows of a table displayed in a control. - + property to first determine whether a contains errors. + + + +## Examples + The following example sets error text for ten rows of a table displayed in a control. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_ADO.NET/Classic WebData DataRow.RowError Example/CS/source.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData DataRow.RowError Example/VB/source.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData DataRow.RowError Example/VB/source.vb" id="Snippet1"::: + ]]> @@ -2757,19 +2754,19 @@ Gets the current state of the row with regard to its relationship to the . One of the values. - depends on two factors: the kind of operation has been performed on the row, and whether has been called on the . - - - -## Examples - The following example first creates a new with one column, and then creates a single . As the is created, added, modified, and deleted, its is printed. - + depends on two factors: the kind of operation has been performed on the row, and whether has been called on the . + + + +## Examples + The following example first creates a new with one column, and then creates a single . As the is created, added, modified, and deleted, its is printed. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_ADO.NET/Classic WebData DataRow.RowState Example/CS/source.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData DataRow.RowState Example/VB/source.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData DataRow.RowState Example/VB/source.vb" id="Snippet1"::: + ]]> @@ -2822,11 +2819,11 @@ Changes the of a to . - of a to `Added`. If the current row is not in either an `Unchanged` or an `Added` state, it throws an with the message that `SetAdded` can only be invoked on a `DataRow` instance where the `RowState` is `Unchanged`. - + of a to `Added`. If the current row is not in either an `Unchanged` or an `Added` state, it throws an with the message that `SetAdded` can only be invoked on a `DataRow` instance where the `RowState` is `Unchanged`. + ]]> @@ -2894,29 +2891,29 @@ The error description. Sets the error description for a column specified as a . - method. - - To determine whether any errors exist for the columns collection, use the property. Consequently, you can use the method to retrieve all the columns with errors. - - If `null` or an empty string is passed in as the `error` parameter, the behaves as if no error was set and the property will return false. - - To set a custom error description on the whole row, use the property. - - To determine whether any errors exist for the columns collection, use the method. - - To clear all errors for the columns collection, use the method. - - - -## Examples - The following example sets an error description for a specified . - + method. + + To determine whether any errors exist for the columns collection, use the property. Consequently, you can use the method to retrieve all the columns with errors. + + If `null` or an empty string is passed in as the `error` parameter, the behaves as if no error was set and the property will return false. + + To set a custom error description on the whole row, use the property. + + To determine whether any errors exist for the columns collection, use the method. + + To clear all errors for the columns collection, use the method. + + + +## Examples + The following example sets an error description for a specified . + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_ADO.NET/Classic WebData DataRow.SetColumnError Example/CS/source.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData DataRow.SetColumnError Example/VB/source.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData DataRow.SetColumnError Example/VB/source.vb" id="Snippet1"::: + ]]> @@ -2972,31 +2969,31 @@ The error description. Sets the error description for a column specified by index. - control to display the text of the error. - - To examine error descriptions, use the method. - - To determine whether any errors exist for the columns collection, use the property. Consequently, you can use the method to retrieve all the columns with errors. - - If `null` or an empty string is passed in as the `error` parameter, the behaves as if no error was set and the property will return false. - - To set a custom error description on the whole row, use the property. - - To clear all errors for the columns collection, use the method. - - To set error text that applies to a whole row, set the property. - - - -## Examples - The following example sets an error description for a specified . - + control to display the text of the error. + + To examine error descriptions, use the method. + + To determine whether any errors exist for the columns collection, use the property. Consequently, you can use the method to retrieve all the columns with errors. + + If `null` or an empty string is passed in as the `error` parameter, the behaves as if no error was set and the property will return false. + + To set a custom error description on the whole row, use the property. + + To clear all errors for the columns collection, use the method. + + To set error text that applies to a whole row, set the property. + + + +## Examples + The following example sets an error description for a specified . + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_ADO.NET/Classic WebData DataRow.SetColumnError Example/CS/source.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData DataRow.SetColumnError Example/VB/source.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData DataRow.SetColumnError Example/VB/source.vb" id="Snippet1"::: + ]]> The argument is out of range @@ -3060,31 +3057,31 @@ The error description. Sets the error description for a column specified by name. - property of the class. - - To examine error descriptions, use the method. - - To determine whether any errors exist for the columns collection, use the property. Consequently, you can use the method to retrieve all the columns with errors. - - If `null` or an empty string is passed in as the `error` parameter, the behaves as if no error was set and the property will return false. - - To set a custom error description on the whole row, use the property. - - To determine whether any errors exist for the columns collection, use the method. - - To clear all errors for the columns collection, use the method. - - - -## Examples - The following example sets an error description for a specified . - + property of the class. + + To examine error descriptions, use the method. + + To determine whether any errors exist for the columns collection, use the property. Consequently, you can use the method to retrieve all the columns with errors. + + If `null` or an empty string is passed in as the `error` parameter, the behaves as if no error was set and the property will return false. + + To set a custom error description on the whole row, use the property. + + To determine whether any errors exist for the columns collection, use the method. + + To clear all errors for the columns collection, use the method. + + + +## Examples + The following example sets an error description for a specified . + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_ADO.NET/Classic WebData DataRow.SetColumnError Example/CS/source.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData DataRow.SetColumnError Example/VB/source.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData DataRow.SetColumnError Example/VB/source.vb" id="Snippet1"::: + ]]> @@ -3133,11 +3130,11 @@ Changes the of a to . - of a to `Modified`. If the current row is not in the `Unchanged` state, this throws an with the message that `SetModified` can only be invoked on a `DataRow` instance where the `RowState` is `Unchanged`. - + of a to `Modified`. If the current row is not in the `Unchanged` state, this throws an with the message that `SetModified` can only be invoked on a `DataRow` instance where the `RowState` is `Unchanged`. + ]]> @@ -3185,11 +3182,11 @@ A . Sets the value of the specified to a null value. - method to determine whether a column contains a null value. - + method to determine whether a column contains a null value. + ]]> @@ -3292,13 +3289,13 @@ The relation to use. Sets the parent row of a with specified new parent and . - One of the rows does not belong to a table @@ -3345,19 +3342,19 @@ Gets the for which this row has a schema. The to which this row belongs. - does not necessarily belong to any table's collection of rows. This behavior occurs when the has been created but not added to the . If the property returns `DataRowState.Detached`, the row is not in any collection. - - - -## Examples - The following example uses the property to return a reference to the columns collection of the . - + does not necessarily belong to any table's collection of rows. This behavior occurs when the has been created but not added to the . If the property returns `DataRowState.Detached`, the row is not in any collection. + + + +## Examples + The following example uses the property to return a reference to the columns collection of the . + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_ADO.NET/Classic WebData DataRow.Table Example/CS/source.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData DataRow.Table Example/VB/source.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData DataRow.Table Example/VB/source.vb" id="Snippet1"::: + ]]> diff --git a/xml/System.Data/DataRowExtensions.xml b/xml/System.Data/DataRowExtensions.xml index 8d48a715327..a6231ed9767 100644 --- a/xml/System.Data/DataRowExtensions.xml +++ b/xml/System.Data/DataRowExtensions.xml @@ -51,11 +51,11 @@ Defines the extension methods to the class. This is a static class. - API has been extended with two new methods of the class, and . You can use these to form Language-Integrated Query (LINQ) expressions and method queries against objects. They are the recommended methods to use for accessing column values within Language-Integrated Query (LINQ) expressions and method queries. For more information, see [Generic Field and SetField Methods](/dotnet/framework/data/adonet/generic-field-and-setfield-methods-linq-to-dataset). - + API has been extended with two new methods of the class, and . You can use these to form Language-Integrated Query (LINQ) expressions and method queries against objects. They are the recommended methods to use for accessing column values within Language-Integrated Query (LINQ) expressions and method queries. For more information, see [Generic Field and SetField Methods](/dotnet/framework/data/adonet/generic-field-and-setfield-methods-linq-to-dataset). + ]]> @@ -121,15 +121,15 @@ Provides strongly-typed access to each of the column values in the specified row. The method also supports nullable types. The value, of type , of the specified by . - class represents **null** values with the instance of the class. A Language-Integrated Query (LINQ) expression that accessed a column with a **null** value would generate a at run time. Additionally, and do not support nullable types. The method provides support for accessing columns as nullable types. If the underlying value in the is , the returned nullable type will have a value of **null**. - - If the value of the specified is and `T` is a reference type or nullable type, the return type will be **null**. The method will not return . - - The method does not perform type conversions. If type conversion is required, you should first obtain the column value by using the method. The column value should then be converted to another type. - + class represents **null** values with the instance of the class. A Language-Integrated Query (LINQ) expression that accessed a column with a **null** value would generate a at run time. Additionally, and do not support nullable types. The method provides support for accessing columns as nullable types. If the underlying value in the is , the returned nullable type will have a value of **null**. + + If the value of the specified is and `T` is a reference type or nullable type, the return type will be **null**. The method will not return . + + The method does not perform type conversions. If type conversion is required, you should first obtain the column value by using the method. The column value should then be converted to another type. + ]]> The value type of the underlying column could not be cast to the type specified by the generic parameter, . @@ -183,25 +183,25 @@ - A generic parameter that specifies the return type of the column. + The return type of the column. The input , which acts as the instance for the extension method. The column index. - Provides strongly-typed access to each of the column values in the specified row. The method also supports nullable types. + Provides strongly typed access to each of the column values in the specified row. The method also supports nullable types. The value, of type , of the specified by . - class represents **null** values with the instance of the class. A Language-Integrated Query (LINQ) expression that accessed a column with a **null** value would generate a at run time. Additionally, doesn't support nullable types. The method provides support for accessing columns as nullable types. If the underlying value in the is , the returned nullable type will have a value of **null**. - - If the value of the specified is **null** and `T` is a reference type or nullable type, then the return type will be **null**. The method will not return . - - The method does not perform type conversions. If type conversion is required, you should first obtain the column value by using the method. The column value should then be converted to another type. - + class represents **null** values with the instance of the class. A Language-Integrated Query (LINQ) expression that accessed a column with a **null** value would generate a at run time. Additionally, doesn't support nullable types. The method provides support for accessing columns as nullable types. If the underlying value in the is , the returned nullable type will have a value of **null**. + + If the value of the specified is **null** and `T` is a reference type or nullable type, then the return type will be **null**. The method will not return . + + The method does not perform type conversions. If type conversion is required, you should first obtain the column value by using the method. The column value should then be converted to another type. + ]]> The value type of the underlying column could not be cast to the type specified by the generic parameter, . - The column specified by does not exist in the that the is a part of. + The column specified by does not exist in the that the is a part of. A **null** value was assigned to a non-nullable type. @@ -257,15 +257,15 @@ Provides strongly-typed access to each of the column values in the specified row. The method also supports nullable types. The value, of type , of the specified by . - class represents **null** values with the instance of the class. A Language-Integrated Query (LINQ) expression that accessed a column with a **null** value would generate a at run time. Additionally, and do not support nullable types. The method provides support for accessing columns as nullable types. If the underlying value in the is , the returned nullable type will have a value of **null**. - - If the value of the specified is **null** and `T` is a reference type or nullable type, the return type will be **null**. The method will not return . - - The method does not perform type conversions. If type conversion is required, you should first obtain the column value by using the method. The column value should then be converted to another type. - + class represents **null** values with the instance of the class. A Language-Integrated Query (LINQ) expression that accessed a column with a **null** value would generate a at run time. Additionally, and do not support nullable types. The method provides support for accessing columns as nullable types. If the underlying value in the is , the returned nullable type will have a value of **null**. + + If the value of the specified is **null** and `T` is a reference type or nullable type, the return type will be **null**. The method will not return . + + The method does not perform type conversions. If type conversion is required, you should first obtain the column value by using the method. The column value should then be converted to another type. + ]]> The value type of the underlying column could not be cast to the type specified by the generic parameter, . @@ -327,15 +327,15 @@ Provides strongly-typed access to each of the column values in the specified row. The method also supports nullable types. The value, of type , of the specified by and . - class represents **null** values with the instance of the class. A Language-Integrated Query (LINQ) expression that accessed a column with a **null** value would generate a at run time. Additionally, doesn't support nullable types. The method provides support for accessing columns as nullable types. If the underlying value in the is , the returned nullable type will have a value of **null**. - - If the value of the specified is null and `T` is a reference type or nullable type, then the return type will be **null**. The method will not return . - - The method does not perform type conversions. If type conversion is required, you should first obtain the column value by using the method. The column value should then be converted to another type. - + class represents **null** values with the instance of the class. A Language-Integrated Query (LINQ) expression that accessed a column with a **null** value would generate a at run time. Additionally, doesn't support nullable types. The method provides support for accessing columns as nullable types. If the underlying value in the is , the returned nullable type will have a value of **null**. + + If the value of the specified is null and `T` is a reference type or nullable type, then the return type will be **null**. The method will not return . + + The method does not perform type conversions. If type conversion is required, you should first obtain the column value by using the method. The column value should then be converted to another type. + ]]> The value type of the underlying column could not be cast to the type specified by the generic parameter, . @@ -395,21 +395,21 @@ The zero-based ordinal of the column to return the value of. A enumeration that specifies the version of the column value to return, such as or version. Provides strongly-typed access to each of the column values in the specified row. The method also supports nullable types. - The value, of type , of the specified by and . + The value, of type , of the specified by and . - class represents **null** values with the instance of the class. A Language-Integrated Query (LINQ) expression that accessed a column with a **null** value would generate a at run time. Additionally, doesn't support nullable types. The method provides support for accessing columns as nullable types. If the underlying value in the is , the returned nullable type will have a value of **null**. - - If the value of the specified is null and `T` is a reference type or nullable type, then the return type will be **null**. The method will not return . - - The method does not perform type conversions. If type conversion is required, you should first obtain the column value by using the method. The column value should then be converted to another type. - + class represents **null** values with the instance of the class. A Language-Integrated Query (LINQ) expression that accessed a column with a **null** value would generate a at run time. Additionally, doesn't support nullable types. The method provides support for accessing columns as nullable types. If the underlying value in the is , the returned nullable type will have a value of **null**. + + If the value of the specified is null and `T` is a reference type or nullable type, then the return type will be **null**. The method will not return . + + The method does not perform type conversions. If type conversion is required, you should first obtain the column value by using the method. The column value should then be converted to another type. + ]]> The value type of the underlying column could not be cast to the type specified by the generic parameter, . - The column specified by does not exist in the that the is a part of. + The column specified by does not exist in the that the is a part of. A **null** value was assigned to a non-nullable type. @@ -467,15 +467,15 @@ Provides strongly-typed access to each of the column values in the specified row. The method also supports nullable types. The value, of type , of the specified by and . - class represents **null** values with the instance of the class. A Language-Integrated Query (LINQ) expression that accessed a column with a **null** value would generate a at run time. Additionally, doesn't support nullable types. The method provides support for accessing columns as nullable types. If the underlying value in the is , the returned nullable type will have a value of **null**. - - If the value of the specified is null and `T` is a reference type or nullable type, then the return type will be **null**. The method will not return . - - The method does not perform type conversions. If type conversion is required, you should first obtain the column value by using the method. The column value should then be converted to another type. - + class represents **null** values with the instance of the class. A Language-Integrated Query (LINQ) expression that accessed a column with a **null** value would generate a at run time. Additionally, doesn't support nullable types. The method provides support for accessing columns as nullable types. If the underlying value in the is , the returned nullable type will have a value of **null**. + + If the value of the specified is null and `T` is a reference type or nullable type, then the return type will be **null**. The method will not return . + + The method does not perform type conversions. If type conversion is required, you should first obtain the column value by using the method. The column value should then be converted to another type. + ]]> The value type of the underlying column could not be cast to the type specified by the generic parameter, . @@ -552,15 +552,15 @@ The new row value for the specified column, of type . Sets a new value for the specified column in the . The method also supports nullable types. - method converts the **null** value to in the underlying . - - The method does not perform any type conversions. This does not mean, however, that a type conversion will not occur. The method exposes the ADO.NET 2.0 behavior of the class. A type conversion could be performed by the object and the converted value would then be saved to the row. - - Exceptions can be passed up through the method from the underlying object. - + method converts the **null** value to in the underlying . + + The method does not perform any type conversions. This does not mean, however, that a type conversion will not occur. The method exposes the ADO.NET 2.0 behavior of the class. A type conversion could be performed by the object and the converted value would then be saved to the row. + + Exceptions can be passed up through the method from the underlying object. + ]]> The column specified by cannot be found. @@ -622,19 +622,19 @@ The new row value for the specified column, of type . Sets a new value for the specified column in the the method is called on. The method also supports nullable types. - method converts the **null** value to in the underlying . - - The method does not perform any type conversions. This does not mean, however, that a type conversion will not occur. The method exposes the ADO.NET 2.0 behavior of the class. A type conversion could be performed by the object and the converted value would then be saved to the row. - - Exceptions can be passed up through the method from the underlying object. - + method converts the **null** value to in the underlying . + + The method does not perform any type conversions. This does not mean, however, that a type conversion will not occur. The method exposes the ADO.NET 2.0 behavior of the class. A type conversion could be performed by the object and the converted value would then be saved to the row. + + Exceptions can be passed up through the method from the underlying object. + ]]> Occurs when attempting to set a value on a deleted row. - The argument is out of range. + The argument is out of range. The value type of the underlying column could be not cast to the type specified by the generic parameter, . @@ -698,15 +698,15 @@ The new row value for the specified column, of type . Sets a new value for the specified column in the . The method also supports nullable types. - method converts the **null** value to in the underlying . - - The method does not perform any type conversions. This does not mean, however, that a type conversion will not occur. The method exposes the ADO.NET 2.0 behavior of the class. A type conversion could be performed by the object and the converted value would then be saved to the row. - - Exceptions can be passed up through the method from the underlying object. - + method converts the **null** value to in the underlying . + + The method does not perform any type conversions. This does not mean, however, that a type conversion will not occur. The method exposes the ADO.NET 2.0 behavior of the class. A type conversion could be performed by the object and the converted value would then be saved to the row. + + Exceptions can be passed up through the method from the underlying object. + ]]> The column specified by cannot be found. diff --git a/xml/System.Data/DataRowView.xml b/xml/System.Data/DataRowView.xml index d0d3c3ae4dc..2cb006705df 100644 --- a/xml/System.Data/DataRowView.xml +++ b/xml/System.Data/DataRowView.xml @@ -67,23 +67,23 @@ Represents a customized view of a . - control, only one version of each row can be displayed. The displayed row is a . - - A can have one of four different version states: `Default`, `Original`, `Current`, and `Proposed`. - - After invoking on a , any edited value becomes the `Proposed` value. Until either or is invoked, the row has an `Original` and a `Proposed` version. If is invoked, the proposed version is discarded, and the value reverts to `Original`. If is invoked, the no longer has a `Proposed` version; instead, the proposed value becomes the current value. Default values are available only on rows that have columns with default values defined. - - - -## Examples - The following example uses the property to determine the state of a row in the . (See for another example using .) - + control, only one version of each row can be displayed. The displayed row is a . + + A can have one of four different version states: `Default`, `Original`, `Current`, and `Proposed`. + + After invoking on a , any edited value becomes the `Proposed` value. Until either or is invoked, the row has an `Original` and a `Proposed` version. If is invoked, the proposed version is discarded, and the value reverts to `Original`. If is invoked, the no longer has a `Proposed` version; instead, the proposed value becomes the current value. Default values are available only on rows that have columns with default values defined. + + + +## Examples + The following example uses the property to determine the state of a row in the . (See for another example using .) + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_ADO.NET/DataWorks DataRowView.RowVersion1/CS/source.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/DataWorks DataRowView.RowVersion1/VB/source.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/DataWorks DataRowView.RowVersion1/VB/source.vb" id="Snippet1"::: + ]]> This type is safe for multithreaded read operations. You must synchronize any write operations. @@ -131,21 +131,21 @@ Begins an edit procedure. - to add a . - - The method is identical to the method of the . After calling , any changes made to the can be rolled back by calling . Call the method before allowing users to change row values. After values have been changed, you retrieve the new values by setting the to `DataRowVersion.Proposed`. Check the values with a business rule, and roll back the changes if needed by calling , or call to accept the changes. - - - -## Examples - The following example edits a row in a . calling the before, and afterwards. - + to add a . + + The method is identical to the method of the . After calling , any changes made to the can be rolled back by calling . Call the method before allowing users to change row values. After values have been changed, you retrieve the new values by setting the to `DataRowVersion.Proposed`. Check the values with a business rule, and roll back the changes if needed by calling , or call to accept the changes. + + + +## Examples + The following example edits a row in a . calling the before, and afterwards. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_ADO.NET/Classic WebData DataRowView.BeginEdit Example/CS/source.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData DataRowView.BeginEdit Example/VB/source.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData DataRowView.BeginEdit Example/VB/source.vb" id="Snippet1"::: + ]]> @@ -198,19 +198,19 @@ Cancels an edit procedure. - , all changes to the row are rolled back. You can also roll back changes by calling on the parent . - - - -## Examples - The following example edits a row in a . The method is called to cancel the changes if the validation fails. - + , all changes to the row are rolled back. You can also roll back changes by calling on the parent . + + + +## Examples + The following example edits a row in a . The method is called to cancel the changes if the validation fails. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_ADO.NET/Classic WebData DataRowView.BeginEdit Example/CS/source.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData DataRowView.BeginEdit Example/VB/source.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData DataRowView.BeginEdit Example/VB/source.vb" id="Snippet1"::: + ]]> @@ -410,8 +410,6 @@ Returns a for the child with the specified name and parent. a for the child . To be added. - - is . @@ -452,14 +450,14 @@ Gets the to which this row belongs. The to which this row belongs. - of the specified . - + of the specified . + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_ADO.NET/Classic WebData DataRowView.DataView Example/CS/source.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData DataRowView.DataView Example/VB/source.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData DataRowView.DataView Example/VB/source.vb" id="Snippet1"::: + ]]> @@ -502,22 +500,22 @@ Deletes a row. - is invoked on the that the row belongs to. - + is invoked on the that the row belongs to. + > [!NOTE] -> A may be invalid when a `DataRow` is deleted from the underlying table. When the becomes invalid, operations that access values associated with , such as , throw an exception. - - - -## Examples - The following example uses the method on a row. - +> A may be invalid when a `DataRow` is deleted from the underlying table. When the becomes invalid, operations that access values associated with , such as , throw an exception. + + + +## Examples + The following example uses the method on a row. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_ADO.NET/Classic WebData DataRowView.Delete Example/CS/source.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData DataRowView.Delete Example/VB/source.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData DataRowView.Delete Example/VB/source.vb" id="Snippet1"::: + ]]> @@ -564,13 +562,13 @@ Commits changes to the underlying and ends the editing session that was begun with . Use to discard the changes made to the . - . calling the before, and afterwards. - - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData DataRowView.EndEdit Example/VB/source.vb" id="Snippet1"::: - + . calling the before, and afterwards. + + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData DataRowView.EndEdit Example/VB/source.vb" id="Snippet1"::: + ]]> @@ -624,7 +622,7 @@ An to be compared. Gets a value indicating whether the current is identical to the specified object. - if is a and it returns the same row as the current ; otherwise . + if is a and it returns the same row as the current ; otherwise . if the row is new; otherwise . - , will be true for the returned . will be true until either is called on the , or is called again. (There is only one new row.) - + , will be true for the returned . will be true until either is called on the , or is called again. (There is only one new row.) + ]]> @@ -819,14 +817,14 @@ This method checks for reference equality instead of checking whether Gets or sets a value in a specified column. The value of the column. - in a . - + in a . + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_ADO.NET/Classic WebData DataRowView.this2 Example/CS/source.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData DataRowView.this2 Example/VB/source.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData DataRowView.this2 Example/VB/source.vb" id="Snippet1"::: + ]]> The doesn't allow edits and is not new. @@ -875,18 +873,18 @@ This method checks for reference equality instead of checking whether Gets or sets a value in a specified column. The value of the column. - . - + . + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_ADO.NET/Classic WebData DataRowView.this Example/CS/source.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData DataRowView.this Example/VB/source.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData DataRowView.this Example/VB/source.vb" id="Snippet1"::: + ]]> A column with the specified name or relation was not found. - + -or- The doesn't allow edits and is not new. @@ -939,11 +937,11 @@ The doesn't allow edits and Event that is raised when a property is changed. - changes. This change does not cause the associated index position of the to be changed. - + changes. This change does not cause the associated index position of the to be changed. + ]]> @@ -986,14 +984,14 @@ The doesn't allow edits and Gets the being viewed. The being viewed by the . - property to print the value of the third column in each modified row of a . - + property to print the value of the third column in each modified row of a . + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_ADO.NET/Classic WebData DataRowView.Row Example/CS/source.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData DataRowView.Row Example/VB/source.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData DataRowView.Row Example/VB/source.vb" id="Snippet1"::: + ]]> @@ -1038,19 +1036,19 @@ The doesn't allow edits and Gets the current version description of the . One of the values. Possible values for the property are , , , and . - property specifies both and settings. For more information, see , , and . - - - -## Examples - The following example uses the property to display the . - + property specifies both and settings. For more information, see , , and . + + + +## Examples + The following example uses the property to display the . + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_ADO.NET/DataWorks DataRowView.RowVersion1/CS/source.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/DataWorks DataRowView.RowVersion1/VB/source.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/DataWorks DataRowView.RowVersion1/VB/source.vb" id="Snippet1"::: + ]]> @@ -1101,11 +1099,11 @@ The doesn't allow edits and Returns a collection of custom attributes for this instance of a component. An AttributeCollection containing the attributes for this object. - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1152,11 +1150,11 @@ The doesn't allow edits and Returns the class name of this instance of a component. The class name of this instance of a component. - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1203,11 +1201,11 @@ The doesn't allow edits and Returns the name of this instance of a component. The name of this instance of a component. - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1260,11 +1258,11 @@ The doesn't allow edits and Returns a type converter for this instance of a component. The type converter for this instance of a component. - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1317,11 +1315,11 @@ The doesn't allow edits and Returns the default event for this instance of a component. The default event for this instance of a component. - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1374,11 +1372,11 @@ The doesn't allow edits and Returns the default property for this instance of a component. The default property for this instance of a component. - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1438,11 +1436,11 @@ The doesn't allow edits and Returns an editor of the specified type for this instance of a component. An of the specified type that is the editor for this object, or if the editor cannot be found. - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1456,11 +1454,11 @@ The doesn't allow edits and Returns the events for this instance of a component. - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1507,11 +1505,11 @@ The doesn't allow edits and Returns the events for this instance of a component. The events for this instance of a component. - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1567,11 +1565,11 @@ The doesn't allow edits and Returns the events for this instance of a component with specified attributes. The events for this instance of a component. - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1585,11 +1583,11 @@ The doesn't allow edits and Returns the properties for this instance of a component. - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1642,11 +1640,11 @@ The doesn't allow edits and Returns the properties for this instance of a component. The properties for this instance of a component. - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1702,11 +1700,11 @@ The doesn't allow edits and Returns the properties for this instance of a component with specified attributes. The properties for this instance of a component. - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1756,11 +1754,11 @@ The doesn't allow edits and Returns an object that contains the property described by the specified property descriptor. An that represents the owner of the specified property. - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1805,11 +1803,11 @@ The doesn't allow edits and Gets a message that describes any validation errors for the object. The validation error on the object. - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1858,11 +1856,11 @@ The doesn't allow edits and Gets the error message for the property with the given name. The error message for the property. The default is an empty string (""). - instance is cast to an interface. - + instance is cast to an interface. + ]]> diff --git a/xml/System.Data/DataSet.xml b/xml/System.Data/DataSet.xml index 52bf645b3ac..28925297000 100644 --- a/xml/System.Data/DataSet.xml +++ b/xml/System.Data/DataSet.xml @@ -3678,7 +3678,7 @@ class Program { ]]> - The is . + The is . Using DataSets in ADO.NET @@ -5384,7 +5384,7 @@ class Program { Gets or sets the serialization format for the that's used during remoting. One of the enumeration values that specifies the serialization format. To be added. - .NET 7 and later versions only: is . + .NET 7 and later versions only: The value being set is . Using DataSets in ADO.NET diff --git a/xml/System.Data/DataTable.xml b/xml/System.Data/DataTable.xml index d7650b6cb10..6f61f213023 100644 --- a/xml/System.Data/DataTable.xml +++ b/xml/System.Data/DataTable.xml @@ -5605,7 +5605,7 @@ public class A { Gets or sets the serialization format. One of the enumeration values that specifies the serialization format. To be added. - .NET 7 and later versions only: is . + .NET 7 and later versions only: The value being set is . DataTables From 55df97bb25479124ba3e13b148cee50d9f701ecd Mon Sep 17 00:00:00 2001 From: Genevieve Warren <24882762+gewarren@users.noreply.github.com> Date: Tue, 7 Jan 2025 11:29:13 -0800 Subject: [PATCH 5/5] Fix grammar (#10816) --- .../X509CertificateLoader.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/xml/System.Security.Cryptography.X509Certificates/X509CertificateLoader.xml b/xml/System.Security.Cryptography.X509Certificates/X509CertificateLoader.xml index c02da299710..e1a53f556dc 100644 --- a/xml/System.Security.Cryptography.X509Certificates/X509CertificateLoader.xml +++ b/xml/System.Security.Cryptography.X509Certificates/X509CertificateLoader.xml @@ -28,7 +28,7 @@ - Provides methods for loading an X.509 certificate or a PKCS#12 PFX containing certificates. + Provides methods for loading an X.509 certificate or a PKCS#12 PFX that contains certificates. To be added.