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

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions xml/System.AddIn.Hosting/AddInProcess.xml
Original file line number Diff line number Diff line change
Expand Up @@ -111,8 +111,8 @@
## Remarks
The following table shows how `platform` affects the bits-per-word of the process on different operating systems:

||32-bit operating system|64-bit operating system|
|-|------------------------------|------------------------------|
| `platform` | 32-bit operating system | 64-bit operating system |
|------------|-------------------------|--------------------------|
| Host | 32-bit | Same as the host process |
| AnyCPU | 32-bit | 64-bit |
| X86 | 32-bit | 32-bit |
Expand Down
5 changes: 2 additions & 3 deletions xml/System.AddIn.Hosting/Platform.xml
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,10 @@
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks
The following table shows how the enumeration value affects the bits-per-word of the process on different operating systems:

||32-bit operating system|64-bit operating system|
|-|------------------------------|------------------------------|
| Platform | 32-bit operating system | 64-bit operating system |
|----------|-------------------------|-------------------------|
| Host | 32-bit | Same as host process |
| AnyCPU | 32-bit | 64-bit |
| X86 | 32-bit | 32-bit |
Expand Down
4 changes: 2 additions & 2 deletions xml/System.Buffers.Text/Utf8Formatter.xml
Original file line number Diff line number Diff line change
Expand Up @@ -766,9 +766,9 @@ If the method fails, iteratively increase the size of the buffer and retry until
Formats supported:

| Format string | Result string | Comments |
|--|--|--|
|-----------------|----------------------------------------|-------------------|
| c/t/T (default) | [-][d.]hh:mm:ss[.fffffff] | (constant format) |
|G|[-]d:hh:mm:ss.fffffff||(general long)|
| G | [-]d:hh:mm:ss.fffffff | (general long) |
| g | [-][d:][h]h:mm:ss[.f[f[f[f[f[f[f]]]]]] | (general short) |

If the method fails, iteratively increase the size of the buffer and retry until it succeeds.
Expand Down
4 changes: 2 additions & 2 deletions xml/System.Buffers.Text/Utf8Parser.xml
Original file line number Diff line number Diff line change
Expand Up @@ -752,9 +752,9 @@ Format string|Example expected fornmat|Comments|
Formats supported:

| Format string | Expected format | Comments |
|--|--|--|
|-----------------|----------------------------------------|-------------------|
| c/t/T (default) | [-][d.]hh:mm:ss[.fffffff] | (constant format) |
|G|[-]d:hh:mm:ss.fffffff||(general long)|
| G | [-]d:hh:mm:ss.fffffff | (general long) |
| g | [-][d:][h]h:mm:ss[.f[f[f[f[f[f[f]]]]]] | (general short) |

]]></format>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@
Like the <xref:System.Collections.Generic.Dictionary%602?displayProperty=nameWithType> class, <xref:System.Collections.Concurrent.ConcurrentDictionary%602> implements the <xref:System.Collections.Generic.IDictionary%602> interface. In addition, <xref:System.Collections.Concurrent.ConcurrentDictionary%602> provides several methods for adding or updating key/value pairs in the dictionary, as described in the following table.

| To do this | Use this method | Usage notes |
|----------------|---------------------|-----------------|
|------------|-----------------|-------------|
|Add a new key to the dictionary, if it doesn't already exist in the dictionary|<xref:System.Collections.Concurrent.ConcurrentDictionary%602.TryAdd%2A>|This method adds the specified key/value pair, if the key doesn't currently exist in the dictionary. The method returns `true` or `false` depending on whether the new pair was added.|
|Update the value for an existing key in the dictionary, if that key has a specific value|<xref:System.Collections.Concurrent.ConcurrentDictionary%602.TryUpdate%2A>|This method checks whether the key has a specified value, and if it does, updates the key with a new value. It's similar to the <xref:System.Threading.Interlocked.CompareExchange%2A> method, except that it's used for dictionary elements.|
|Store a key/value pair in the dictionary unconditionally, and overwrite the value of a key that already exists|The indexer's setter: `dictionary[key] = newValue`| |
Expand Down
12 changes: 4 additions & 8 deletions xml/System.Collections.Immutable/ImmutableArray`1.xml
Original file line number Diff line number Diff line change
Expand Up @@ -106,24 +106,20 @@
Reasons to use immutable array:

- Updating the data is rare or the number of elements is quite small (less than 16 items)

- You need to be able to iterate over the data in performance critical sections

- You have many instances of immutable collections and you can't afford keeping the data in trees

Reasons to use immutable list:

- Updating the data is common or the number of elements isn't expected to be small

- Updating the collection is more performance critical than iterating the contents

The following table summarizes the performance characteristics of <xref:System.Collections.Immutable.ImmutableArray%601>

|||||
|-|-|-|-|
|**Operation**|<xref:System.Collections.Immutable.ImmutableArray%601> Complexity|<xref:System.Collections.Immutable.ImmutableList%601> Complexity|**Comments**|
|**Item**|O(1)|O(log n)|Directly index into the underlying array|
|**Add()**|O(n)|O(log n)|Requires creating a new array|
| Operation | ImmutableArray complexity | ImmutableList complexity | Comments |
| --------- | ------------------------- | ------------------------ | -------- |
| `Item` | O(1) | O(log n) | Directly index into the underlying array |
| `Add()` | O(n) | O(log n) | Requires creating a new array |

## Examples
This example shows how to create an immutable array and iterate over elements in it:
Expand Down
12 changes: 5 additions & 7 deletions xml/System.ComponentModel/DesignerProperties.xml
Original file line number Diff line number Diff line change
Expand Up @@ -94,17 +94,15 @@
<format type="text/markdown"><![CDATA[

## Remarks
Component and control developers may use this property to perform different logic when running in the context of a designer than they would when running in an application.
Component and control developers might use this property to perform different logic when running in the context of a designer than they would when running in an application.

Designers may change the value of this property to move a control from design mode to run mode and back. Components that make changes to their state based on the value of this property should override the virtual <xref:System.Windows.FrameworkElement.OnPropertyChanged%2A> method and update their state if their **IsInDesignMode** property value changes.
Designers might change the value of this property to move a control from design mode to run mode and back. Components that make changes to their state based on the value of this property should override the virtual <xref:System.Windows.FrameworkElement.OnPropertyChanged%2A> method and update their state if their **IsInDesignMode** property value changes.

<a name="dependencyPropertyInfo_DesignerPropertiesIsInDesignMode"></a>
## Dependency Property Information

|||
|-|-|
|Identifier field|<xref:System.ComponentModel.DesignerProperties.IsInDesignModeProperty>|
|Metadata properties set to `true`|<xref:System.Windows.FrameworkPropertyMetadata.OverridesInheritanceBehavior%2A>, <xref:System.Windows.FrameworkPropertyMetadata.Inherits%2A>|
| Identifier field | Metadata properties set to `true` |
|------------------|-----------------------------------|
| <xref:System.ComponentModel.DesignerProperties.IsInDesignModeProperty> | <xref:System.Windows.FrameworkPropertyMetadata.OverridesInheritanceBehavior%2A>, <xref:System.Windows.FrameworkPropertyMetadata.Inherits%2A> |

]]></format>
</remarks>
Expand Down
23 changes: 2 additions & 21 deletions xml/System.Data.SqlClient/SqlDataReader.xml
Original file line number Diff line number Diff line change
Expand Up @@ -1101,15 +1101,7 @@ This member is an explicit interface member implementation. It can be used only
## Remarks
`T` can be one of the following types:

|||||
|-|-|-|-|
|Boolean|Byte|Char|DateTime|
|DateTimeOffset|Decimal|Double|Float|
|Guid|Int16|Int32|Int64|
|SqlBoolean|SqlByte|SqlDateTime|SqlDecimal|
|SqlDouble|SqlGuid|SqlInt16|SqlInt32|
|SqlInt64|SqlMoney|SqlSingle|SqlString|
|String|UDT, which can be any CLR type marked with <xref:Microsoft.SqlServer.Server.SqlUserDefinedTypeAttribute>.|||
Boolean, Byte, Char, DateTime, DateTimeOffset, Decimal, Double, Float, Guid, Int16, Int32, Int64, SqlBoolean, SqlByte, SqlDateTime, SqlDecimal, SqlDouble, SqlGuid, SqlInt16, SqlInt32, SqlInt64, SqlMoney, SqlSingle, SqlString, String, or UDT (any CLR type marked with <xref:Microsoft.SqlServer.Server.SqlUserDefinedTypeAttribute>).

For more information, see [SqlClient Streaming Support](/dotnet/framework/data/adonet/sqlclient-streaming-support).

Expand Down Expand Up @@ -1181,15 +1173,7 @@ This member is an explicit interface member implementation. It can be used only
## Remarks
`T` can be one of the following types:

|||||
|-|-|-|-|
|Boolean|Byte|Char|DateTime|
|DateTimeOffset|Decimal|Double|Float|
|Guid|Int16|Int32|Int64|
|SqlBoolean|SqlByte|SqlDateTime|SqlDecimal|
|SqlDouble|SqlGuid|SqlInt16|SqlInt32|
|SqlInt64|SqlMoney|SqlSingle|SqlString|
|String|UDT, which can be any CLR type marked with <xref:Microsoft.SqlServer.Server.SqlUserDefinedTypeAttribute>.|||
Boolean, Byte, Char, DateTime, DateTimeOffset, Decimal, Double, Float, Guid, Int16, Int32, Int64, SqlBoolean, SqlByte, SqlDateTime, SqlDecimal, SqlDouble, SqlGuid, SqlInt16, SqlInt32, SqlInt64, SqlMoney, SqlSingle, SqlString, String, or UDT (any CLR type marked with <xref:Microsoft.SqlServer.Server.SqlUserDefinedTypeAttribute>).

For more information, see [SqlClient Streaming Support](/dotnet/framework/data/adonet/sqlclient-streaming-support).

Expand Down Expand Up @@ -2831,11 +2815,8 @@ This member is an explicit interface member implementation. It can be used only
<exception cref="T:System.InvalidCastException">The returned type was not one of the types below:

- binary

- image

- varbinary

- udt
</exception>
</Docs>
Expand Down
10 changes: 5 additions & 5 deletions xml/System.IO.Packaging/PackageDigitalSignature.xml
Original file line number Diff line number Diff line change
Expand Up @@ -70,9 +70,9 @@
<format type="text/markdown"><![CDATA[

## Remarks
X.509 certificates used to validate a package may be stored in one of three locations:
X.509 certificates used to validate a package can be stored in one of three locations:

|||
| Embedding option | Location |
|-|-|
|<xref:System.IO.Packaging.CertificateEmbeddingOption.InCertificatePart>|In its own certificate <xref:System.IO.Packaging.PackagePart> in the package.<br /><br /> The X.509 certificate can be obtained through the <xref:System.IO.Packaging.PackageDigitalSignature.Signer%2A> property.|
|<xref:System.IO.Packaging.CertificateEmbeddingOption.InSignaturePart>|Within the content of the <xref:System.IO.Packaging.PackageDigitalSignature.SignaturePart%2A> in the package.<br /><br /> The X.509 certificate can be obtained through the <xref:System.IO.Packaging.PackageDigitalSignature.Signer%2A> property.|
Expand Down Expand Up @@ -418,10 +418,10 @@
|YYYY-MM-DDThh:mm:ssTZD|Complete date plus hours, minutes, and seconds|2005-07-28T19:20:45-01:00|
|YYYY-MM-DDThh:mm:ss.sTZD|Complete date plus hours, minutes, and seconds with a decimal fraction|2005-07-28T19:20:45.75-01:00|

where:
The following table shows the expected placeholder values.

|||
|-|-|
| Placeholder | Value |
|-------------|----------------------------------------------------------------|
| YYYY | four-digit year (for example 2006) |
| MM | two-digit month (01=January) |
| DD | two-digit day of month (01 through 31) |
Expand Down
4 changes: 2 additions & 2 deletions xml/System.IO.Packaging/PackageRelationship.xml
Original file line number Diff line number Diff line change
Expand Up @@ -49,9 +49,9 @@
## Remarks
A <xref:System.IO.Packaging.PackageRelationship> defines an association between a *source* <xref:System.IO.Packaging.Package> or <xref:System.IO.Packaging.PackagePart> to a *target* <xref:System.IO.Packaging.PackagePart> or external resource. The source object is considered the "owner" of the relationship.

The <xref:System.IO.Packaging.PackageRelationship> class has no public constructor; instead, two Create methods are used:
The <xref:System.IO.Packaging.PackageRelationship> class has no public constructor; instead, two `Create` methods are used:

|||
| `Create` method | Description |
|-|-|
|<xref:System.IO.Packaging.Package>.<xref:System.IO.Packaging.Package.CreateRelationship%2A>|Creates a "package-level" relationship-from a package to a specified part or external resource.|
|<xref:System.IO.Packaging.PackagePart>.<xref:System.IO.Packaging.PackagePart.CreateRelationship%2A>|Creates a "part-level" relationship-from one part to another part or external resource.|
Expand Down
7 changes: 3 additions & 4 deletions xml/System.Numerics/BigInteger.xml
Original file line number Diff line number Diff line change
Expand Up @@ -288,16 +288,17 @@
<format type="text/markdown"><![CDATA[

## Remarks

The individual bytes in the `value` array should be in little-endian order, from lowest-order byte to highest-order byte. For example, the numeric value 1,000,000,000,000 is represented as shown in the following table:

|||
| Representation | Value |
|-|-|
|Hexadecimal string|E8D4A51000|
|Byte array (lowest index first)|00 10 A5 D4 E8 00|

Most methods that convert numeric values to byte arrays, such as <xref:System.Numerics.BigInteger.ToByteArray%2A?displayProperty=nameWithType> and <xref:System.BitConverter.GetBytes%2A?displayProperty=nameWithType>, return byte arrays in little-endian order.

The constructor expects positive values in the byte array to use sign-and-magnitude representation, and negative values to use two's complement representation. In other words, if the highest-order bit of the highest-order byte in `value` is set, the resulting <xref:System.Numerics.BigInteger> value is negative. Depending on the source of the byte array, this may cause a positive value to be misinterpreted as a negative value. Byte arrays are typically generated in the following ways:
The constructor expects positive values in the byte array to use sign-and-magnitude representation, and negative values to use two's complement representation. In other words, if the highest-order bit of the highest-order byte in `value` is set, the resulting <xref:System.Numerics.BigInteger> value is negative. Depending on the source of the byte array, this might cause a positive value to be misinterpreted as a negative value. Byte arrays are typically generated in the following ways:

- By calling the <xref:System.Numerics.BigInteger.ToByteArray%2A?displayProperty=nameWithType> method. Because this method returns a byte array with the highest-order bit of the highest-order byte in the array set to zero for positive values, there is no chance of misinterpreting a positive value as negative. Unmodified byte arrays created by the <xref:System.Numerics.BigInteger.ToByteArray%2A> method always successfully round-trip when they are passed to the <xref:System.Numerics.BigInteger.%23ctor%28System.Byte%5B%5D%29> constructor.

Expand All @@ -309,8 +310,6 @@

If `value` is an empty <xref:System.Byte> array, the new <xref:System.Numerics.BigInteger> object is initialized to a value of <xref:System.Numerics.BigInteger.Zero%2A?displayProperty=nameWithType>. If `value` is `null`, the constructor throws an <xref:System.ArgumentNullException>.



## Examples
The following example instantiates a <xref:System.Numerics.BigInteger> object from a 5-element byte array whose value is {5, 4, 3, 2, 1}. It then displays the <xref:System.Numerics.BigInteger> value, represented as both decimal and hexadecimal numbers, to the console. A comparison of the input array with the text output makes it clear why this overload of the <xref:System.Numerics.BigInteger> class constructor creates a <xref:System.Numerics.BigInteger> object whose value is 4328719365 (or 0x102030405). The first element of the byte array, whose value is 5, defines the value of the lowest-order byte of the <xref:System.Numerics.BigInteger> object, which is 0x05. The second element of the byte array, whose value is 4, defines the value of the second byte of the <xref:System.Numerics.BigInteger> object, which is 0x04, and so on.

Expand Down
7 changes: 3 additions & 4 deletions xml/System.Security.Cryptography/PaddingMode.xml
Original file line number Diff line number Diff line change
Expand Up @@ -62,13 +62,12 @@
<format type="text/markdown"><![CDATA[

## Remarks
Most plain text messages do not consist of a number of bytes that completely fill blocks. Often, there are not enough bytes to fill the last block. When this happens, a padding string is added to the text. For example, if the block length is 64 bits and the last block contains only 40 bits, 24 bits of padding are added.
Most plain text messages don't consist of bytes that completely fill blocks. Often, there aren't enough bytes to fill the last block. When this happens, a padding string is added to the text. For example, if the block length is 64 bits and the last block contains only 40 bits, 24 bits of padding are added.

Some encryption standards specify a particular padding scheme. The following example shows how these modes work. Given a blocklength of 8, a data length of 9, the number of padding octets equal to 7, and the data equal to FF FF FF FF FF FF FF FF FF:

|||
|-|-|
|**Data:**|FF FF FF FF FF FF FF FF FF|
| Padding scheme | Data with padding |
|-----------------------|-------------------------------------------------|
| **X923 padding:** | FF FF FF FF FF FF FF FF FF 00 00 00 00 00 00 07 |
| **PKCS7 padding:** | FF FF FF FF FF FF FF FF FF 07 07 07 07 07 07 07 |
| **ISO10126 padding:** | FF FF FF FF FF FF FF FF FF 7D 2A 75 EF F8 EF 07 |
Expand Down
11 changes: 5 additions & 6 deletions xml/System.Text.RegularExpressions/Match.xml
Original file line number Diff line number Diff line change
Expand Up @@ -80,15 +80,14 @@

- You can use the <xref:System.Text.RegularExpressions.GroupCollection.Item%28System.String%29?displayProperty=nameWithType> property to retrieve groups by the name of the capturing group. Note that you can determine which named groups are present in a regular expression by calling the instance <xref:System.Text.RegularExpressions.Regex.GetGroupNames?displayProperty=nameWithType> method.



## Examples

The following examples use the regular expression `Console\.Write(Line)?`. The regular expression is interpreted as follows:

|||
|-|-|
|Console\\.Write|Match the string "Console.Write". Note that the "." character is escaped so that it is interpreted as a literal period rather than as a wildcard that matches any character.|
|(Line)?|Match zero or one occurrence of the string "Line".|
| Pattern | Description |
|------------------|----------------------------------------------------|
| `Console\.Write` | Match the string "Console.Write". (The "." character is escaped so that it's interpreted as a literal period rather than as a wildcard that matches any character.) |
| `(Line)?` | Match zero or one occurrence of the string "Line". |

**Example 1**

Expand Down
4 changes: 1 addition & 3 deletions xml/System.Text.RegularExpressions/Regex.xml
Original file line number Diff line number Diff line change
Expand Up @@ -4238,8 +4238,6 @@ For more details about `startat`, see the Remarks section of <xref:System.Text.R

Because of its lazy evaluation, calling the <xref:System.Text.RegularExpressions.Regex.Matches(System.String)> method does not throw a <xref:System.Text.RegularExpressions.RegexMatchTimeoutException> exception. However, the exception is thrown when an operation is performed on the <xref:System.Text.RegularExpressions.MatchCollection> object returned by this method, if the <xref:System.Text.RegularExpressions.Regex.MatchTimeout%2A> property is not <xref:System.Text.RegularExpressions.Regex.InfiniteMatchTimeout?displayProperty=nameWithType> and a matching operation exceeds the time-out interval.



## Examples
The following example uses the <xref:System.Text.RegularExpressions.Regex.Matches(System.String)> method to identify any words in a sentence that end in "es".

Expand All @@ -4249,7 +4247,7 @@ For more details about `startat`, see the Remarks section of <xref:System.Text.R
The regular expression pattern `\b\w+es\b` is defined as shown in the following table.

| Pattern | Description |
|-------------|-----------------|
|---------|-------------------------------------|
| `\b` | Begin the match at a word boundary. |
| `\w+` | Match one or more word characters. |
| `es` | Match the literal string "es". |
Expand Down
Loading
Loading