diff --git a/xml/System.Drawing.Design/ToolboxService.xml b/xml/System.Drawing.Design/ToolboxService.xml index deaad460ef7..f68efdf8336 100644 --- a/xml/System.Drawing.Design/ToolboxService.xml +++ b/xml/System.Drawing.Design/ToolboxService.xml @@ -30,13 +30,13 @@ Provides a default implementation of the interface. - class is a partial implementation of the interface. To use this implementation you must derive from this class and implement the abstract methods. Once implemented, you may add this class to your designer application's service container. There should be one toolbox service for each designer application. - - provides much of the complex logic of creating a toolbox service, but requires that you define the storage containers for categories and items. This allows for simple toolboxes or very complex ones. - + class is a partial implementation of the interface. To use this implementation you must derive from this class and implement the abstract methods. Once implemented, you may add this class to your designer application's service container. There should be one toolbox service for each designer application. + + provides much of the complex logic of creating a toolbox service, but requires that you define the storage containers for categories and items. This allows for simple toolboxes or very complex ones. + ]]> @@ -88,11 +88,11 @@ Gets a collection of strings depicting available categories of the toolbox. A collection of category names. - property may return an empty collection. - + property may return an empty collection. + ]]> @@ -130,20 +130,20 @@ Creates a new toolbox item container from a saved data object. A new toolbox item container. - method gives you the opportunity to provide a derived version of a . By default, the class does not support linked items, so it returns `null` for link parameters that are not `null`. To provide link support, you should override this method to create a derived that is capable of handling links. - - The data object passed in should contain data obtained from a prior call to the property on a toolbox item container. - + method gives you the opportunity to provide a derived version of a . By default, the class does not support linked items, so it returns `null` for link parameters that are not `null`. To provide link support, you should override this method to create a derived that is capable of handling links. + + The data object passed in should contain data obtained from a prior call to the property on a toolbox item container. + ]]> is . - A linked toolbox item is one whose existence is tied to the storage of a particular designer host. So, in a typical project system, a designer host is associated with a particular file. A toolbox item linked to a designer host would automatically be deleted from the toolbox when the designer host's source file is deleted or removed from the project. - + A linked toolbox item is one whose existence is tied to the storage of a particular designer host. So, in a typical project system, a designer host is associated with a particular file. A toolbox item linked to a designer host would automatically be deleted from the toolbox when the designer host's source file is deleted or removed from the project. + Linked toolbox items make possible scenarios such as disabling the ASP.NET toolbox items when the Windows Forms designer is open. @@ -174,20 +174,20 @@ Creates a new toolbox item container from a toolbox item. A new toolbox item container. - method gives you the opportunity to provide a derived version of a . By default, the class does not support linked items, so it returns `null` for link parameters that are not `null`. To provide link support, you should override this method to create a derived that is capable of handling links. - - If the provided link parameter is assigned, it indicates that this is a linked toolbox item. - + method gives you the opportunity to provide a derived version of a . By default, the class does not support linked items, so it returns `null` for link parameters that are not `null`. To provide link support, you should override this method to create a derived that is capable of handling links. + + If the provided link parameter is assigned, it indicates that this is a linked toolbox item. + ]]> is . - A linked toolbox item is one whose existence is tied to the storage of a particular designer host. So, in a typical project system, a designer host is associated with a particular file. A toolbox item linked to a designer host would automatically be deleted from the toolbox when the designer host's source file is deleted or removed from the project. - + A linked toolbox item is one whose existence is tied to the storage of a particular designer host. So, in a typical project system, a designer host is associated with a particular file. A toolbox item linked to a designer host would automatically be deleted from the toolbox when the designer host's source file is deleted or removed from the project. + Linked toolbox items make possible scenarios such as disabling the ASP.NET toolbox items when the Windows Forms designer is open. @@ -223,15 +223,15 @@ Returns an containing all items on the toolbox. - objects. If the toolbox implementation is organized in categories, this retrieves a combined list of all categories. The list must be read/write, as new items may be added to it. - - When the toolbox service adds a new item, it first calls the method and then adds the new item to the returned from the method. - - If a category name is provided, only the items in that category should be returned. If no category is specified, all items should be returned. - + objects. If the toolbox implementation is organized in categories, this retrieves a combined list of all categories. The list must be read/write, as new items may be added to it. + + When the toolbox service adds a new item, it first calls the method and then adds the new item to the returned from the method. + + If a category name is provided, only the items in that category should be returned. If no category is specified, all items should be returned. + ]]> @@ -283,11 +283,11 @@ Returns an containing all items in a given category. An containing all items in the category specified by . - method should throw a meaningful exception. - + method should throw a meaningful exception. + ]]> @@ -405,25 +405,25 @@ Returns an of objects for the given assembly. A collection containing all the toolbox items in the assembly represented by the given assembly name. - method scans the assembly for all types that support toolbox items, and return items for those types. To support a toolbox item, a type must have the following characteristics: - -- Be public. - -- Implement . - -- Not be abstract. - -- Not have a set to `false` on its type. - -- Not contain generic parameters. - - Assemblies are locked for the duration of a process, so enumerating various files through can cause many assemblies to be loaded. The methods that take an assembly name create a separate to search assemblies. When you are finished enumerating objects for a set of assemblies, you can call the method, which unloads the and frees the file references on the loaded assemblies. - - Assemblies loaded in this manner are loaded into a separate so they can later be unloaded. This only momentarily locks the assembly file. - + method scans the assembly for all types that support toolbox items, and return items for those types. To support a toolbox item, a type must have the following characteristics: + +- Be public. + +- Implement . + +- Not be abstract. + +- Not have a set to `false` on its type. + +- Not contain generic parameters. + + Assemblies are locked for the duration of a process, so enumerating various files through can cause many assemblies to be loaded. The methods that take an assembly name create a separate to search assemblies. When you are finished enumerating objects for a set of assemblies, you can call the method, which unloads the and frees the file references on the loaded assemblies. + + Assemblies loaded in this manner are loaded into a separate so they can later be unloaded. This only momentarily locks the assembly file. + ]]> @@ -465,23 +465,23 @@ Returns an containing all the toolbox items in the given assembly. A collection containing all the toolbox items in the given assembly. - method scans the assembly for all types that support toolbox items, and return items for those types. To support a toolbox item, a type must have the following characteristics: - -- Be public. - -- Implement . - -- Not be abstract. - -- Not have a set to `false` on its type. - -- Not contain generic parameters. - - Assemblies are locked for the duration of a process, so enumerating various files through can cause many assemblies to be loaded. The methods that take an assembly name create a separate to search assemblies. When you are finished enumerating objects for a set of assemblies, you can call the method, which unloads the and frees the file references on the loaded assemblies. - + method scans the assembly for all types that support toolbox items, and return items for those types. To support a toolbox item, a type must have the following characteristics: + +- Be public. + +- Implement . + +- Not be abstract. + +- Not have a set to `false` on its type. + +- Not contain generic parameters. + + Assemblies are locked for the duration of a process, so enumerating various files through can cause many assemblies to be loaded. The methods that take an assembly name create a separate to search assemblies. When you are finished enumerating objects for a set of assemblies, you can call the method, which unloads the and frees the file references on the loaded assemblies. + ]]> @@ -517,23 +517,23 @@ Returns an of objects for the given assembly. A collection containing all the toolbox items in the assembly represented by the given assembly name. - method scans the assembly for all types that support toolbox items, and return items for those types. To support a toolbox item, a type must have the following characteristics: - -- Be public. - -- Implement . - -- Not be abstract. - -- Not have a set to `false` on its type. - -- Not contain generic parameters. - - Assemblies are locked for the duration of a process, so enumerating various files through can cause many assemblies to be loaded. The methods that take an assembly name create a separate to search assemblies. When you are finished enumerating objects for a set of assemblies, you can call the method, which unloads the and frees the file references on the loaded assemblies. - + method scans the assembly for all types that support toolbox items, and return items for those types. To support a toolbox item, a type must have the following characteristics: + +- Be public. + +- Implement . + +- Not be abstract. + +- Not have a set to `false` on its type. + +- Not contain generic parameters. + + Assemblies are locked for the duration of a process, so enumerating various files through can cause many assemblies to be loaded. The methods that take an assembly name create a separate to search assemblies. When you are finished enumerating objects for a set of assemblies, you can call the method, which unloads the and frees the file references on the loaded assemblies. + ]]> @@ -569,23 +569,23 @@ Returns an of objects for the given assembly. A collection containing all the toolbox items in the assembly represented by the given assembly name. - method scans the assembly for all types that support toolbox items, and return items for those types. To support a toolbox item, a type must have the following characteristics: - -- Be public. - -- Implement . - -- Not be abstract. - -- Not have a set to `false` on its type. - -- Not contain generic parameters. - - Assemblies are locked for the duration of a process, so enumerating various files through can cause many assemblies to be loaded. The methods that take an assembly name create a separate to search assemblies. When you are finished enumerating objects for a set of assemblies, you can call the method, which unloads the and frees the file references on the loaded assemblies. - + method scans the assembly for all types that support toolbox items, and return items for those types. To support a toolbox item, a type must have the following characteristics: + +- Be public. + +- Implement . + +- Not be abstract. + +- Not have a set to `false` on its type. + +- Not contain generic parameters. + + Assemblies are locked for the duration of a process, so enumerating various files through can cause many assemblies to be loaded. The methods that take an assembly name create a separate to search assemblies. When you are finished enumerating objects for a set of assemblies, you can call the method, which unloads the and frees the file references on the loaded assemblies. + ]]> @@ -619,13 +619,13 @@ if the given data object represents an item container; otherwise, . - method searches toolbox item creators that are associated with the designer host. If `host` is supplied, toolbox item creators that are associated with the host are also compared. - + method searches toolbox item creators that are associated with the designer host. If `host` is supplied, toolbox item creators that are associated with the host are also compared. + ]]> @@ -684,11 +684,11 @@ Refreshes the state of the toolbox items. - method is called by the toolbox service when a user has requested that the collection of items should be refreshed. If the collection is always current, there is no need to provide any implementation here. If the collection returned from represents a snapshot of the toolbox items, however, this method provides an opportunity to update them. - + method is called by the toolbox service when a user has requested that the collection of items should be refreshed. If the collection is always current, there is no need to provide any implementation here. If the collection returned from represents a snapshot of the toolbox items, however, this method provides an opportunity to update them. + ]]> @@ -713,11 +713,11 @@ Gets or sets the name of the currently selected category. A string containing the name of the currently selected category. - @@ -770,11 +770,11 @@ Receives a call from the toolbox service when a user reports that a selected toolbox item has been used. - method is called by the toolbox service when a user reports that the selected toolbox item has been used. After invoking a toolbox item, it is a common user interface (UI) behavior to cancel the selection of that toolbox item. The default implementation of this method cancels the selection of the toolbox item by setting the selected item container to `null`. - + method is called by the toolbox service when a user reports that the selected toolbox item has been used. After invoking a toolbox item, it is a common user interface (UI) behavior to cancel the selection of that toolbox item. The default implementation of this method cancels the selection of the toolbox item by setting the selected item container to `null`. + ]]> @@ -801,11 +801,11 @@ if there is an item selected; otherwise, . - method can be called to set the cursor. It returns `true` if the cursor is set, or `false` if it is not. The default implementation sets the cursor to a crosshair and returns `true` if there is an item selected. It returns `false` and leaves the cursor unchanged if no item is selected. - + method can be called to set the cursor. It returns `true` if the cursor is set, or `false` if it is not. The default implementation sets the cursor to a crosshair and returns `true` if there is an item selected. It returns `false` and leaves the cursor unchanged if no item is selected. + ]]> @@ -878,11 +878,11 @@ The data format that the creator handles. For a description of this member, see the method. - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -917,11 +917,11 @@ The that represents the designer host to associate with the creator. For a description of this member, see the method. - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -963,11 +963,11 @@ The for the current design document. For a description of this member, see the method. - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1002,11 +1002,11 @@ The for the current design document. For a description of this member, see the method. - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1046,11 +1046,11 @@ The to add to the toolbox. For a description of this member, see the method. - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1083,11 +1083,11 @@ The toolbox item category to add the to. For a description of this member, see the method. - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1121,11 +1121,11 @@ For a description of this member, see the property. A containing the tool categories. - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1166,11 +1166,11 @@ For a description of this member, see the method. The created from deserialization. - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1204,11 +1204,11 @@ For a description of this member, see the method. The created from deserialization. - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1246,11 +1246,11 @@ For a description of this member, see the method. The that is currently selected, or if no toolbox item is currently selected. - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1282,11 +1282,11 @@ For a description of this member, see the method. The that is currently selected, or if no toolbox item is currently selected. - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1385,7 +1385,7 @@ A that contains the current toolbox items that are associated with the specified category. To be added. - is . + is . @@ -1783,11 +1783,11 @@ This member is an explicit interface member implementation. It can be used only For a description of this member, see the property. The name of the currently selected category. - instance is cast to an interface. - + instance is cast to an interface. + ]]> diff --git a/xml/System.Drawing.Drawing2D/GraphicsPath.xml b/xml/System.Drawing.Drawing2D/GraphicsPath.xml index b505c35a39e..700d7fb02ec 100644 --- a/xml/System.Drawing.Drawing2D/GraphicsPath.xml +++ b/xml/System.Drawing.Drawing2D/GraphicsPath.xml @@ -5437,7 +5437,7 @@ System.Drawing.Drawing2D.PathData - Gets a that encapsulates arrays of points () and types () for this . + Gets a that encapsulates arrays of points and types for this . A that encapsulates arrays for both the points and types for this . To be added. diff --git a/xml/System.Drawing.Imaging/EncoderParameter.xml b/xml/System.Drawing.Imaging/EncoderParameter.xml index c1660ceb079..fb7884dcfef 100644 --- a/xml/System.Drawing.Imaging/EncoderParameter.xml +++ b/xml/System.Drawing.Imaging/EncoderParameter.xml @@ -544,7 +544,7 @@ An object that encapsulates the globally unique identifier of the parameter category. An integer that specifies the number of values stored in the object. The property is set to this value. A member of the enumeration that specifies the data type of the values stored in the object. The and properties are set to this value. - A pointer to an array of values of the type specified by the parameter. + A pointer to an array of values of the type specified by the parameter. Initializes a new instance of the class with the specified object, number of values, data type of the values, and a pointer to the values stored in the object. To be added. diff --git a/xml/System.Drawing/ColorConverter.xml b/xml/System.Drawing/ColorConverter.xml index 4c2349697cf..445eeacf329 100644 --- a/xml/System.Drawing/ColorConverter.xml +++ b/xml/System.Drawing/ColorConverter.xml @@ -46,20 +46,20 @@ Converts colors from one data type to another. Access this class through the . - the expects the unqualified color name; otherwise, an exception will occur in the conversion process. For example, you should pass "Blue", not "System.Drawing.Color.Blue" or "Color.Blue", to the method. - - - -## Examples - The following code example demonstrates how to use the method. This example is designed to be used with Windows Forms. Paste this code into a form and call the `ShowColorConverter` method when handling the form's event, passing `e` as . - + the expects the unqualified color name; otherwise, an exception will occur in the conversion process. For example, you should pass "Blue", not "System.Drawing.Color.Blue" or "Color.Blue", to the method. + + + +## Examples + The following code example demonstrates how to use the method. This example is designed to be used with Windows Forms. Paste this code into a form and call the `ShowColorConverter` method when handling the form's event, passing `e` as . + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Winforms/System.Drawing.Converters/CPP/form1.cpp" id="Snippet2"::: :::code language="csharp" source="~/snippets/csharp/System.Drawing/ColorConverter/Overview/form1.cs" id="Snippet2"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/System.Drawing.Converters/VB/form1.vb" id="Snippet2"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/System.Drawing.Converters/VB/form1.vb" id="Snippet2"::: + ]]> @@ -202,8 +202,8 @@ - An that provides a format context. - A that represents the type to which you want to convert. + A format context. + The type to which you want to convert. Returns a value indicating whether this converter can convert an object to the given destination type using the context. if this converter can perform the operation; otherwise, . @@ -262,11 +262,11 @@ Converts the given object to the converter's native type. An representing the converted value. - the expects the unqualified color name; otherwise, an exception will occur in the conversion process. For example, you should pass "Blue", not "System.Drawing.Color.Blue" or "Color.Blue", to the method. - + the expects the unqualified color name; otherwise, an exception will occur in the conversion process. For example, you should pass "Blue", not "System.Drawing.Color.Blue" or "Color.Blue", to the method. + ]]> The conversion cannot be performed. @@ -326,15 +326,15 @@ Converts the specified object to another type. An representing the converted value. - - is . + is . The conversion cannot be performed. diff --git a/xml/System.Drawing/Graphics.xml b/xml/System.Drawing/Graphics.xml index 417dca4e84b..4cd9ede5e98 100644 --- a/xml/System.Drawing/Graphics.xml +++ b/xml/System.Drawing/Graphics.xml @@ -14340,11 +14340,9 @@ The object has a transform applied othe ## Examples The following code example is designed for use with Windows Forms, and it requires `e`, which is a parameter of the event handler. The code performs the following action: -- Creates a solid blue brush. - -- Creates an array of three rectangles. - -- Fills the three rectangular areas on the screen. +- Creates a solid blue brush. +- Creates an array of three rectangles. +- Fills the three rectangular areas on the screen. :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Winforms/System.Drawing.ClassicGraphicsExamples3/CPP/form1.cpp" id="Snippet116"::: :::code language="csharp" source="~/snippets/csharp/System.Drawing/Graphics/FillRectangle/form1.cs" id="Snippet116"::: @@ -14359,7 +14357,7 @@ The object has a transform applied othe is . - is a zero-length array. + is a zero-length array. @@ -17154,7 +17152,7 @@ The object has a transform applied othe that represents formatting information, such as line spacing, for the string. Measures the specified string when drawn with the specified and formatted with the specified . - This method returns a structure that represents the size, in the units specified by the property, of the string specified in the parameter as drawn with the parameter and the parameter. + This method returns a structure that represents the size, in the units specified by the property, of the string specified in the parameter as drawn with the parameter and the parameter. - The is or does not contain image data. + The is or does not contain image data. @@ -539,7 +539,7 @@ ]]> - The is or does not contain image data. + The is or does not contain image data. diff --git a/xml/System.Globalization/CompareInfo.xml b/xml/System.Globalization/CompareInfo.xml index 2d921125e8f..d03f52b844c 100644 --- a/xml/System.Globalization/CompareInfo.xml +++ b/xml/System.Globalization/CompareInfo.xml @@ -184,18 +184,14 @@ By default, the comparison is performed by using . If a security decision depends on a string comparison or a case change, you should use the property to ensure that the behavior is consistent regardless of the culture settings of the operating system. > [!NOTE] -> When possible, you should call string comparison methods that have a parameter of type to specify the kind of comparison expected. As a general rule, use linguistic options (using the current culture) for comparing strings displayed in the user interface and specify or for security comparisons. - - +> When possible, you should call string comparison methods that have a parameter of type to specify the kind of comparison expected. As a general rule, use linguistic options (using the current culture) for comparing strings displayed in the user interface and specify or for security comparisons. ## Examples The following example compares portions of two strings using the different objects: -- object associated with the Spanish (Spain) culture with international sort - -- object associated with the Spanish (Spain) culture with traditional sort - -- object associated with the +- object associated with the Spanish (Spain) culture with international sort +- object associated with the Spanish (Spain) culture with traditional sort +- object associated with the :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR_System/system.Globalization.CompareInfo.CompareStrStr/CPP/comparestrstr.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Globalization/CompareInfo/Compare/comparestrstr.cs" id="Snippet1"::: @@ -3441,7 +3437,7 @@ This method has greater overhead than other A string of zero or more Unicode characters. Indicates whether a specified Unicode string is sortable. - if the parameter is not an empty string ("") and all the Unicode characters in are sortable; otherwise, . + if the parameter is not an empty string ("") and all the Unicode characters in are sortable; otherwise, . - is . + is . diff --git a/xml/System.Globalization/CultureAndRegionInfoBuilder.xml b/xml/System.Globalization/CultureAndRegionInfoBuilder.xml index 5defbf9e7da..1d44f75ff61 100644 --- a/xml/System.Globalization/CultureAndRegionInfoBuilder.xml +++ b/xml/System.Globalization/CultureAndRegionInfoBuilder.xml @@ -89,7 +89,7 @@ The following code example creates a custom culture with a private use prefix, t -or- - specifies an alternate sort replacement culture instead of a .NET Framework culture. For example, is "de-de_phoneb", a culture that sorts strings as they appear in a German telephone book, instead of "de-DE", the German (Germany) culture. + specifies an alternate sort replacement culture instead of a .NET Framework culture. For example, is "de-de_phoneb", a culture that sorts strings as they appear in a German telephone book, instead of "de-DE", the German (Germany) culture. -or- diff --git a/xml/System.Globalization/EastAsianLunisolarCalendar.xml b/xml/System.Globalization/EastAsianLunisolarCalendar.xml index 8ce33de0ae9..1476eb023ba 100644 --- a/xml/System.Globalization/EastAsianLunisolarCalendar.xml +++ b/xml/System.Globalization/EastAsianLunisolarCalendar.xml @@ -65,18 +65,18 @@ Represents a calendar that divides time into months, days, years, and eras, and has dates that are based on cycles of the sun and the moon. - class supports the sexagenary cycle of years (which repeats every 60 years) in addition to solar years and lunar months. Each solar year in the calendar is associated with a Sexagenary Year (see ), a Celestial Stem (see ), and a Terrestrial Branch (see ). - + class supports the sexagenary cycle of years (which repeats every 60 years) in addition to solar years and lunar months. Each solar year in the calendar is associated with a Sexagenary Year (see ), a Celestial Stem (see ), and a Terrestrial Branch (see ). + > [!NOTE] -> For information about using the class and the other calendar classes in the .NET Framework, see [Working with Calendars](/dotnet/standard/datetime/working-with-calendars). - - A year can have a leap month after any month of the year, and a month can have a leap day. For example, the method returns a positive integer that indicates the month associated with a specified date. If there is a leap month between the eighth and ninth months of the year, the method returns 8 for the eighth month, 9 for the leap eighth month, and 10 for the ninth month. - - Each supports a set of calendars. Currently, none of the lunisolar calendar classes that derive from is used by any of the cultures supported by the class. Therefore, this class and those that derive from it can be used only to calculate dates in the East Asian lunisolar calendars. This class supports several "get" methods to describe a in the terms used by lunisolar calendars, and the method to convert from lunisolar calendar data to a . - +> For information about using the class and the other calendar classes in the .NET Framework, see [Working with Calendars](/dotnet/standard/datetime/working-with-calendars). + + A year can have a leap month after any month of the year, and a month can have a leap day. For example, the method returns a positive integer that indicates the month associated with a specified date. If there is a leap month between the eighth and ninth months of the year, the method returns 8 for the eighth month, 9 for the leap eighth month, and 10 for the ninth month. + + Each supports a set of calendars. Currently, none of the lunisolar calendar classes that derive from is used by any of the cultures supported by the class. Therefore, this class and those that derive from it can be used only to calculate dates in the East Asian lunisolar calendars. This class supports several "get" methods to describe a in the terms used by lunisolar calendars, and the method to convert from lunisolar calendar data to a . + ]]> Working with Calendars @@ -130,28 +130,28 @@ Calculates the date that is the specified number of months away from the specified date. A new that results from adding the specified number of months to the parameter. - is affected if the resulting day is not a valid day in the resulting month of the resulting year. In this case, the day part is changed to the last valid day in the resulting month of the resulting year. The year part of the resulting is affected if the resulting month is outside the year of the specified . This implementation supports only the current era. Therefore, is thrown if the resulting year is outside the era of the specified . The time-of-day part of the resulting remains the same as the specified . - - For example, if the specified month is October, which has 31 days, the specified day is the thirty-first day of that month, and the value of the `months` parameter is 6, the resulting year is one more than the specified year, the resulting month is April, and the resulting day is the thirtieth day, which is the last day in April. - - If the value of the `months` parameter is negative, the resulting is earlier than the specified . - - The property of the returned value always equals . You can preserve the property of the `time` parameter by calling the method, as the following example shows. - + is affected if the resulting day is not a valid day in the resulting month of the resulting year. In this case, the day part is changed to the last valid day in the resulting month of the resulting year. The year part of the resulting is affected if the resulting month is outside the year of the specified . This implementation supports only the current era. Therefore, is thrown if the resulting year is outside the era of the specified . The time-of-day part of the resulting remains the same as the specified . + + For example, if the specified month is October, which has 31 days, the specified day is the thirty-first day of that month, and the value of the `months` parameter is 6, the resulting year is one more than the specified year, the resulting month is April, and the resulting day is the thirtieth day, which is the last day in April. + + If the value of the `months` parameter is negative, the resulting is earlier than the specified . + + The property of the returned value always equals . You can preserve the property of the `time` parameter by calling the method, as the following example shows. + :::code language="csharp" source="~/snippets/csharp/System.Globalization/Calendar/AddDays/add1.cs" id="Snippet5"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.globalization.calendar.addmethods/vb/add1.vb" id="Snippet5"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.globalization.calendar.addmethods/vb/add1.vb" id="Snippet5"::: + ]]> The result is outside the supported range of a . - is less than -120000 or greater than 120000. - - -or- - + is less than -120000 or greater than 120000. + + -or- + is less than or greater than . @@ -203,20 +203,20 @@ Calculates the date that is the specified number of years away from the specified date. A new that results from adding the specified number of years to the parameter. - is affected if the resulting day is not a valid day in the resulting month of the resulting year. In this case, the day part is changed to the last valid day in the resulting month of the resulting year. The month part of the resulting remains the same as the specified . This implementation supports only the current era. Therefore, is thrown if the resulting year is outside the era of the specified . The time-of-day part of the resulting remains the same as the specified . - - For example, February has 28 days, except during leap years when it has 29 days. If the specified date is the twenty-ninth day of February in a leap year and the value of the `years` parameter is 1, the resulting date will be the twenty-eighth day of February in the following year. - - If `years` is negative, the resulting is earlier than the specified . - - The property of the returned value always equals . You can preserve the property of the `time` parameter by calling the method, as the following example shows. - + is affected if the resulting day is not a valid day in the resulting month of the resulting year. In this case, the day part is changed to the last valid day in the resulting month of the resulting year. The month part of the resulting remains the same as the specified . This implementation supports only the current era. Therefore, is thrown if the resulting year is outside the era of the specified . The time-of-day part of the resulting remains the same as the specified . + + For example, February has 28 days, except during leap years when it has 29 days. If the specified date is the twenty-ninth day of February in a leap year and the value of the `years` parameter is 1, the resulting date will be the twenty-eighth day of February in the following year. + + If `years` is negative, the resulting is earlier than the specified . + + The property of the returned value always equals . You can preserve the property of the `time` parameter by calling the method, as the following example shows. + :::code language="csharp" source="~/snippets/csharp/System.Globalization/Calendar/AddDays/add1.cs" id="Snippet8"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.globalization.calendar.addmethods/vb/add1.vb" id="Snippet8"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.globalization.calendar.addmethods/vb/add1.vb" id="Snippet8"::: + ]]> The result is outside the supported range of a . @@ -460,11 +460,11 @@ Calculates the day of the year in the specified date. An integer from 1 through 354 in a common year, or 1 through 384 in a leap year, that represents the day of the year specified in the parameter. - for the first day of the first month returns 1, and for the last day of the last month returns the total number of days in that year, which is the same value returned by . - + for the first day of the first month returns 1, and for the last day of the last month returns the total number of days in that year, which is the same value returned by . + ]]> @@ -519,11 +519,11 @@ Calculates the number of days in the specified month of the specified year and era. The number of days in the specified month of the specified year and era. - method returns 28 or 29, depending on whether the `year` parameter is a leap year. - + method returns 28 or 29, depending on whether the `year` parameter is a leap year. + ]]> @@ -578,11 +578,11 @@ Calculates the number of days in the specified year and era. The number of days in the specified year and era. - method returns 365 or 366, depending on whether the `year` parameter is a leap year. - + method returns 365 or 366, depending on whether the `year` parameter is a leap year. + ]]> @@ -635,17 +635,17 @@ An integer that represents the year. An integer that represents the era. Calculates the leap month for the specified year and era. - A positive integer from 1 through 13 that indicates the leap month in the specified year and era. - - -or- - + A positive integer from 1 through 13 that indicates the leap month in the specified year and era. + + -or- + Zero if this calendar does not support a leap month, or if the and parameters do not specify a leap year. - method returns a number from 1 through 13 that indicates the month associated with a specified date. If there is a leap month between the eighth and ninth months of the year, the method returns 8 for the eighth month, 9 for the leap eighth month, and 10 for the ninth month. - + method returns a number from 1 through 13 that indicates the month associated with a specified date. If there is a leap month between the eighth and ninth months of the year, the method returns 8 for the eighth month, 9 for the leap eighth month, and 10 for the ninth month. + ]]> @@ -794,7 +794,7 @@ A to read. Calculates the year in the sexagenary (60-year) cycle that corresponds to the specified date. - A number from 1 through 60 in the sexagenary cycle that corresponds to the parameter. + A number from 1 through 60 in the sexagenary cycle that corresponds to the parameter. To be added. @@ -1121,11 +1121,11 @@ Returns a that is set to the specified date, time, and era. A that is set to the specified date, time, and era. - method can convert any date in the current calendar to a Gregorian calendar date. The Gregorian date can subsequently be used, for example, to compare dates in different calendars or create an equivalent date in a particular calendar. - + method can convert any date in the current calendar to a Gregorian calendar date. The Gregorian date can subsequently be used, for example, to compare dates in different calendars or create an equivalent date in a particular calendar. + ]]> @@ -1178,13 +1178,13 @@ Converts the specified year to a four-digit year. An integer that contains the four-digit representation of the parameter. - method uses the property to determine the appropriate century. - - supports either a two-digit year or a four-digit year. Passing a two-digit year value (less than 100) causes the method to convert the value to a four-digit value according to the value representing the appropriate century. If the application supplies a four-digit year value that is within the supported calendar range to , the method returns the actual input value. If the application supplies a four-digit value that is outside the supported calendar range, or if it supplies a negative value, the method throws an exception. - + method uses the property to determine the appropriate century. + + supports either a two-digit year or a four-digit year. Passing a two-digit year value (less than 100) causes the method to convert the value to a four-digit value according to the value representing the appropriate century. If the application supplies a four-digit year value that is within the supported calendar range to , the method returns the actual input value. If the application supplies a four-digit value that is outside the supported calendar range, or if it supplies a negative value, the method throws an exception. + ]]> @@ -1233,13 +1233,13 @@ Gets or sets the last year of a 100-year range that can be represented by a 2-digit year. The last year of a 100-year range that can be represented by a 2-digit year. - . The class does not detect changes in the system settings automatically. - + . The class does not detect changes in the system settings automatically. + ]]> The current is read-only. diff --git a/xml/System.Globalization/NumberFormatInfo.xml b/xml/System.Globalization/NumberFormatInfo.xml index 7a8598e2009..0825e4736f7 100644 --- a/xml/System.Globalization/NumberFormatInfo.xml +++ b/xml/System.Globalization/NumberFormatInfo.xml @@ -562,7 +562,7 @@ On Windows, the initial value of this property is derived from the settings in t Gets or sets the format pattern for negative currency values. - The format pattern for negative currency values. The default for is 0, which represents "(\\$n)", where "\\$" is the and is a number. + The format pattern for negative currency values. The default for is 0, which represents "(\\$n)", where "\\$" is the and "n" is a number. Gets or sets the format pattern for positive currency values. - The format pattern for positive currency values. The default for is 0, which represents "\\$n", where "\\$" is the and is a number. + The format pattern for positive currency values. The default for is 0, which represents "\\$n", where "\\$" is the and "n" is a number. Gets or sets the format pattern for negative percent values. - The format pattern for negative percent values. The default for is 0, which represents "-n %", where "%" is the and is a number. + The format pattern for negative percent values. The default for is 0, which represents "-n %", where "%" is the and "n" is a number. Gets or sets the format pattern for positive percent values. - The format pattern for positive percent values. The default for is 0, which represents "n %", where "%" is the and is a number. + The format pattern for positive percent values. The default for is 0, which represents "n %", where "%" is the and "n" is a number. - is a zero-length string, contains only whitespace, + is a zero-length string, contains only whitespace, 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 (for example, it is on an unmapped drive). The name of a is zero-length, contains only whitespace, or contains one or more invalid characters as defined by . -or- -Extracting a would have resulted in a destination file that is outside (for example, if the entry name contains parent directory accessors). +Extracting a would have resulted in a destination file that is outside (for example, if the entry name contains parent directory accessors). -or- A has the same name as an already extracted entry from the same archive. The caller does not have the required permission. - is in an invalid format. + is in an invalid format. A was not found or was corrupt. -or- diff --git a/xml/System.IO.IsolatedStorage/IsolatedStorageFile.xml b/xml/System.IO.IsolatedStorage/IsolatedStorageFile.xml index 6c358172fe3..3945d48e08b 100644 --- a/xml/System.IO.IsolatedStorage/IsolatedStorageFile.xml +++ b/xml/System.IO.IsolatedStorage/IsolatedStorageFile.xml @@ -1949,7 +1949,7 @@ ]]> Sufficient isolated storage permissions have not been granted. - The identity has not been passed in. + The identity has not been passed in. The is invalid. An isolated storage location cannot be initialized. @@ -2804,9 +2804,9 @@ ]]> - or is a zero-length string, contains only white space, or contains one or more invalid characters defined by the method. + or is a zero-length string, contains only white space, or contains one or more invalid characters defined by the method. - or is . + or is . The isolated store has been closed. The isolated store has been disposed. diff --git a/xml/System.IO.IsolatedStorage/IsolatedStorageFileStream.xml b/xml/System.IO.IsolatedStorage/IsolatedStorageFileStream.xml index 712cc71d809..54070838c13 100644 --- a/xml/System.IO.IsolatedStorage/IsolatedStorageFileStream.xml +++ b/xml/System.IO.IsolatedStorage/IsolatedStorageFileStream.xml @@ -480,7 +480,7 @@ A bitwise combination of the values. A bitwise combination of the values. The buffer size. - Initializes a new instance of the class giving access to the file designated by , in the specified , with the specified file , using the file sharing mode specified by , with the specified. + Initializes a new instance of the class giving access to the file designated by , in the specified , with the specified file , using the file sharing mode specified by , with the specified. A bitwise combination of the values. The buffer size. The in which to open the . - Initializes a new instance of the class giving access to the file designated by , in the specified , with the specified file , using the file sharing mode specified by , with the specified, and in the context of the specified by . + Initializes a new instance of the class giving access to the file designated by , in the specified , with the specified file , using the file sharing mode specified by , with the specified, and in the context of the specified by . [!CAUTION] -> When you compile a set of characters with a particular cultural setting and retrieve those same characters with a different cultural setting, the characters might not be interpretable, and can cause an exception to be thrown. - - +> When you compile a set of characters with a particular cultural setting and retrieve those same characters with a different cultural setting, the characters might not be interpretable, and can cause an exception to be thrown. ## Examples The following code example demonstrates the use of this constructor. For the complete context of this example, see the overview. diff --git a/xml/System.IO.Packaging/PackUriHelper.xml b/xml/System.IO.Packaging/PackUriHelper.xml index 37b5758e709..2db279bb29a 100644 --- a/xml/System.IO.Packaging/PackUriHelper.xml +++ b/xml/System.IO.Packaging/PackUriHelper.xml @@ -1024,7 +1024,7 @@ This method does not inspect the part contents; it is based solely on the name. The URI of the source part, or "/" to designate the root. The relative URI to the target part. Returns a part URI given a source part URI and a URI with a relative path to a target part. - The URI of the target part resolved between the specified and the parameters. + The URI of the target part resolved between the specified and the parameters. - Provides a base class for parts stored in a . This class is abstract. + Provides a base class for parts stored in a . This class is abstract. property of the part is initialized to . - `contentType` must be a MIME type formed in accordance with the [RFC 2616](https://www.w3.org/Protocols/rfc2616/rfc2616.html) *Hypertext Transfer Protocol - HTTP*, Section 3.7. The following table shows an example of the content MIME types used in XML Paper Specification (XPS) documents. + `contentType` must be a MIME type formed in accordance with the [RFC 2616](https://www.w3.org/Protocols/rfc2616/rfc2616.html) *Hypertext Transfer Protocol - HTTP*, Section 3.7. The following table shows an example of the content MIME types used in XML Paper Specification (XPS) documents. |Description|Content Type| |-----------------|------------------| @@ -266,7 +266,7 @@ ## Remarks `partUri` must be valid URI formed in accordance with the [RFC 3986](https://tools.ietf.org/html/rfc3986) *Uniform Resource Identifier (URI) Generic Syntax* specification and the [Open Packaging Conventions](https://www.ecma-international.org/publications-and-standards/standards/ecma-376/) specification. - `contentType` must be a MIME type formed in accordance with the [RFC 2616](https://www.w3.org/Protocols/rfc2616/rfc2616.html) *Hypertext Transfer Protocol - HTTP*, Section 3.7. The following table shows an example of the content MIME types used in XML Paper Specification (XPS) documents. + `contentType` must be a MIME type formed in accordance with the [RFC 2616](https://www.w3.org/Protocols/rfc2616/rfc2616.html) *Hypertext Transfer Protocol - HTTP*, Section 3.7. The following table shows an example of the content MIME types used in XML Paper Specification (XPS) documents. |Description|Content Type| |-----------------|------------------| @@ -327,7 +327,7 @@ ## Remarks is a read-only property that can be accessed only when the parent is open. - The property is automatically set by the constructor. After it is set by the constructor, the cannot be changed. + The property is automatically set by the constructor. After it is set by the constructor, the cannot be changed. ]]> @@ -375,9 +375,9 @@ ## Remarks is a read-only property that can be accessed only when the parent is open. - The property is automatically set by the constructor. After it is set by the constructor, the cannot be changed. + The property is automatically set by the constructor. After it is set by the constructor, the cannot be changed. - The property is a MIME type formed in accordance with the [RFC 2616](https://www.w3.org/Protocols/rfc2616/rfc2616.html) *Hypertext Transfer Protocol - HTTP*, Section 3.7. The following table shows an example of the content MIME types used in XML Paper Specification (XPS) documents. + The property is a MIME type formed in accordance with the [RFC 2616](https://www.w3.org/Protocols/rfc2616/rfc2616.html) *Hypertext Transfer Protocol - HTTP*, Section 3.7. The following table shows an example of the content MIME types used in XML Paper Specification (XPS) documents. |Description|Content Type| |-----------------|------------------| @@ -416,13 +416,13 @@ to a target inside the . - Between a source to a target resource outside the package. - In a part-relationship the source part is considered the "owner" of the relationship. When the source part is deleted, all the relationships owned by the part are also deleted. The process of creating or deleting the relationship does not physically alter the target part or resource in any way. + In a part-relationship the source part is considered the "owner" of the relationship. When the source part is deleted, all the relationships owned by the part are also deleted. The process of creating or deleting the relationship does not physically alter the target part or resource in any way. The method does not physically change either the source part, or the target part or resource in any way. @@ -485,34 +485,33 @@ to a target inside the . - -- Between a source to a target resource outside the package. +- Between a source to a target inside the . +- Between a source to a target resource outside the package. - In a part-relationship the source part is considered the "owner" of the relationship. When the source part is deleted, all the relationships owned by the part are also deleted. The process of creating or deleting the relationship does not physically alter the target part or resource in any way. + In a part-relationship the source part is considered the "owner" of the relationship. When the source part is deleted, all the relationships owned by the part are also deleted. The process of creating or deleting the relationship does not physically alter the target part or resource in any way. The method does not physically change either the source part, or the target part or resource in any way. The target of a relationship cannot be another relationship. - If `targetMode` is specified as , `targetUri` must be a relative URI that is formed in accordance with the [RFC 3986](https://tools.ietf.org/html/rfc3986) *Uniform Resource Identifier (URI) Generic Syntax* specification. The internal relative URI can be either an absolute path that starts with a forward slash ("/") character such as "/page1.xaml" or "/images/picture4.jpg", or a relative path such as "../imagespicture1.jpg" that resolves against the package root ("/") as the base URI. + If `targetMode` is specified as , `targetUri` must be a relative URI that is formed in accordance with the [RFC 3986](https://tools.ietf.org/html/rfc3986) *Uniform Resource Identifier (URI) Generic Syntax* specification. The internal relative URI can be either an absolute path that starts with a forward slash ("/") character such as "/page1.xaml" or "/images/picture4.jpg", or a relative path such as "../imagespicture1.jpg" that resolves against the package root ("/") as the base URI. - If `targetMode` is specified as , `targetUri` can be either an absolute or relative URI formed in accordance with the [RFC 3986](https://tools.ietf.org/html/rfc3986) *Uniform Resource Identifier (URI) Generic Syntax* specification. `"https://www.microsoft.com/page2.xml"` is an example of an absolute URI that references an external target resource "page2.xml". "images/picture1.jpg" is an example of a relative URI that also references an external target resource "1.jpg" but which resolves against the URI of the package itself. + If `targetMode` is specified as , `targetUri` can be either an absolute or relative URI formed in accordance with the [RFC 3986](https://tools.ietf.org/html/rfc3986) *Uniform Resource Identifier (URI) Generic Syntax* specification. `"https://www.microsoft.com/page2.xml"` is an example of an absolute URI that references an external target resource "page2.xml". "images/picture1.jpg" is an example of a relative URI that also references an external target resource "1.jpg" but which resolves against the URI of the package itself. - `relationshipType` must be a URI that is formed according to the [RFC 3986](https://tools.ietf.org/html/rfc3986) *Uniform Resource Identifier (URI) Generic Syntax* specification. Different package types can define different part-level relationship types. The following table shows the part-level `relationshipType` URIs defined for documents that conform to the *Open XML Paper Specification (XPS)*. + `relationshipType` must be a URI that is formed according to the [RFC 3986](https://tools.ietf.org/html/rfc3986) *Uniform Resource Identifier (URI) Generic Syntax* specification. Different package types can define different part-level relationship types. The following table shows the part-level `relationshipType` URIs defined for documents that conform to the *Open XML Paper Specification (XPS)*. -|XPS Document Part-Level Relationship|Relationship Type URI| -|-------------------------------------------|---------------------------| -|Digital Signature Definitions|`http://schemas.microsoft.com/xps/2005/06/signature-definitions`| -|DiscardControl|`http://schemas.microsoft.com/xps/2005/06/discard-control`| -|DocumentStructure|`http://schemas.microsoft.com/xps/2005/06/documentstructure`| -|PrintTicket|`http://schemas.microsoft.com/xps/2005/06/printticket`| -|Required Resource|`http://schemas.microsoft.com/xps/2005/06/required-resource`| -|Restricted Font|`http://schemas.microsoft.com/xps/2005/06/restricted-font`| -|StartPart|`http://schemas.microsoft.com/xps/2005/06/fixedrepresentation`| -|StoryFragments|`http://schemas.microsoft.com/xps/2005/06/storyfragments`| +| XPS Document Part-Level Relationship | Relationship Type URI | +|--------------------------------------|------------------------------------------------------------------| +| Digital Signature Definitions | `http://schemas.microsoft.com/xps/2005/06/signature-definitions` | +| DiscardControl | `http://schemas.microsoft.com/xps/2005/06/discard-control` | +| DocumentStructure | `http://schemas.microsoft.com/xps/2005/06/documentstructure` | +| PrintTicket | `http://schemas.microsoft.com/xps/2005/06/printticket` | +| Required Resource | `http://schemas.microsoft.com/xps/2005/06/required-resource` | +| Restricted Font | `http://schemas.microsoft.com/xps/2005/06/restricted-font` | +| StartPart | `http://schemas.microsoft.com/xps/2005/06/fixedrepresentation` | +| StoryFragments | `http://schemas.microsoft.com/xps/2005/06/storyfragments` | For more information about package relationships see section 1.3 of the *Open Packaging Conventions (OPC)* specification available for download at . @@ -594,36 +593,36 @@ to a target inside the . +A part-level relationship defines an association between this part and a target part or resource. A part-level relationship can be one of two forms: -- Between a source to a target resource outside the package. +- Between a source to a target inside the . +- Between a source to a target resource outside the package. - In a part-relationship the source part is considered the "owner" of the relationship. When the source part is deleted, all the relationships owned by the part are also deleted. The process of creating or deleting the relationship does not physically alter the target part or resource in any way. + In a part-relationship the source part is considered the "owner" of the relationship. When the source part is deleted, all the relationships owned by the part are also deleted. The process of creating or deleting the relationship does not physically alter the target part or resource in any way. - `id` must be a valid XML identifier. The `id` type is xsd:ID and must follow the naming conventions prescribed in the *XML Schema Part 2: Datatypes* specification (see [https://www.w3.org/TR/xmlschema-2/#ID](https://www.w3.org/TR/xmlschema-2/#ID)). + `id` must be a valid XML identifier. The `id` type is xsd:ID and must follow the naming conventions prescribed in the *XML Schema Part 2: Datatypes* specification (see [https://www.w3.org/TR/xmlschema-2/#ID](https://www.w3.org/TR/xmlschema-2/#ID)). The method does not physically change either the source part, or the target part or resource in any way. The target of a relationship cannot be another relationship. - If `targetMode` is specified as , `targetUri` must be a relative URI that is formed in accordance with the [RFC 3986](https://tools.ietf.org/html/rfc3986) *Uniform Resource Identifier (URI) Generic Syntax* specification. The internal relative URI can be either an absolute path that starts with a forward slash ("/") character such as "/page1.xaml" or "/images/picture4.jpg", or a relative path such as "../imagespicture1.jpg" that resolves against the package root ("/") as the base URI. + If `targetMode` is specified as , `targetUri` must be a relative URI that is formed in accordance with the [RFC 3986](https://tools.ietf.org/html/rfc3986) *Uniform Resource Identifier (URI) Generic Syntax* specification. The internal relative URI can be either an absolute path that starts with a forward slash ("/") character such as "/page1.xaml" or "/images/picture4.jpg", or a relative path such as "../imagespicture1.jpg" that resolves against the package root ("/") as the base URI. - If `targetMode` is specified as , `targetUri` can be either an absolute or relative URI formed in accordance with the [RFC 3986](https://tools.ietf.org/html/rfc3986) *Uniform Resource Identifier (URI) Generic Syntax* specification. "https://www.microsoft.com/page2.xml" is an example of an absolute URI that references an external target resource "page2.xml". "images/picture1.jpg" is an example of a relative URI that also references an external target resource "1.jpg" but which resolves against the URI of the package itself. + If `targetMode` is specified as , `targetUri` can be either an absolute or relative URI formed in accordance with the [RFC 3986](https://tools.ietf.org/html/rfc3986) *Uniform Resource Identifier (URI) Generic Syntax* specification. "https://www.microsoft.com/page2.xml" is an example of an absolute URI that references an external target resource "page2.xml". "images/picture1.jpg" is an example of a relative URI that also references an external target resource "1.jpg" but which resolves against the URI of the package itself. - `relationshipType` must be a URI that is formed according to the [RFC 3986](https://tools.ietf.org/html/rfc3986) *Uniform Resource Identifier (URI) Generic Syntax* specification. Different package types can define different part-level relationship types. The following table shows the part-level `relationshipType` URIs defined for documents that conform to the *Open XML Paper Specification (XPS)*. + `relationshipType` must be a URI that is formed according to the [RFC 3986](https://tools.ietf.org/html/rfc3986) *Uniform Resource Identifier (URI) Generic Syntax* specification. Different package types can define different part-level relationship types. The following table shows the part-level `relationshipType` URIs defined for documents that conform to the *Open XML Paper Specification (XPS)*. -|XPS Document Part-Level Relationship|Relationship Type URI| -|-------------------------------------------|---------------------------| -|Digital Signature Definitions|http://schemas.microsoft.com/xps/2005/06/signature-definitions| -|DiscardControl|http://schemas.microsoft.com/xps/2005/06/discard-control| -|DocumentStructure|http://schemas.microsoft.com/xps/2005/06/documentstructure| -|PrintTicket|http://schemas.microsoft.com/xps/2005/06/printticket| -|Required Resource|http://schemas.microsoft.com/xps/2005/06/required-resource| -|Restricted Font|http://schemas.microsoft.com/xps/2005/06/restricted-font| -|StartPart|http://schemas.microsoft.com/xps/2005/06/fixedrepresentation| -|StoryFragments|http://schemas.microsoft.com/xps/2005/06/storyfragments| +| XPS Document Part-Level Relationship | Relationship Type URI | +|--------------------------------------|------------------------------------------------------------------| +| Digital Signature Definitions | `http://schemas.microsoft.com/xps/2005/06/signature-definitions` | +| DiscardControl | `http://schemas.microsoft.com/xps/2005/06/discard-control` | +| DocumentStructure | `http://schemas.microsoft.com/xps/2005/06/documentstructure` | +| PrintTicket | `http://schemas.microsoft.com/xps/2005/06/printticket` | +| Required Resource | `http://schemas.microsoft.com/xps/2005/06/required-resource` | +| Restricted Font | `http://schemas.microsoft.com/xps/2005/06/restricted-font` | +| StartPart | `http://schemas.microsoft.com/xps/2005/06/fixedrepresentation` | +| StoryFragments | `http://schemas.microsoft.com/xps/2005/06/storyfragments` | For more information about package relationships see section 1.3 of the *Open Packaging Conventions (OPC)* specification available for download at . @@ -696,7 +695,7 @@ for any of the relationships that are owned by this part, no relationship is deleted and no exception is thrown. @@ -758,7 +757,7 @@ ## Remarks is a virtual method of the abstract base class. Implement this method only in derived types where the value for the content type cannot be provided at the time of construction, or if calculating the content type value is a nontrivial or costly operation. The return value must be a valid MIME content type. - Derived classes can call to initialize the property of the derived class to a default value. After the property has been set it cannot be changed. + Derived classes can call to initialize the property of the derived class to a default value. After the property has been set it cannot be changed. ]]> @@ -803,7 +802,7 @@ method to determine if a relationship with a specified is owned by this part. @@ -813,8 +812,6 @@ is . is not a valid XML identifier. - - is an empty string. The part has been deleted. -or- @@ -957,7 +954,7 @@ internally calls the derived method to actually open and return the part data stream based on the physical format implemented in the derived class. - By default, the subclass implementation of the abstract class is provided and used. In the default operation, internally calls of the class to open and return the part data stream from a ZIP file. + By default, the subclass implementation of the abstract class is provided and used. In the default operation, internally calls of the class to open and return the part data stream from a ZIP file. @@ -1012,7 +1009,7 @@ internally calls the derived method to actually open and return the part data stream based on the physical format implemented in the derived class. - By default, the subclass implementation of the abstract class is provided and used. In the default operation, internally calls of the class to open and return the part data stream from a ZIP file. + By default, the subclass implementation of the abstract class is provided and used. In the default operation, internally calls of the class to open and return the part data stream from a ZIP file. @@ -1073,7 +1070,7 @@ internally calls the derived method to actually open and return the part data stream based on the physical format implemented in the derived class. - By default, the subclass implementation of the abstract class is provided and used. In the default operation, internally calls of the class to open and return the part data stream from a ZIP file. + By default, the subclass implementation of the abstract class is provided and used. In the default operation, internally calls of the class to open and return the part data stream from a ZIP file. @@ -1129,7 +1126,7 @@ -or- - The parameter is specified as but the parameter requires write access. ( values of , , , and require or access.) + The parameter is specified as but the parameter requires write access. ( values of , , , and require or access.) -or- @@ -1138,7 +1135,7 @@ internally calls the derived method to actually open and return the part data stream based on the physical format implemented in the derived class. - By default, the subclass implementation of the abstract class is provided and used. In the default operation, internally calls of the class to open and return the part data stream from a ZIP file. + By default, the subclass implementation of the abstract class is provided and used. In the default operation, internally calls of the class to open and return the part data stream from a ZIP file. @@ -1193,7 +1190,7 @@ The derived method is called by the methods to open and return the part data stream based on the physical format implemented in the derived class. - By default, the subclass implementation of the abstract class is provided and used. In the default operation, internally calls of the class to open and return the part data stream from a ZIP file. + By default, the subclass implementation of the abstract class is provided and used. In the default operation, internally calls of the class to open and return the part data stream from a ZIP file. @@ -1233,7 +1230,7 @@ ## Remarks is a read-only property that can be accessed only when the parent is open. - The property is automatically set by the constructor. After it is set by the constructor, the parent for the part cannot be changed. + The property is automatically set by the constructor. After it is set by the constructor, the parent for the part cannot be changed. ]]> @@ -1283,7 +1280,7 @@ @@ -1340,7 +1337,7 @@ ## Remarks is a read-only property that can be accessed only when the parent is open. - The property is automatically set by the constructor. After it is set by the constructor, the of the part cannot be changed. + The property is automatically set by the constructor. After it is set by the constructor, the of the part cannot be changed. ]]> diff --git a/xml/System.IO.Packaging/PackageStore.xml b/xml/System.IO.Packaging/PackageStore.xml index 784d20e87ae..02ea5355a64 100644 --- a/xml/System.IO.Packaging/PackageStore.xml +++ b/xml/System.IO.Packaging/PackageStore.xml @@ -29,27 +29,27 @@ Represents a collection of application-specific instances used in combination with . - defines a reference collections of package that are open and active in the application. Packages added to the are accessed is by their key URI value. The supports three common uses: - -1. Accessing data through . - -2. The application obtaining an instance of a given the package's URI. - -3. Accessing packages that are created and stored in a . - - To improve performance and minimize the overhead of repeated file open/close operations, the is used to manage instances of packages accessed by and directly by the application. When accessing data in a package, the address of a requested is first checked to see if the package is already defined and open in the . If the package is defined as open in the , requested parts can be accessed directly without repeatedly opening and closing the package for each request. - - If your application opens a package with , can be called to add the package to the . should later be called to remove the package from the prior to calling . - - XPS packages opened with an constructor are automatically added and removed from the when the document is created and disposed. (You do not need to call or separately for XPS packages opened with constructors.) - - The file I/O permissions of a package accessed through the remains the same as the I/O permissions set on the package when it is opened. The only provides references to the packages that have been added the store. It is up to the application to correctly open, update, and close each package. - - Packages added to the can be accessed in multithreaded environments when they are used in combination with a XAML parser such as . When operating in a multithreaded environment, the application must lock the package before access. - + defines a reference collections of package that are open and active in the application. Packages added to the are accessed is by their key URI value. The supports three common uses: + +1. Accessing data through . + +2. The application obtaining an instance of a given the package's URI. + +3. Accessing packages that are created and stored in a . + + To improve performance and minimize the overhead of repeated file open/close operations, the is used to manage instances of packages accessed by and directly by the application. When accessing data in a package, the address of a requested is first checked to see if the package is already defined and open in the . If the package is defined as open in the , requested parts can be accessed directly without repeatedly opening and closing the package for each request. + + If your application opens a package with , can be called to add the package to the . should later be called to remove the package from the prior to calling . + + XPS packages opened with an constructor are automatically added and removed from the when the document is created and disposed. (You do not need to call or separately for XPS packages opened with constructors.) + + The file I/O permissions of a package accessed through the remains the same as the I/O permissions set on the package when it is opened. The only provides references to the packages that have been added the store. It is up to the application to correctly open, update, and close each package. + + Packages added to the can be accessed in multithreaded environments when they are used in combination with a XAML parser such as . When operating in a multithreaded environment, the application must lock the package before access. + ]]> @@ -86,32 +86,30 @@ The package to add to the store. Adds a to the store. - . - - If the `packageUri` matches the for a in a call, the package defined in the is used to access the requested part. - - If the `packageUri` does not match the for a in a call, the package with the specified URI is opened to access the requested part. - - **Security Note** This method demands for all custom (non-) types. - - - -## Examples - The following example shows how to use the method. - + . + + If the `uri` matches the for a in a call, the package defined in the is used to access the requested part. + + If the `uri` does not match the for a in a call, the package with the specified URI is opened to access the requested part. + + **Security Note** This method demands for all custom (non-) types. + +## Examples + The following example shows how to use the method. + :::code language="csharp" source="~/snippets/csharp/System.IO.Packaging/PackageStore/AddPackage/Window1.xaml.cs" id="Snippetrmpkgviewdecrypt"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/RightsManagedPackageViewer/visualbasic/window1.xaml.vb" id="Snippetrmpkgviewdecrypt"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/RightsManagedPackageViewer/visualbasic/window1.xaml.vb" id="Snippetrmpkgviewdecrypt"::: + ]]> is . - is an invalid package URI. - A package with the specified is already in the store. + is an invalid package URI. + A package with the specified is already in the store. @@ -143,29 +141,28 @@ The uniform resource identifier (URI) of the package to return. Returns the with a specified URI from the store. - The package with a specified ; or , if a package with the specified is not in the store. + The package with a specified ; or , if a package with the specified is not in the store. - method call. - - **Security Note** This method demands for all custom (non-) types. - - - -## Examples - The following example shows how to use the method. - + method call. + +**Security Note** This method demands for all custom (non-) types. + +## Examples + The following example shows how to use the method. + :::code language="csharp" source="~/snippets/csharp/System.IO.Packaging/PackageStore/AddPackage/Window1.xaml.cs" id="Snippetrmpkgviewopendoc"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/RightsManagedPackageViewer/visualbasic/window1.xaml.vb" id="Snippetrmpkgviewopendoc"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/RightsManagedPackageViewer/visualbasic/window1.xaml.vb" id="Snippetrmpkgviewopendoc"::: + ]]> - is . + is . - is an invalid package URI. + is an invalid package URI. @@ -198,27 +195,26 @@ The uniform resource identifier (URI) of the package to remove. Removes the with a specified URI from the store. - method call. - - **Security Note** This method demands for all custom (non-) types. - - - -## Examples - The following example shows how to use the method. - + method call. + +**Security Note** This method demands for all custom (non-) types. + +## Examples + The following example shows how to use the method. + :::code language="csharp" source="~/snippets/csharp/System.IO.Packaging/PackageStore/AddPackage/Window1.xaml.cs" id="Snippetrmpkgviewclosedoc"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/RightsManagedPackageViewer/visualbasic/window1.xaml.vb" id="Snippetrmpkgviewclosedoc"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/RightsManagedPackageViewer/visualbasic/window1.xaml.vb" id="Snippetrmpkgviewclosedoc"::: + ]]> - is . + is . - is an invalid package URI. + is an invalid package URI. diff --git a/xml/System.IO.Pipes/NamedPipeServerStream.xml b/xml/System.IO.Pipes/NamedPipeServerStream.xml index 97c0c744518..3f2c7bc806b 100644 --- a/xml/System.IO.Pipes/NamedPipeServerStream.xml +++ b/xml/System.IO.Pipes/NamedPipeServerStream.xml @@ -135,21 +135,21 @@ This example is for the server process, which uses the object that has the following characteristics: -- A default pipe direction of . +- A default pipe direction of . -- The maximum number of server instances that share the same name set to 1. +- The maximum number of server instances that share the same name set to 1. -- A value of . +- A value of . -- A value of . +- A value of . -- Default input and output buffer sizes. +- Default input and output buffer sizes. -- No pipe security. +- No pipe security. -- A value of . +- A value of . -- No specified additional . +- No specified additional . ]]> @@ -219,17 +219,17 @@ This example is for the server process, which uses the object that has the following characteristics: -- A value of . +- A value of . -- A value of . +- A value of . -- Default input and output buffer sizes. +- Default input and output buffer sizes. -- No pipe security. +- No pipe security. -- A value of . +- A value of . -- No specified additional . +- No specified additional . @@ -313,19 +313,13 @@ This example is for the server process, which uses the object that has the following characteristics: -- A default value of 1 for the maximum number of server instances that share the same name. - -- A default value of . - -- A value of . - -- Default input and output buffer sizes. - -- No pipe security. - -- A value of . - -- No specified additional . +- A default value of 1 for the maximum number of server instances that share the same name. +- A default value of . +- A value of . +- Default input and output buffer sizes. +- No pipe security. +- A value of . +- No specified additional . ]]> @@ -346,7 +340,7 @@ This example is for the server process, which uses the is less than -1 or greater than 254 (-1 indicates ) + is less than -1 or greater than 254 (-1 indicates ) -or- @@ -489,15 +483,11 @@ This example is for the server process, which uses the object that has the following characteristics: -- A default value of . - -- Default input and output buffer sizes. - -- No pipe security. - -- A value of . - -- No specified additional . +- A default value of . +- Default input and output buffer sizes. +- No pipe security. +- A value of . +- No specified additional . ]]> @@ -514,7 +504,7 @@ This example is for the server process, which uses the is less than -1 or greater than 254 (-1 indicates ) + is less than -1 or greater than 254 (-1 indicates ) contains a colon (":"). The maximum number of server instances has been exceeded. @@ -581,13 +571,10 @@ This example is for the server process, which uses the object that has the following characteristics: -- Default input and output buffer sizes. - -- No pipe security. - -- A value of . - -- No specified additional . +- Default input and output buffer sizes. +- No pipe security. +- A value of . +- No specified additional . ]]> @@ -604,7 +591,7 @@ This example is for the server process, which uses the is less than -1 or greater than 254 (-1 indicates ) + is less than -1 or greater than 254 (-1 indicates ) -or- @@ -679,11 +666,9 @@ This example is for the server process, which uses the object that has the following characteristics: -- No additional pipe security. - -- A default value of . - -- No specified additional . +- No additional pipe security. +- A default value of . +- No specified additional . ]]> @@ -700,7 +685,7 @@ This example is for the server process, which uses the is less than -1 or greater than 254 (-1 indicates ) + is less than -1 or greater than 254 (-1 indicates ) -or- @@ -769,9 +754,8 @@ This example is for the server process, which uses the object that has the following characteristics: -- A default value of . - -- No specified additional . +- A default value of . +- No specified additional . ]]> @@ -788,7 +772,7 @@ This example is for the server process, which uses the is less than -1 or greater than 254 (-1 indicates ) + is less than -1 or greater than 254 (-1 indicates ) -or- @@ -874,7 +858,7 @@ This example is for the server process, which uses the is less than -1 or greater than 254 (-1 indicates ) + is less than -1 or greater than 254 (-1 indicates ) -or- @@ -959,7 +943,7 @@ This example is for the server process, which uses the is less than -1 or greater than 254 (-1 indicates ) + is less than -1 or greater than 254 (-1 indicates ) -or- diff --git a/xml/System.IO.Pipes/PipeStream.xml b/xml/System.IO.Pipes/PipeStream.xml index 4ecab9ba415..87a97d9a2bc 100644 --- a/xml/System.IO.Pipes/PipeStream.xml +++ b/xml/System.IO.Pipes/PipeStream.xml @@ -176,7 +176,7 @@ -or- - is less than 0. + is less than 0. diff --git a/xml/System.IO/BufferedStream.xml b/xml/System.IO/BufferedStream.xml index 00036620383..9ef19ba4a58 100644 --- a/xml/System.IO/BufferedStream.xml +++ b/xml/System.IO/BufferedStream.xml @@ -73,37 +73,37 @@ Adds a buffering layer to read and write operations on another stream. This class cannot be inherited. - and methods of `BufferedStream` automatically maintain the buffer. - + and methods of `BufferedStream` automatically maintain the buffer. + > [!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. - - `BufferedStream` can be composed around certain types of streams. It provides implementations for reading and writing bytes to an underlying data source or repository. Use and for reading and writing other data types. `BufferedStream` is designed to prevent the buffer from slowing down input and output when the buffer is not needed. If you always read and write for sizes greater than the internal buffer size, then `BufferedStream` might not even allocate the internal buffer. `BufferedStream` also buffers reads and writes in a shared buffer. It is assumed that you will almost always be doing a series of reads or writes, but rarely alternate between the two of them. - - - -## Examples - The following code examples show how to use the `BufferedStream` class over the `NetworkStream` class to increase the performance of certain I/O operations. Start the server on a remote computer before starting the client. Specify the remote computer name as a command-line argument when starting the client. Vary the `dataArraySize` and `streamBufferSize` constants to view their effect on performance. - - The first example shows the code that runs on the client, and the second example shows the code that runs on the server. - - **Example 1: Code that runs on the client** - +> 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. + + `BufferedStream` can be composed around certain types of streams. It provides implementations for reading and writing bytes to an underlying data source or repository. Use and for reading and writing other data types. `BufferedStream` is designed to prevent the buffer from slowing down input and output when the buffer is not needed. If you always read and write for sizes greater than the internal buffer size, then `BufferedStream` might not even allocate the internal buffer. `BufferedStream` also buffers reads and writes in a shared buffer. It is assumed that you will almost always be doing a series of reads or writes, but rarely alternate between the two of them. + + + +## Examples + The following code examples show how to use the `BufferedStream` class over the `NetworkStream` class to increase the performance of certain I/O operations. Start the server on a remote computer before starting the client. Specify the remote computer name as a command-line argument when starting the client. Vary the `dataArraySize` and `streamBufferSize` constants to view their effect on performance. + + The first example shows the code that runs on the client, and the second example shows the code that runs on the server. + + **Example 1: Code that runs on the client** + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR_System/system.IO.BufferedStream1/CPP/client.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.IO/BufferedStream/Overview/client.cs" id="Snippet1"::: :::code language="fsharp" source="~/snippets/fsharp/System.IO/BufferedStream/Overview/client.fs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.IO.BufferedStream1/VB/client.vb" id="Snippet1"::: - - **Example 2: Code that runs on the server** - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.IO.BufferedStream1/VB/client.vb" id="Snippet1"::: + + **Example 2: Code that runs on the server** + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR_System/system.IO.BufferedStream2/CPP/server.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.IO/BufferedStream/Overview/server.cs" id="Snippet1"::: :::code language="fsharp" source="~/snippets/fsharp/System.IO/BufferedStream/Overview/server.fs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.IO.BufferedStream2/VB/server.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.IO.BufferedStream2/VB/server.vb" id="Snippet1"::: + ]]> @@ -168,11 +168,11 @@ The current stream. Initializes a new instance of the class with a default buffer size of 4096 bytes. - @@ -229,21 +229,21 @@ The buffer size in bytes. Initializes a new instance of the class with the specified buffer size. - class. - + class. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR_System/system.IO.BufferedStream1/CPP/client.cpp" id="Snippet2"::: :::code language="csharp" source="~/snippets/csharp/System.IO/BufferedStream/Overview/client.cs" id="Snippet2"::: :::code language="fsharp" source="~/snippets/fsharp/System.IO/BufferedStream/Overview/client.fs" id="Snippet2"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.IO.BufferedStream1/VB/client.vb" id="Snippet2"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.IO.BufferedStream1/VB/client.vb" id="Snippet2"::: + ]]> @@ -325,18 +325,18 @@ Begins an asynchronous read operation. (Consider using instead.) An object that represents the asynchronous read, which could still be pending. - and to implement asynchronous file operations. These methods are still available in the .NET Framework 4.5 to support legacy code; however, the new async methods, such as , , and , help you implement asynchronous file operations more easily. - - must be called exactly once for every call to . Failing to end a read process before beginning another read can cause undesirable behavior such as deadlock. - + and to implement asynchronous file operations. These methods are still available in the .NET Framework 4.5 to support legacy code; however, the new async methods, such as , , and , help you implement asynchronous file operations more easily. + + must be called exactly once for every call to . Failing to end a read process before beginning another read can cause undesirable behavior such as deadlock. + > [!NOTE] -> Use the property to determine whether the current instance supports reading. - - must be called with this to find out how many bytes were read. - +> Use the property to determine whether the current instance supports reading. + + must be called with this to find out how many bytes were read. + ]]> @@ -418,13 +418,13 @@ Begins an asynchronous write operation. (Consider using instead.) An object that references the asynchronous write which could still be pending. - and to implement asynchronous file operations. These methods are still available in the .NET Framework 4.5 to support legacy code; however, the new async methods, such as , , and , help you implement asynchronous file operations more easily. - - must be called exactly once on every from . will block until the I/O operation has completed. - + and to implement asynchronous file operations. These methods are still available in the .NET Framework 4.5 to support legacy code; however, the new async methods, such as , , and , help you implement asynchronous file operations more easily. + + must be called exactly once on every from . will block until the I/O operation has completed. + ]]> @@ -523,23 +523,23 @@ if the stream supports reading; if the stream is closed or was opened with write-only access. - does not support reading, calls to the , , , , and the `Peek` methods of , , and throw a . - - If the stream is closed, this property returns `false`. - - - -## Examples - This code example is part of a larger example provided for the class. - + does not support reading, calls to the , , , , and the `Peek` methods of , , and throw a . + + If the stream is closed, this property returns `false`. + + + +## Examples + This code example is part of a larger example provided for the class. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR_System/system.IO.BufferedStream1/CPP/client.cpp" id="Snippet5"::: :::code language="csharp" source="~/snippets/csharp/System.IO/BufferedStream/Overview/client.cs" id="Snippet5"::: :::code language="fsharp" source="~/snippets/fsharp/System.IO/BufferedStream/Overview/client.fs" id="Snippet5"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.IO.BufferedStream1/VB/client.vb" id="Snippet5"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.IO.BufferedStream1/VB/client.vb" id="Snippet5"::: + ]]> @@ -594,23 +594,23 @@ if the stream supports seeking; if the stream is closed or if the stream was constructed from an operating system handle such as a pipe or output to the console. - does not support seeking, calls to , , , and throw a . - - If the stream is closed, this property returns `false`. - - - -## Examples - This code example is part of a larger example provided for the class. - + does not support seeking, calls to , , , and throw a . + + If the stream is closed, this property returns `false`. + + + +## Examples + This code example is part of a larger example provided for the class. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR_System/system.IO.BufferedStream1/CPP/client.cpp" id="Snippet3"::: :::code language="csharp" source="~/snippets/csharp/System.IO/BufferedStream/Overview/client.cs" id="Snippet3"::: :::code language="fsharp" source="~/snippets/fsharp/System.IO/BufferedStream/Overview/client.fs" id="Snippet3"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.IO.BufferedStream1/VB/client.vb" id="Snippet3"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.IO.BufferedStream1/VB/client.vb" id="Snippet3"::: + ]]> @@ -666,23 +666,23 @@ if the stream supports writing; if the stream is closed or was opened with read-only access. - does not support writing, a call to , , or throws a . - - If the stream is closed, this property returns `false`. - - - -## Examples - This code example is part of a larger example provided for the class. - + does not support writing, a call to , , or throws a . + + If the stream is closed, this property returns `false`. + + + +## Examples + This code example is part of a larger example provided for the class. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR_System/system.IO.BufferedStream1/CPP/client.cpp" id="Snippet4"::: :::code language="csharp" source="~/snippets/csharp/System.IO/BufferedStream/Overview/client.cs" id="Snippet4"::: :::code language="fsharp" source="~/snippets/fsharp/System.IO/BufferedStream/Overview/client.fs" id="Snippet4"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.IO.BufferedStream1/VB/client.vb" id="Snippet4"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.IO.BufferedStream1/VB/client.vb" id="Snippet4"::: + ]]> @@ -724,19 +724,19 @@ before invoking Close. Following a call to Close, any operations on the buffered stream might raise exceptions. Flushing the stream will not flush its underlying encoder unless you explicitly call or Close. Setting to true means that data will be flushed from the buffer to the stream, but the encoder state will not be flushed. This allows the encoder to keep its state (partial characters) so that it can encode the next block of characters correctly. This scenario affects UTF8 and UTF7 where certain characters can only be encoded after the encoder receives the adjacent character or characters. Attempting to manipulate a stream after it has been closed might throw an . -## Examples +## Examples This code example is part of a larger example provided for the class. ```vb -' When bufStream is closed, netStream is in turn -' closed, which in turn shuts down the connection +' When bufStream is closed, netStream is in turn +' closed, which in turn shuts down the connection ' and closes clientSocket. Console.WriteLine(vbCrLf & "Shutting down the connection.") bufStream.Close() @@ -868,13 +868,13 @@ bufStream->Close(); Asynchronously reads the bytes from the current buffered stream and writes them to another stream, using a specified buffer size and cancellation token. A task that represents the asynchronous copy operation. - value for the property. +If the operation is canceled before it completes, the returned task contains the value for the property. Copying begins at the current position in the current stream. @@ -933,7 +933,7 @@ This method stores in the task it returns all non-usage exceptions that the meth to release both managed and unmanaged resources; to release only unmanaged resources. Releases the unmanaged resources used by the buffered stream and optionally releases the managed resources. - Waits for the pending asynchronous read operation to complete. (Consider using instead.) The number of bytes read from the stream, between 0 (zero) and the number of bytes you requested. Streams only return 0 only at the end of the stream, otherwise, they should block until at least 1 byte is available. - and to implement asynchronous file operations. These methods are still available in the .NET Framework 4.5 to support legacy code; however, the new async methods, such as , , and , help you implement asynchronous file operations more easily. - - must be called with this to find out how many bytes were read. - + and to implement asynchronous file operations. These methods are still available in the .NET Framework 4.5 to support legacy code; however, the new async methods, such as , , and , help you implement asynchronous file operations more easily. + + must be called with this to find out how many bytes were read. + ]]> @@ -1105,13 +1105,13 @@ Calling `DisposeAsync` allows the resources used by the The pending asynchronous request. Ends an asynchronous write operation and blocks until the I/O operation is complete. (Consider using instead.) - and to implement asynchronous file operations. These methods are still available in the .NET Framework 4.5 to support legacy code; however, the new async methods, such as , , and , help you implement asynchronous file operations more easily. - - must be called exactly once for every call to . Failing to end a read process before beginning another read operation can cause deadlock or other undesirable behavior. - + and to implement asynchronous file operations. These methods are still available in the .NET Framework 4.5 to support legacy code; however, the new async methods, such as , , and , help you implement asynchronous file operations more easily. + + must be called exactly once for every call to . Failing to end a read process before beginning another read operation can cause deadlock or other undesirable behavior. + ]]> @@ -1164,25 +1164,25 @@ Calling `DisposeAsync` allows the resources used by the Clears all buffers for this stream and causes any buffered data to be written to the underlying device. - . - - If you use the constructor, thus specifying the buffer size while creating the `BufferedStream` object, the content is flushed when it reaches the buffer size. For example, code such as `BufferedStream bs = new BufferedStream(bs, 5)` will flush the content when the buffer size reaches 5 bytes. - - All the read and write methods of `BufferedStream` automatically maintain the buffer, so there is no need to invoke `Flush` when switching back and forth between reading and writing. - - - -## Examples - This code example is part of a larger example provided for the class. - + . + + If you use the constructor, thus specifying the buffer size while creating the `BufferedStream` object, the content is flushed when it reaches the buffer size. For example, code such as `BufferedStream bs = new BufferedStream(bs, 5)` will flush the content when the buffer size reaches 5 bytes. + + All the read and write methods of `BufferedStream` automatically maintain the buffer, so there is no need to invoke `Flush` when switching back and forth between reading and writing. + + + +## Examples + This code example is part of a larger example provided for the class. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR_System/system.IO.BufferedStream1/CPP/client.cpp" id="Snippet6"::: :::code language="csharp" source="~/snippets/csharp/System.IO/BufferedStream/Overview/client.cs" id="Snippet6"::: :::code language="fsharp" source="~/snippets/fsharp/System.IO/BufferedStream/Overview/client.fs" id="Snippet6"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.IO.BufferedStream1/VB/client.vb" id="Snippet6"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.IO.BufferedStream1/VB/client.vb" id="Snippet6"::: + ]]> The stream has been disposed. @@ -1342,15 +1342,15 @@ Calling `DisposeAsync` allows the resources used by the Gets the position within the current stream. The position within the current stream. - to obtain the current position within the underlying stream and then adjusts this value according to the current position within the buffer. - - The `set` accessor copies any data previously written to the buffer to the underlying stream, and then invokes . - - Seeking to any location beyond the length of the stream is supported. - + to obtain the current position within the underlying stream and then adjusts this value according to the current position within the buffer. + + The `set` accessor copies any data previously written to the buffer to the underlying stream, and then invokes . + + Seeking to any location beyond the length of the stream is supported. + ]]> The value passed to is negative. @@ -1405,8 +1405,8 @@ Calling `DisposeAsync` allows the resources used by the Copies bytes from the current buffered stream to a byte span and advances the position within the buffered 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 allocated in the buffer 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 reading. Use the method to read asynchronously from the current stream. @@ -1486,23 +1486,23 @@ Use for reading primitive data types. Copies bytes from the current buffered stream to an array. The total number of bytes read into . This can be less than the number of bytes requested if that many bytes are not currently available, or 0 if the end of the stream has been reached before any data can be read. - for reading primitive data types. - - - -## Examples - This code example is part of a larger example provided for the class. - + for reading primitive data types. + + + +## Examples + This code example is part of a larger example provided for the class. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR_System/system.IO.BufferedStream1/CPP/client.cpp" id="Snippet7"::: :::code language="csharp" source="~/snippets/csharp/System.IO/BufferedStream/Overview/client.cs" id="Snippet7"::: :::code language="fsharp" source="~/snippets/fsharp/System.IO/BufferedStream/Overview/client.fs" id="Snippet7"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.IO.BufferedStream1/VB/client.vb" id="Snippet7"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.IO.BufferedStream1/VB/client.vb" id="Snippet7"::: + ]]> Length of minus is less than . @@ -1563,7 +1563,7 @@ Use for reading primitive data types. Asynchronously reads a sequence of bytes from the current buffered stream and advances the position within the buffered stream by the number of bytes read. A task that represents the asynchronous read operation. The value of its property contains the total number of bytes read into the buffer. The result value can be less than the number of bytes allocated in the buffer if that many bytes are not currently available, or it can be 0 (zero) if the end of the stream has been reached. - The maximum number of bytes to read. The token to monitor for cancellation requests. Asynchronously reads a sequence of bytes from the current stream, advances the position within the stream by the number of bytes read, and monitors cancellation requests. - A task that represents the asynchronous read operation. The value of the parameter contains the total number of bytes read into the buffer. The result value can be less than the number of bytes requested if the number of bytes currently available is less than the requested number, or it can be 0 (zero) if the end of the stream has been reached. + A task that represents the asynchronous read operation. The returned task contains the total number of bytes read into the buffer. The result value can be less than the number of bytes requested if the number of bytes currently available is less than the requested number, or it can be 0 (zero) if the end of the stream has been reached. - class and passing the property as the `cancellationToken` parameter. - + class and passing the property as the `cancellationToken` parameter. + This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . ]]> @@ -1765,15 +1765,15 @@ If the operation is canceled before it completes, the returned task contains the Sets the position within the current buffered stream. The new position within the current buffered stream. - object is the base stream for a object, calling the method can cause the position of the stream to no longer match the position of the internal buffer in the reader. To reset the internal buffer, call the method; however, this method slows performance and should be called only when absolutely necessary. - - Seeking to any location beyond the length of the stream is supported. - + object is the base stream for a object, calling the method can cause the position of the stream to no longer match the position of the internal buffer in the reader. To reset the internal buffer, call the method; however, this method slows performance and should be called only when absolutely necessary. + + Seeking to any location beyond the length of the stream is supported. + ]]> The stream is not open or is . @@ -1833,15 +1833,15 @@ If the operation is canceled before it completes, the returned task contains the An integer indicating the desired length of the current buffered stream in bytes. Sets the length of the buffered stream. - @@ -1936,7 +1936,7 @@ If the operation is canceled before it completes, the returned task contains the A region of memory. This method copies the contents of this region to the current buffered stream. Writes a sequence of bytes to the current buffered stream and advances the current position within this buffered stream by the number of bytes written. - The number of bytes to be written to the current buffered stream. Copies bytes to the buffered stream and advances the current position within the buffered stream by the number of bytes written. - class. - + class. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR_System/system.IO.BufferedStream1/CPP/client.cpp" id="Snippet6"::: :::code language="csharp" source="~/snippets/csharp/System.IO/BufferedStream/Overview/client.cs" id="Snippet6"::: :::code language="fsharp" source="~/snippets/fsharp/System.IO/BufferedStream/Overview/client.fs" id="Snippet6"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.IO.BufferedStream1/VB/client.vb" id="Snippet6"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.IO.BufferedStream1/VB/client.vb" id="Snippet6"::: + ]]> Length of minus is less than . @@ -2150,11 +2150,11 @@ If the operation is canceled before it completes, the returned task contains the Asynchronously writes a sequence of bytes to the current stream, advances the current position within this stream by the number of bytes written, and monitors cancellation requests. A task that represents the asynchronous write operation. - class and passing the property as the `cancellationToken` parameter. - + class and passing the property as the `cancellationToken` parameter. + This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . ]]> @@ -2218,7 +2218,7 @@ If the operation is canceled before it completes, the returned task contains the A byte to write to the stream. Writes a byte to the current position in the buffered stream. - ## Remarks `searchPattern` can be a combination of literal and wildcard characters, but it doesn't support regular expressions. The following wildcard specifiers are permitted in `searchPattern`. -|Wildcard specifier|Matches| -|------------------------|-------------| -|\* (asterisk)|Zero or more characters in that position.| -|? (question mark)|Exactly one character in that position.| +| Wildcard specifier | Matches | +|--------------------|-------------------------------------------| +| \* (asterisk) | Zero or more characters in that position. | +| ? (question mark) | Exactly one character in that position. | Characters other than the wildcard are literal characters. For example, the `searchPattern` string "\*t" searches for all names in `path` ending with the letter "t". The `searchPattern` string "s\*" searches for all names in `path` beginning with the letter "s". @@ -1077,8 +1077,6 @@ An I/O error occurred. The returned collection is not cached; each call to the on the collection will start a new enumeration. - - ## Examples The following example enumerates directories in a specified path that match a specified search pattern. It uses the `searchOption` parameter to specify that all subdirectories should be included in the search. @@ -1353,10 +1351,10 @@ The returned collection is not cached. Each call to the is . - is not a valid value. + is not a valid value. is invalid, such as referring to an unmapped drive. @@ -1761,7 +1759,7 @@ The returned collection is not cached. Each call to the is . - is not a valid value. + is not a valid value. is invalid, such as referring to an unmapped drive. @@ -3225,7 +3223,7 @@ The returned collection is not cached. Each call to the does not contain a valid pattern. - or is . + or is . is not a valid value. The caller does not have the required permission. @@ -4566,7 +4564,7 @@ There are too many levels of symbolic links. The specified path, file name, or both exceed the system-defined maximum length. The caller does not have the required permission. - specifies a value outside the range of dates or times permitted for this operation. + specifies a value outside the range of dates or times permitted for this operation. The current operating system is not Windows NT or later. File and Stream I/O diff --git a/xml/System.IO/DirectoryInfo.xml b/xml/System.IO/DirectoryInfo.xml index 3093a0c9572..81aefa3a90c 100644 --- a/xml/System.IO/DirectoryInfo.xml +++ b/xml/System.IO/DirectoryInfo.xml @@ -177,7 +177,7 @@ The `path` parameter can be a file name, including a file on a Universal Naming Convention (UNC) share. > [!CAUTION] -> When you compile a set of characters with a particular cultural setting and retrieve those same characters with a different cultural setting, the characters might not be interpretable, and could cause an exception to be thrown. +> When you compile a set of characters with a particular cultural setting and retrieve those same characters with a different cultural setting, the characters might not be interpretable, and could cause an exception to be thrown. For a list of common I/O tasks, see [Common I/O Tasks](/dotnet/standard/io/common-i-o-tasks). @@ -353,8 +353,6 @@ namespace ConsoleApp The caller does not have the required permission. .NET Framework and .NET Core versions older than 2.1: is a zero-length string, contains only white space, or contains one or more invalid characters. You can query for invalid characters by using the method. - - 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. Creating a directory with only the colon (:) character was attempted. @@ -430,8 +428,6 @@ namespace ConsoleApp For a list of common I/O tasks, see [Common I/O Tasks](/dotnet/standard/io/common-i-o-tasks). - - ## Examples The following example demonstrates creating a subdirectory. In this example, the created directories are removed once created. Therefore, to test this sample, comment out the delete lines in the code. @@ -2140,7 +2136,7 @@ namespace ConsoleApp One of the values that specifies the type of access control list (ACL) information to receive. Gets a object that encapsulates the specified type of access control list (ACL) entries for the directory described by the current object. - A object that encapsulates the access control rules for the file described by the parameter. + A object that encapsulates the access control rules for the directory described by the current object. - An object that describes an ACL entry to apply to the directory described by the parameter. + An object that describes an ACL entry to apply to the directory described by the current object. Applies access control list (ACL) entries described by a object to the directory described by the current object. [!NOTE] -> `path` is not required to be a file stored on disk; it can be any part of a system that supports access through streams. For example, depending on the system, this class can access a physical device. +> `path` is not required to be a file stored on disk; it can be any part of a system that supports access through streams. For example, depending on the system, this class can access a physical device. is `true` for all objects that encapsulate files. If `path` indicates a device that does not support seeking, the property on the resulting is `false`. For additional information, see . @@ -999,7 +1001,8 @@ The file was too large (when method. @@ -1217,7 +1218,8 @@ The file was too large (when object. @@ -1459,8 +1463,6 @@ The file was too large (when , , or contain an invalid value. + , , or contains an invalid value. The file cannot be found, such as when is or , and the file specified by does not exist. The file must already exist in these modes. The current operating system is not Windows NT or later. An I/O error, such as specifying when the file specified by already exists, occurred. @@ -1598,7 +1600,7 @@ The file was too large (when The caller does not have the required permission. The specified path is invalid, such as being on an unmapped drive. - The requested is not permitted by the operating system for the specified , such as when is or and the file or directory is set for read-only access. + The requested is not permitted by the operating system for the specified , such as when is or and the file or directory is set for read-only access. -or- @@ -1705,7 +1707,7 @@ The file was too large (when , , or contain an invalid value. + , , or contain an invalid value. The file cannot be found, such as when is or , and the file specified by does not exist. The file must already exist in these modes. An I/O error, such as specifying when the file specified by already exists, occurred. @@ -1714,7 +1716,7 @@ The file was too large (when The caller does not have the required permission. The specified path is invalid, such as being on an unmapped drive. - The requested is not permitted by the operating system for the specified , such as when is or and the file or directory is set for read-only access. + The requested is not permitted by the operating system for the specified , such as when is or and the file or directory is set for read-only access. -or- diff --git a/xml/System.IO/FileStreamOptions.xml b/xml/System.IO/FileStreamOptions.xml index eef8eeb2fff..33784a2654b 100644 --- a/xml/System.IO/FileStreamOptions.xml +++ b/xml/System.IO/FileStreamOptions.xml @@ -63,7 +63,8 @@ A bitwise combination of the enumeration values that determines how the file can be accessed by the object. This also determines the values returned by the and properties of the object. A bitwise combination of the enum flags. To be added. - When contains an invalid value. + + contains an invalid value. @@ -89,7 +90,8 @@ 0 or 1 means that buffering should be disabled. Negative values are not allowed. A non-negative number that represents the buffer size used by for buffering. To be added. - When is negative. + + is negative. @@ -114,7 +116,8 @@ One of the enumeration values that determines how to open or create the file. One of the enumeration values of the enum. To be added. - When contains an invalid value. + + contains an invalid value. @@ -139,7 +142,8 @@ A bitwise combination of the enumeration values that specifies additional file options. The default value is , which indicates synchronous IO. A bitwise combination of the enum flags. To be added. - When contains an invalid value. + + contains an invalid value. @@ -182,16 +186,17 @@ For example, assume 2 GB is preallocated for a file, but only 1 GB is written. A It's permissible to write more than what was initially preallocated. As long as there is enough disk space, the operation should succeed. -## Examples +## Examples The following code example demonstrates how to use when working with objects: :::code language="csharp" source="~/snippets/csharp/System.IO/FileStreamOptions/PreallocationSizeExample.cs" id="Snippet1"::: -:::code language="vb" source="~/snippets/visualbasic/System.IO/FileStreamOptions/PreallocationSizeExample.vb" id="Snippet1"::: - +:::code language="vb" source="~/snippets/visualbasic/System.IO/FileStreamOptions/PreallocationSizeExample.vb" id="Snippet1"::: + ]]> - When is negative. + + is negative. @@ -216,7 +221,8 @@ It's permissible to write more than what was initially preallocated. As long as A bitwise combination of the enumeration values that determines how the file will be shared by processes. The default value is . A bitwise combination of the enum flags. To be added. - When contains an invalid value. + + contains an invalid value. diff --git a/xml/System.IO/MemoryStream.xml b/xml/System.IO/MemoryStream.xml index fc816802ed2..e63344871fe 100644 --- a/xml/System.IO/MemoryStream.xml +++ b/xml/System.IO/MemoryStream.xml @@ -1207,7 +1207,7 @@ The stream is unwritable. is . - is negative or zero. + is negative or zero. Either the current stream or the destination stream is disposed. The current stream does not support reading, or the destination stream does not support writing. The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.IO/Stream.xml b/xml/System.IO/Stream.xml index 64fc365d878..2912ee49ca9 100644 --- a/xml/System.IO/Stream.xml +++ b/xml/System.IO/Stream.xml @@ -1012,7 +1012,7 @@ is . - is negative or zero. + is negative or zero. Either the current stream or the destination stream is disposed. The current stream does not support reading, or the destination stream does not support writing. @@ -1150,7 +1150,7 @@ is . - is negative or zero. + is negative or zero. Either the current stream or the destination stream is disposed. The current stream does not support reading, or the destination stream does not support writing. The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.IO/StreamReader.xml b/xml/System.IO/StreamReader.xml index 1ceb5d74e07..5534339f7e1 100644 --- a/xml/System.IO/StreamReader.xml +++ b/xml/System.IO/StreamReader.xml @@ -195,8 +195,6 @@ For a list of common I/O tasks, see [Common I/O Tasks](/dotnet/standard/io/common-i-o-tasks). - - ## Examples The following code example demonstrates this constructor. @@ -592,7 +590,7 @@ Initializes a new instance of the class for the specified file path, using the default encoding, enabling detection of byte order marks at the beginning of the file, and configured with the specified object. To be added. - is not readable. + is not readable. -or- @@ -1047,8 +1045,6 @@ For a list of common I/O tasks, see [Common I/O Tasks](/dotnet/standard/io/common-i-o-tasks). - - ## Examples The following code example demonstrates this constructor. @@ -1067,7 +1063,7 @@ includes an incorrect or invalid syntax for file name, directory name, or volume label. - is less than or equal to zero. + is less than or equal to zero. File and Stream I/O How to: Read Text from a File @@ -1115,7 +1111,7 @@ Initializes a new instance of the class for the specified file path, with the specified character encoding, byte order mark detection option, and configured with the specified object. To be added. - is not readable. + is not readable. -or- diff --git a/xml/System.IO/StreamWriter.xml b/xml/System.IO/StreamWriter.xml index 4a09467f105..ddfab1042e3 100644 --- a/xml/System.IO/StreamWriter.xml +++ b/xml/System.IO/StreamWriter.xml @@ -526,7 +526,7 @@ is . - is not writable. + is not writable. File and Stream I/O How to: Read Text from a File How to: Write Text to a File @@ -764,7 +764,7 @@ is . - is not writable. + is not writable. File and Stream I/O How to: Read Text from a File How to: Write Text to a File diff --git a/xml/System.IO/UnmanagedMemoryAccessor.xml b/xml/System.IO/UnmanagedMemoryAccessor.xml index 98ce4e48b39..abaa300031b 100644 --- a/xml/System.IO/UnmanagedMemoryAccessor.xml +++ b/xml/System.IO/UnmanagedMemoryAccessor.xml @@ -671,7 +671,7 @@ The type of structure. The position in the accessor at which to begin reading. The structure to contain the read data. - Reads a structure of type from the accessor into a provided reference. + Reads a structure of type from the accessor into a provided reference. - There are not enough bytes after to read in a structure of type . + There are not enough bytes after to read in a structure of type . -or- @@ -760,7 +760,7 @@ The array to contain the structures read from the accessor. The index in in which to place the first copied structure. The number of structures of type T to read from the accessor. - Reads structures of type from the accessor into an array of type . + Reads structures of type from the accessor into an array of type . The number of structures read into . This value can be less than if there are fewer structures available, or zero if the end of the accessor is reached. - There are not enough bytes in the accessor after to write a structure of type . + There are not enough bytes in the accessor after to write a structure of type . is less than zero or greater than the capacity of the accessor. The accessor does not support writing. @@ -2478,7 +2478,7 @@ The array to write into the accessor. The index in to start writing from. The number of structures in to write. - Writes structures from an array of type into the accessor. + Writes structures from an array of type into the accessor. To be added. There are not enough bytes in the accessor after to write the number of structures specified by . diff --git a/xml/System.Linq.Expressions/Expression.xml b/xml/System.Linq.Expressions/Expression.xml index d7439f27524..f439f330c2b 100644 --- a/xml/System.Linq.Expressions/Expression.xml +++ b/xml/System.Linq.Expressions/Expression.xml @@ -2272,7 +2272,7 @@ The following code example shows how to create an expression that adds two integ -or- - .Type is not assignable to the type of the field or property that represents. + .Type is not assignable to the type of the field or property that the member represents. @@ -10656,19 +10656,19 @@ As with `Func`, the last argument is the return type. It can be set to `System.V One or more elements in are . - is not a delegate type. + is not a delegate type. -or- - .Type represents a type that is not assignable to the return type of . + .Type represents a type that is not assignable to the return type of . -or- - does not contain the same number of elements as the list of parameters for . + does not contain the same number of elements as the list of parameters for . -or- - The property of an element of is not assignable from the type of the corresponding parameter type of . + The property of an element of is not assignable from the type of the corresponding parameter type of . @@ -10758,19 +10758,19 @@ As with `Func`, the last argument is the return type. It can be set to `System.V One or more elements in are . - is not a delegate type. + is not a delegate type. -or- - .Type represents a type that is not assignable to the return type of . + .Type represents a type that is not assignable to the return type of . -or- - does not contain the same number of elements as the list of parameters for . + does not contain the same number of elements as the list of parameters for . -or- - The property of an element of is not assignable from the type of the corresponding parameter type of . + The property of an element of is not assignable from the type of the corresponding parameter type of . diff --git a/xml/System.Linq/Enumerable.xml b/xml/System.Linq/Enumerable.xml index 738d56c0390..9bb7ec3732b 100644 --- a/xml/System.Linq/Enumerable.xml +++ b/xml/System.Linq/Enumerable.xml @@ -2300,7 +2300,7 @@ The type to cast the elements of to. - The that contains the elements to be cast to type . + The that contains the elements to be cast to type . Casts the elements of an to the specified type. An that contains each element of the source sequence cast to the specified type. @@ -2351,7 +2351,7 @@ Dim doubles = From item As Integer In sequence is . - An element in the sequence cannot be cast to type . + An element in the sequence cannot be cast to type . from clause (C# Reference) From Clause (Visual Basic) @@ -2967,7 +2967,7 @@ Each chunk except the last one will be of size `size`. The last chunk will conta The type of the elements of . The sequence to return a default value for if it is empty. Returns the elements of the specified sequence or the type parameter's default value in a singleton collection if the sequence is empty. - An object that contains the default value for the type if is empty; otherwise, . + An object that contains the default value for the type if is empty; otherwise, . The zero-based index of the element to retrieve. Returns the element at a specified index in a sequence or a default value if the index is out of range. - () if the index is outside the bounds of the source sequence; otherwise, the element at the specified position in the source sequence. + () if the index is outside the bounds of the source sequence; otherwise, the element at the specified position in the source sequence. The type to assign to the type parameter of the returned generic . Returns an empty that has the specified type argument. - An empty whose type argument is . + An empty whose type argument is . The to return the first element of. Returns the first element of a sequence, or a default value if the sequence contains no elements. - () if is empty; otherwise, the first element in . + () if is empty; otherwise, the first element in . A function to test each element for a condition. Returns the first element of the sequence that satisfies a condition or a default value if no such element is found. - () if is empty or if no element passes the test specified by ; otherwise, the first element in that passes the test specified by . + () if is empty or if no element passes the test specified by ; otherwise, the first element in that passes the test specified by . A function to extract the key for each element. A function to map each source element to an element in the . Groups the elements of a sequence according to a specified key selector function and projects the elements for each group by using a specified function. - An IEnumerable<IGrouping<TKey, TElement>> in C# or IEnumerable(Of IGrouping(Of TKey, TElement)) in Visual Basic where each object contains a collection of objects of type and a key. + An IEnumerable<IGrouping<TKey, TElement>> in C# or IEnumerable(Of IGrouping(Of TKey, TElement)) in Visual Basic where each object contains a collection of objects of type and a key. A function to map each source element to an element in an . An to compare keys. Groups the elements of a sequence according to a key selector function. The keys are compared by using a comparer and each group's elements are projected by using a specified function. - An IEnumerable<IGrouping<TKey, TElement>> in C# or IEnumerable(Of IGrouping(Of TKey, TElement)) in Visual Basic where each object contains a collection of objects of type and a key. + An IEnumerable<IGrouping<TKey, TElement>> in C# or IEnumerable(Of IGrouping(Of TKey, TElement)) in Visual Basic where each object contains a collection of objects of type and a key. A function to extract the key for each element. A function to create a result value from each group. Groups the elements of a sequence according to a specified key selector function and creates a result value from each group and its key. - A collection of elements of type where each element represents a projection over a group and its key. + A collection of elements of type where each element represents a projection over a group and its key. A function to create a result value from each group. An to compare keys with. Groups the elements of a sequence according to a specified key selector function and creates a result value from each group and its key. The keys are compared by using a specified comparer. - A collection of elements of type where each element represents a projection over a group and its key. + A collection of elements of type where each element represents a projection over a group and its key. To be added. or or is . @@ -5226,7 +5226,7 @@ Only unique elements are returned. A function to map each source element to an element in an . A function to create a result value from each group. Groups the elements of a sequence according to a specified key selector function and creates a result value from each group and its key. The elements of each group are projected by using a specified function. - A collection of elements of type where each element represents a projection over a group and its key. + A collection of elements of type where each element represents a projection over a group and its key. A function to create a result value from each group. An to compare keys with. Groups the elements of a sequence according to a specified key selector function and creates a result value from each group and its key. Key values are compared by using a specified comparer, and the elements of each group are projected by using a specified function. - A collection of elements of type where each element represents a projection over a group and its key. + A collection of elements of type where each element represents a projection over a group and its key. To be added. or or or is . @@ -5448,7 +5448,7 @@ Only unique elements are returned. A function to extract the join key from each element of the second sequence. A function to create a result element from an element from the first sequence and a collection of matching elements from the second sequence. Correlates the elements of two sequences based on equality of keys and groups the results. The default equality comparer is used to compare keys. - An that contains elements of type that are obtained by performing a grouped join on two sequences. + An that contains elements of type that are obtained by performing a grouped join on two sequences. A function to create a result element from an element from the first sequence and a collection of matching elements from the second sequence. An to hash and compare keys. Correlates the elements of two sequences based on key equality and groups the results. A specified is used to compare keys. - An that contains elements of type that are obtained by performing a grouped join on two sequences. + An that contains elements of type that are obtained by performing a grouped join on two sequences. A function to extract the join key from each element of the second sequence. A function to create a result element from two matching elements. Correlates the elements of two sequences based on matching keys. The default equality comparer is used to compare keys. - An that has elements of type that are obtained by performing an inner join on two sequences. + An that has elements of type that are obtained by performing an inner join on two sequences. A function to create a result element from two matching elements. An to hash and compare keys. Correlates the elements of two sequences based on matching keys. A specified is used to compare keys. - An that has elements of type that are obtained by performing an inner join on two sequences. + An that has elements of type that are obtained by performing an inner join on two sequences. An to return the last element of. Returns the last element of a sequence, or a default value if the sequence contains no elements. - () if the source sequence is empty; otherwise, the last element in the . + () if the source sequence is empty; otherwise, the last element in the . A function to test each element for a condition. Returns the last element of a sequence that satisfies a condition or a default value if no such element is found. - () if the sequence is empty or if no elements pass the test in the predicate function; otherwise, the last element that passes the test in the predicate function. + () if the sequence is empty or if no elements pass the test in the predicate function; otherwise, the last element that passes the test in the predicate function. The type to filter the elements of the sequence on. The whose elements to filter. Filters the elements of an based on a specified type. - An that contains elements from the input sequence of type . + An that contains elements from the input sequence of type . The type of the elements of . An to return the single element of. Returns the only element of a sequence, or a default value if the sequence is empty; this method throws an exception if there is more than one element in the sequence. - The single element of the input sequence, or () if the sequence contains no elements. + The single element of the input sequence, or () if the sequence contains no elements. An to return a single element from. A function to test an element for a condition. Returns the only element of a sequence that satisfies a specified condition or a default value if no such element exists; this method throws an exception if more than one element satisfies the condition. - The single element of the input sequence that satisfies the condition, or () if no such element is found. + The single element of the input sequence that satisfies the condition, or () if no such element is found. A function to extract a key from each element. A transform function to produce a result element value from each element. Creates a from an according to specified key selector and element selector functions. - A that contains values of type selected from the input sequence. + A that contains values of type selected from the input sequence. A transform function to produce a result element value from each element. An to compare keys. Creates a from an according to a specified key selector function, a comparer, and an element selector function. - A that contains values of type selected from the input sequence. + A that contains values of type selected from the input sequence. The type of the elements of . An to create a from. Creates a from an . - A that contains values of type selected from the input sequence. + A that contains values of type selected from the input sequence. To be added. is . @@ -16093,7 +16093,7 @@ If `count` is not a positive number, this method returns an empty enumerable col An to create a from. An to compare keys. Creates a from an using the to compare keys. - A that contains values of type selected from the input sequence. + A that contains values of type selected from the input sequence. To be added. is . @@ -16424,7 +16424,7 @@ If `count` is not a positive number, this method returns an empty enumerable col A function to extract a key from each element. A transform function to produce a result element value from each element. Creates a from an according to specified key selector and element selector functions. - A that contains values of type selected from the input sequence. + A that contains values of type selected from the input sequence. A transform function to produce a result element value from each element. An to compare keys. Creates a from an according to a specified key selector function, a comparer and an element selector function. - A that contains values of type selected from the input sequence. + A that contains values of type selected from the input sequence. - LINQ extension method overrides that offer greater efficiency for than the standard LINQ methods - + LINQ extension method overrides that offer greater efficiency for than the standard LINQ methods + **NuGet package**: System.Collections.Immutable (about immutable collections and how to install) To be added. @@ -92,11 +92,11 @@ Applies a function to a sequence of elements in a cumulative way. The final value after the cumulative function has been applied to all elements. - method makes it simple to perform a calculation over a sequence of values. This method works by calling `func` one time for each element in source. Each time `func` is called, passes both the element from the sequence and an aggregated value (as the first argument to func). The value of the `seed` parameter is used as the initial aggregate value. The result of `func` replaces the previous aggregated value. returns the final result of `func`. - + method makes it simple to perform a calculation over a sequence of values. This method works by calling `func` one time for each element in source. Each time `func` is called, passes both the element from the sequence and an aggregated value (as the first argument to func). The value of the `seed` parameter is used as the initial aggregate value. The result of `func` replaces the previous aggregated value. returns the final result of `func`. + ]]> @@ -166,11 +166,11 @@ Applies a function to a sequence of elements in a cumulative way. The final accumulator value. - method makes it simple to perform a calculation over a sequence of values. This method works by calling `func` one time for each element in source. Each time `func` is called, passes both the element from the sequence and an aggregated value (as the first argument to func). The value of the `seed` parameter is used as the initial aggregate value. The result of `func` replaces the previous aggregated value. returns the final result of `func`. - + method makes it simple to perform a calculation over a sequence of values. This method works by calling `func` one time for each element in source. Each time `func` is called, passes both the element from the sequence and an aggregated value (as the first argument to func). The value of the `seed` parameter is used as the initial aggregate value. The result of `func` replaces the previous aggregated value. returns the final result of `func`. + ]]> @@ -251,11 +251,11 @@ Applies a function to a sequence of elements in a cumulative way. The final accumulator value. - method makes it simple to perform a calculation over a sequence of values. This method works by calling `func` one time for each element in source. Each time `func` is called, passes both the element from the sequence and an aggregated value (as the first argument to func). The value of the `seed` parameter is used as the initial aggregate value. The result of `func` replaces the previous aggregated value. returns the final result of `func`. - + method makes it simple to perform a calculation over a sequence of values. This method works by calling `func` one time for each element in source. Each time `func` is called, passes both the element from the sequence and an aggregated value (as the first argument to func). The value of the `seed` parameter is used as the initial aggregate value. The result of `func` replaces the previous aggregated value. returns the final result of `func`. + ]]> @@ -1735,7 +1735,7 @@ The element in the array, or the default value if the array is empty. To be added. - contains more than one element. + contains more than one element. diff --git a/xml/System.Linq/ParallelEnumerable.xml b/xml/System.Linq/ParallelEnumerable.xml index b0e2a14ed4e..63e1c431467 100644 --- a/xml/System.Linq/ParallelEnumerable.xml +++ b/xml/System.Linq/ParallelEnumerable.xml @@ -2365,7 +2365,7 @@ To be added. is a null reference (Nothing in Visual Basic). - The type of the source sequence could not be converted to . + The type of the source sequence could not be converted to . Parallel LINQ (PLINQ) @@ -3221,7 +3221,7 @@ The type to assign to the type parameter of the returned generic sequence. Returns an empty ParallelQuery{TResult} that has the specified type argument. - An empty sequence whose type argument is . + An empty sequence whose type argument is . To be added. Parallel LINQ (PLINQ) @@ -3951,14 +3951,14 @@ The type of elements of . The type of the key returned by . - An OrderedParallelQuery{TSource}that contains elements to sort. + An OrderedParallelQuery<TSource> that contains elements to sort. A function to extract a key from an element. - Groups in parallel the elements of a sequence according to a specified key selector function. - A sequence of groups that are sorted descending according to . + Groups in parallel the elements of a sequence according to a specified key-selector function. + A sequence of groups that are sorted in descending order according to . To be added. The query was canceled with the token passed in through . - or is a null reference (Nothing in Visual Basic). + or is a null reference (Nothing in Visual Basic). One or more exceptions occurred during the evaluation of the query. Parallel LINQ (PLINQ) @@ -4033,11 +4033,11 @@ A function to extract a key from an element. An to compare keys. Groups in parallel the elements of a sequence according to a specified key selector function and compares the keys by using a specified . - A sequence of groups that are sorted descending according to . + A sequence of groups that are sorted descending according to . To be added. The query was canceled with the token passed in through . - or is a null reference (Nothing in Visual Basic). + is a null reference (Nothing in Visual Basic). One or more exceptions occurred during the evaluation of the query. Parallel LINQ (PLINQ) @@ -4119,11 +4119,11 @@ A function to extract a key from an element. A function to map each source element to an element in an . Groups in parallel the elements of a sequence according to a specified key selector function and projects the elements for each group by using a specified function. - A sequence of groups that are sorted descending according to . + A sequence of groups that are sorted descending according to . To be added. The query was canceled with the token passed in through . - or is a null reference (Nothing in Visual Basic). + or is a null reference (Nothing in Visual Basic). One or more exceptions occurred during the evaluation of the query. Parallel LINQ (PLINQ) @@ -4209,11 +4209,11 @@ A function to map each source element to an element in an IGrouping. An IComparer{TSource} to compare keys. Groups in parallel the elements of a sequence according to a key selector function. The keys are compared by using a comparer and each group's elements are projected by using a specified function. - A sequence of groups that are sorted descending according to . + A sequence of groups that are sorted descending according to . To be added. The query was canceled with the token passed in through . - or is a null reference (Nothing in Visual Basic). + or is a null reference (Nothing in Visual Basic). One or more exceptions occurred during the evaluation of the query. Parallel LINQ (PLINQ) @@ -4289,11 +4289,11 @@ A function to extract the key for each element. A function to create a result value from each group. Groups in parallel the elements of a sequence according to a specified key selector function and creates a result value from each group and its key. - A sequence of elements of type where each element represents a projection over a group and its key. + A sequence of elements of type where each element represents a projection over a group and its key. To be added. The query was canceled with the token passed in through . - or is a null reference (Nothing in Visual Basic). + or is a null reference (Nothing in Visual Basic). One or more exceptions occurred during the evaluation of the query. Parallel LINQ (PLINQ) @@ -4383,7 +4383,7 @@ To be added. The query was canceled with the token passed in through . - or is a null reference (Nothing in Visual Basic). + or is a null reference (Nothing in Visual Basic). One or more exceptions occurred during the evaluation of the query. Parallel LINQ (PLINQ) @@ -4470,11 +4470,11 @@ A function to map each source element to an element in an IGrouping<TKey, TElement>. A function to create a result value from each group. Groups in parallel the elements of a sequence according to a specified key selector function and creates a result value from each group and its key. The elements of each group are projected by using a specified function. - A sequence of elements of type where each element represents a projection over a group and its key. + A sequence of elements of type where each element represents a projection over a group and its key. To be added. The query was canceled with the token passed in through . - or or or or is ( in Visual Basic). + or or or is ( in Visual Basic). One or more exceptions occurred during the evaluation of the query. Parallel LINQ (PLINQ) @@ -4571,11 +4571,11 @@ A function to create a result value from each group. An to compare keys. Groups the elements of a sequence according to a specified key selector function and creates a result value from each group and its key. Key values are compared by using a specified comparer, and the elements of each group are projected by using a specified function. - A sequence of elements of type where each element represents a projection over a group and its key. + A sequence of elements of type where each element represents a projection over a group and its key. To be added. The query was canceled with the token passed in through . - or or or or is ( in Visual Basic). + or or or is ( in Visual Basic). One or more exceptions occurred during the evaluation of the query. Parallel LINQ (PLINQ) @@ -4783,11 +4783,11 @@ A function to extract the join key from each element of the second sequence. A function to create a result element from an element from the first sequence and a collection of matching elements from the second sequence. Correlates in parallel the elements of two sequences based on equality of keys and groups the results. The default equality comparer is used to compare keys. - A sequence that has elements of type that are obtained by performing a grouped join on two sequences. + A sequence that has elements of type that are obtained by performing a grouped join on two sequences. To be added. The query was canceled with the token passed in through . - or or or or or or is ( in Visual Basic). + or or or or is ( in Visual Basic). One or more exceptions occurred during the evaluation of the query. Parallel LINQ (PLINQ) @@ -4999,11 +4999,11 @@ A function to create a result element from an element from the first sequence and a collection of matching elements from the second sequence. An to hash and compare keys. Correlates in parallel the elements of two sequences based on key equality and groups the results. A specified is used to compare keys. - A sequence that has elements of type that are obtained by performing a grouped join on two sequences. + A sequence that has elements of type that are obtained by performing a grouped join on two sequences. To be added. The query was canceled with the token passed in through . - or or or or or or is ( in Visual Basic). + or or or or is ( in Visual Basic). One or more exceptions occurred during the evaluation of the query. Parallel LINQ (PLINQ) @@ -5149,7 +5149,7 @@ To be added. The query was canceled with the token passed in through . - or is a null reference (Nothing in Visual Basic). + or is a null reference (Nothing in Visual Basic). One or more exceptions occurred during the evaluation of the query. Parallel LINQ (PLINQ) @@ -5299,7 +5299,7 @@ To be added. The query was canceled with the token passed in through . - or is a null reference (Nothing in Visual Basic). + or is a null reference (Nothing in Visual Basic). One or more exceptions occurred during the evaluation of the query. Parallel LINQ (PLINQ) @@ -5507,11 +5507,11 @@ A function to extract the join key from each element of the second sequence. A function to create a result element from two matching elements. Correlates in parallel the elements of two sequences based on matching keys. The default equality comparer is used to compare keys. - A sequence that has elements of type that are obtained by performing an inner join on two sequences. + A sequence that has elements of type that are obtained by performing an inner join on two sequences. To be added. The query was canceled with the token passed in through . - or or or or or or is ( in Visual Basic). + or or or or is ( in Visual Basic). One or more exceptions occurred during the evaluation of the query. Parallel LINQ (PLINQ) @@ -5723,11 +5723,11 @@ A function to create a result element from two matching elements. An to hash and compare keys. Correlates in parallel the elements of two sequences based on matching keys. A specified is used to compare keys. - A sequence that has elements of type that are obtained by performing an inner join on two sequences. + A sequence that has elements of type that are obtained by performing an inner join on two sequences. To be added. The query was canceled with the token passed in through . - or or or or or or is ( in Visual Basic). + or or or or is ( in Visual Basic). One or more exceptions occurred during the evaluation of the query. Parallel LINQ (PLINQ) @@ -6708,7 +6708,7 @@ is a null reference (Nothing in Visual Basic). One or more exceptions occurred during the evaluation of the query. - contains no elements and is a non-nullable value type. + contains no elements and is a non-nullable value type. Parallel LINQ (PLINQ) @@ -6770,7 +6770,7 @@ or is a null reference (Nothing in Visual Basic). One or more exceptions occurred during the evaluation of the query. - contains no elements and is a non-nullable value type. + contains no elements and is a non-nullable value type. Parallel LINQ (PLINQ) @@ -6832,7 +6832,7 @@ or is a null reference (Nothing in Visual Basic). One or more exceptions occurred during the evaluation of the query. - contains no elements and is a non-nullable value type. + contains no elements and is a non-nullable value type. Parallel LINQ (PLINQ) @@ -6894,7 +6894,7 @@ or is a null reference (Nothing in Visual Basic). One or more exceptions occurred during the evaluation of the query. - contains no elements and is a non-nullable value type. + contains no elements and is a non-nullable value type. Parallel LINQ (PLINQ) @@ -6956,7 +6956,7 @@ or is a null reference (Nothing in Visual Basic). One or more exceptions occurred during the evaluation of the query. - contains no elements and is a non-nullable value type. + contains no elements and is a non-nullable value type. Parallel LINQ (PLINQ) @@ -7328,7 +7328,7 @@ or is a null reference (Nothing in Visual Basic). One or more exceptions occurred during the evaluation of the query. - contains no elements and is a non-nullable value type. + contains no elements and is a non-nullable value type. Parallel LINQ (PLINQ) @@ -7400,7 +7400,7 @@ or is a null reference (Nothing in Visual Basic). One or more exceptions occurred during the evaluation of the query. - contains no elements and is a non-nullable value type. + contains no elements and is a non-nullable value type. Parallel LINQ (PLINQ) @@ -7459,7 +7459,7 @@ is a null reference (Nothing in Visual Basic). One or more exceptions occurred during the evaluation of the query. - contains no elements and is a non-nullable value type. + contains no elements and is a non-nullable value type. Parallel LINQ (PLINQ) @@ -7508,7 +7508,7 @@ is a null reference (Nothing in Visual Basic). One or more exceptions occurred during the evaluation of the query. - contains no elements and is a non-nullable value type. + contains no elements and is a non-nullable value type. Parallel LINQ (PLINQ) @@ -7557,7 +7557,7 @@ is a null reference (Nothing in Visual Basic). One or more exceptions occurred during the evaluation of the query. - contains no elements and is a non-nullable value type. + contains no elements and is a non-nullable value type. Parallel LINQ (PLINQ) @@ -7606,7 +7606,7 @@ is a null reference (Nothing in Visual Basic). One or more exceptions occurred during the evaluation of the query. - contains no elements and is a non-nullable value type. + contains no elements and is a non-nullable value type. Parallel LINQ (PLINQ) @@ -7900,7 +7900,7 @@ is a null reference (Nothing in Visual Basic). One or more exceptions occurred during the evaluation of the query. - contains no elements and is a non-nullable value type. + contains no elements and is a non-nullable value type. Parallel LINQ (PLINQ) @@ -7961,7 +7961,7 @@ is a null reference (Nothing in Visual Basic). One or more exceptions occurred during the evaluation of the query. - contains no elements and is a non-nullable value type. + contains no elements and is a non-nullable value type. Parallel LINQ (PLINQ) @@ -8023,7 +8023,7 @@ or is a null reference (Nothing in Visual Basic). One or more exceptions occurred during the evaluation of the query. - contains no elements and is a non-nullable value type. + contains no elements and is a non-nullable value type. Parallel LINQ (PLINQ) @@ -8085,7 +8085,7 @@ or is a null reference (Nothing in Visual Basic). One or more exceptions occurred during the evaluation of the query. - contains no elements and is a non-nullable value type. + contains no elements and is a non-nullable value type. Parallel LINQ (PLINQ) @@ -8147,7 +8147,7 @@ or is a null reference (Nothing in Visual Basic). One or more exceptions occurred during the evaluation of the query. - contains no elements and is a non-nullable value type. + contains no elements and is a non-nullable value type. Parallel LINQ (PLINQ) @@ -8209,7 +8209,7 @@ or is a null reference (Nothing in Visual Basic). One or more exceptions occurred during the evaluation of the query. - contains no elements and is a non-nullable value type. + contains no elements and is a non-nullable value type. Parallel LINQ (PLINQ) @@ -8581,7 +8581,7 @@ or is a null reference (Nothing in Visual Basic). One or more exceptions occurred during the evaluation of the query. - contains no elements and is a non-nullable value type. + contains no elements and is a non-nullable value type. Parallel LINQ (PLINQ) @@ -8653,7 +8653,7 @@ or is a null reference (Nothing in Visual Basic). One or more exceptions occurred during the evaluation of the query. - contains no elements and is a non-nullable value type. + contains no elements and is a non-nullable value type. Parallel LINQ (PLINQ) @@ -9053,7 +9053,7 @@ ]]> - or is a null reference (Nothing in Visual Basic). + or is a null reference (Nothing in Visual Basic). The query was canceled with the token passed in through . One or more exceptions occurred during the evaluation of the query. Parallel LINQ (PLINQ) @@ -9594,7 +9594,7 @@ A sequence whose elements are the result of invoking the one-to-many transform function on each element of based on the index supplied to , and then mapping each of those sequence elements and their corresponding source element to a result element. To be added. - or is a null reference (Nothing in Visual Basic). + or is a null reference (Nothing in Visual Basic). The query was canceled with the token passed in through . More than Int32.MaxValue elements are enumerated by the query. One or more exceptions occurred during the evaluation of the query. @@ -9675,7 +9675,7 @@ A sequence whose elements are the result of invoking the one-to-many transform function on each element of based on the index supplied to , and then mapping each of those sequence elements and their corresponding source element to a result element. To be added. - or is a null reference (Nothing in Visual Basic). + or is a null reference (Nothing in Visual Basic). The query was canceled with the token passed in through . More than Int32.MaxValue elements are enumerated by the query. One or more exceptions occurred during the evaluation of the query. @@ -12320,7 +12320,7 @@ A function to extract a key from each element. A transform function to produce a result element value from each element. Creates a from a according to specified key selector and element selector functions. - A that contains values of type selected from the input sequence. + A that contains values of type selected from the input sequence. To be added. The query was canceled with the token passed in through . @@ -12404,7 +12404,7 @@ A transform function to produce a result element value from each element. An to compare keys. Creates a from a according to a specified key selector function, a comparer, and an element selector function. - A that contains values of type selected from the input sequence. + A that contains values of type selected from the input sequence. To be added. The query was canceled with the token passed in through . @@ -12680,7 +12680,7 @@ A function to extract a key from each element. A transform function to produce a result element value from each element. Creates an from a according to specified key selector and element selector functions. - A that contains values of type selected from the input sequence. + A that contains values of type selected from the input sequence. To be added. The query was canceled with the token passed in through . @@ -13453,7 +13453,7 @@ is not a valid value. - is used multiple times in the query. + is used multiple times in the query. Parallel LINQ (PLINQ) Merge Options in PLINQ How to: Specify Merge Options in PLINQ @@ -13630,7 +13630,7 @@ The second sequence to zip. A function to create a result element from two matching elements. Merges in parallel two sequences by using the specified predicate function. - A sequence that has elements of type that are obtained by performing pairwise on two sequences. If the sequence lengths are unequal, this truncates to the length of the shorter sequence. + A sequence that has elements of type that are obtained by performing pairwise on two sequences. If the sequence lengths are unequal, this truncates to the length of the shorter sequence. To be added. or or is a null reference (Nothing in Visual Basic). diff --git a/xml/System.Linq/Queryable.xml b/xml/System.Linq/Queryable.xml index f05c0832fc4..2a38f7f023c 100644 --- a/xml/System.Linq/Queryable.xml +++ b/xml/System.Linq/Queryable.xml @@ -899,7 +899,7 @@ ]]> - does not implement for some . + does not implement for some . is . @@ -2568,8 +2568,6 @@ The query behavior that occurs as a result of executing an expression tree that represents calling depends on the implementation of the type of the `source` parameter. The expected behavior is that it converts the values in `source` to type `TResult`. - - ## Examples The following code example demonstrates how to use to convert objects in a sequence to type . @@ -2580,7 +2578,7 @@ is . - An element in the sequence cannot be cast to type . + An element in the sequence cannot be cast to type . @@ -3212,7 +3210,7 @@ The last chunk will contain the remaining elements and may be of a smaller size. The type of the elements of . The to return a default value for if empty. Returns the elements of the specified sequence or the type parameter's default value in a singleton collection if the sequence is empty. - An that contains () if is empty; otherwise, . + An that contains () if is empty; otherwise, . The zero-based index of the element to retrieve. Returns the element at a specified index in a sequence or a default value if the index is out of range. - default() if is outside the bounds of ; otherwise, the element at the specified position in . + default() if is outside the bounds of ; otherwise, the element at the specified position in . The to return the first element of. Returns the first element of a sequence, or a default value if the sequence contains no elements. - default() if is empty; otherwise, the first element in . + default() if is empty; otherwise, the first element in . A function to test each element for a condition. Returns the first element of a sequence that satisfies a specified condition or a default value if no such element is found. - default() if is empty or if no element passes the test specified by ; otherwise, the first element in that passes the test specified by . + default() if is empty or if no element passes the test specified by ; otherwise, the first element in that passes the test specified by . A function to extract the key for each element. A function to map each source element to an element in an . Groups the elements of a sequence according to a specified key selector function and projects the elements for each group by using a specified function. - An IQueryable<IGrouping<TKey, TElement>> in C# or IQueryable(Of IGrouping(Of TKey, TElement)) in Visual Basic where each contains a sequence of objects of type and a key. + An IQueryable<IGrouping<TKey, TElement>> in C# or IQueryable(Of IGrouping(Of TKey, TElement)) in Visual Basic where each contains a sequence of objects of type and a key. A function to map each source element to an element in an . An to compare keys. Groups the elements of a sequence and projects the elements for each group by using a specified function. Key values are compared by using a specified comparer. - An IQueryable<IGrouping<TKey, TElement>> in C# or IQueryable(Of IGrouping(Of TKey, TElement)) in Visual Basic where each contains a sequence of objects of type and a key. + An IQueryable<IGrouping<TKey, TElement>> in C# or IQueryable(Of IGrouping(Of TKey, TElement)) in Visual Basic where each contains a sequence of objects of type and a key. A function to extract the key for each element. A function to create a result value from each group. Groups the elements of a sequence according to a specified key selector function and creates a result value from each group and its key. - An T:System.Linq.IQueryable`1 that has a type argument of and where each element represents a projection over a group and its key. + An T:System.Linq.IQueryable`1 that has a type argument of and where each element represents a projection over a group and its key. A function to create a result value from each group. An to compare keys. Groups the elements of a sequence according to a specified key selector function and creates a result value from each group and its key. Keys are compared by using a specified comparer. - An T:System.Linq.IQueryable`1 that has a type argument of and where each element represents a projection over a group and its key. + An T:System.Linq.IQueryable`1 that has a type argument of and where each element represents a projection over a group and its key. A function to map each source element to an element in an . A function to create a result value from each group. Groups the elements of a sequence according to a specified key selector function and creates a result value from each group and its key. The elements of each group are projected by using a specified function. - An T:System.Linq.IQueryable`1 that has a type argument of and where each element represents a projection over a group and its key. + An T:System.Linq.IQueryable`1 that has a type argument of and where each element represents a projection over a group and its key. A function to create a result value from each group. An to compare keys. Groups the elements of a sequence according to a specified key selector function and creates a result value from each group and its key. Keys are compared by using a specified comparer and the elements of each group are projected by using a specified function. - An T:System.Linq.IQueryable`1 that has a type argument of and where each element represents a projection over a group and its key. + An T:System.Linq.IQueryable`1 that has a type argument of and where each element represents a projection over a group and its key. A function to extract the join key from each element of the second sequence. A function to create a result element from an element from the first sequence and a collection of matching elements from the second sequence. Correlates the elements of two sequences based on key equality and groups the results. The default equality comparer is used to compare keys. - An that contains elements of type obtained by performing a grouped join on two sequences. + An that contains elements of type obtained by performing a grouped join on two sequences. A function to create a result element from an element from the first sequence and a collection of matching elements from the second sequence. A comparer to hash and compare keys. Correlates the elements of two sequences based on key equality and groups the results. A specified is used to compare keys. - An that contains elements of type obtained by performing a grouped join on two sequences. + An that contains elements of type obtained by performing a grouped join on two sequences. A function to extract the join key from each element of the second sequence. A function to create a result element from two matching elements. Correlates the elements of two sequences based on matching keys. The default equality comparer is used to compare keys. - An that has elements of type obtained by performing an inner join on two sequences. + An that has elements of type obtained by performing an inner join on two sequences. A function to create a result element from two matching elements. An to hash and compare keys. Correlates the elements of two sequences based on matching keys. A specified is used to compare keys. - An that has elements of type obtained by performing an inner join on two sequences. + An that has elements of type obtained by performing an inner join on two sequences. An to return the last element of. Returns the last element in a sequence, or a default value if the sequence contains no elements. - default() if is empty; otherwise, the last element in . + default() if is empty; otherwise, the last element in . A function to test each element for a condition. Returns the last element of a sequence that satisfies a condition or a default value if no such element is found. - default() if is empty or if no elements pass the test in the predicate function; otherwise, the last element of that passes the test in the predicate function. + default() if is empty or if no elements pass the test in the predicate function; otherwise, the last element of that passes the test in the predicate function. The type to filter the elements of the sequence on. An whose elements to filter. Filters the elements of an based on a specified type. - A collection that contains the elements from that have type . + A collection that contains the elements from that have type . The type of the elements of . An to return the single element of. Returns the only element of a sequence, or a default value if the sequence is empty; this method throws an exception if there is more than one element in the sequence. - The single element of the input sequence, or default() if the sequence contains no elements. + The single element of the input sequence, or default() if the sequence contains no elements. An to return a single element from. A function to test an element for a condition. Returns the only element of a sequence that satisfies a specified condition or a default value if no such element exists; this method throws an exception if more than one element satisfies the condition. - The single element of the input sequence that satisfies the condition in , or default() if no such element is found. + The single element of the input sequence that satisfies the condition in , or default() if no such element is found. The type of the elements of . - A sequence of values of type . + A sequence of values of type . A projection function to apply to each element. Computes the sum of the sequence of values that is obtained by invoking a projection function on each element of the input sequence. The sum of the projected values. @@ -10991,7 +10989,7 @@ If `count` is not a positive number, this method returns an identical copy of th The type of the elements of . - A sequence of values of type . + A sequence of values of type . A projection function to apply to each element. Computes the sum of the sequence of values that is obtained by invoking a projection function on each element of the input sequence. The sum of the projected values. @@ -11074,7 +11072,7 @@ If `count` is not a positive number, this method returns an identical copy of th The type of the elements of . - A sequence of values of type . + A sequence of values of type . A projection function to apply to each element. Computes the sum of the sequence of values that is obtained by invoking a projection function on each element of the input sequence. The sum of the projected values. @@ -11160,7 +11158,7 @@ If `count` is not a positive number, this method returns an identical copy of th The type of the elements of . - A sequence of values of type . + A sequence of values of type . A projection function to apply to each element. Computes the sum of the sequence of values that is obtained by invoking a projection function on each element of the input sequence. The sum of the projected values. @@ -11246,7 +11244,7 @@ If `count` is not a positive number, this method returns an identical copy of th The type of the elements of . - A sequence of values of type . + A sequence of values of type . A projection function to apply to each element. Computes the sum of the sequence of nullable values that is obtained by invoking a projection function on each element of the input sequence. The sum of the projected values. @@ -11332,7 +11330,7 @@ If `count` is not a positive number, this method returns an identical copy of th The type of the elements of . - A sequence of values of type . + A sequence of values of type . A projection function to apply to each element. Computes the sum of the sequence of nullable values that is obtained by invoking a projection function on each element of the input sequence. The sum of the projected values. @@ -11417,7 +11415,7 @@ If `count` is not a positive number, this method returns an identical copy of th The type of the elements of . - A sequence of values of type . + A sequence of values of type . A projection function to apply to each element. Computes the sum of the sequence of nullable values that is obtained by invoking a projection function on each element of the input sequence. The sum of the projected values. @@ -11503,7 +11501,7 @@ If `count` is not a positive number, this method returns an identical copy of th The type of the elements of . - A sequence of values of type . + A sequence of values of type . A projection function to apply to each element. Computes the sum of the sequence of nullable values that is obtained by invoking a projection function on each element of the input sequence. The sum of the projected values. @@ -11589,7 +11587,7 @@ If `count` is not a positive number, this method returns an identical copy of th The type of the elements of . - A sequence of values of type . + A sequence of values of type . A projection function to apply to each element. Computes the sum of the sequence of nullable values that is obtained by invoking a projection function on each element of the input sequence. The sum of the projected values. @@ -11674,7 +11672,7 @@ If `count` is not a positive number, this method returns an identical copy of th The type of the elements of . - A sequence of values of type . + A sequence of values of type . A projection function to apply to each element. Computes the sum of the sequence of values that is obtained by invoking a projection function on each element of the input sequence. The sum of the projected values. diff --git a/xml/System.Messaging/MessageQueue.xml b/xml/System.Messaging/MessageQueue.xml index 9d4e8af6857..20216db0c75 100644 --- a/xml/System.Messaging/MessageQueue.xml +++ b/xml/System.Messaging/MessageQueue.xml @@ -1784,8 +1784,6 @@ myMessageQueue.Send("Text 2."); //Resources are re-acquired. |Remote computer|No| |Remote computer and direct format name|No| - - ## Examples The following code example creates public and private queues. It sends a message to selected queues. @@ -1858,8 +1856,6 @@ myMessageQueue.Send("Text 2."); //Resources are re-acquired. |Remote computer|No| |Remote computer and direct format name|No| - - ## Examples The following code example creates public and private transactional queues. It sends a message to selected queues.