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