8000 Merge main into live by cxwtool · Pull Request #7368 · dotnet/dotnet-api-docs · GitHub
[go: up one dir, main page]
Skip to content

Merge main into live #7368

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 10 commits into from
Nov 9, 2021
Merged

Merge main into live #7368

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
6f39263
Update IConfiguration.xml
electricalArt Nov 7, 2021
b224e41
Mention C# native integers in IntPtr/UIntPtr docs (#7364)
MSDN-WhiteKnight Nov 8, 2021
b378cd5
Fixed identation (#7365)
thide11 Nov 8, 2021
1b6d3f6
Update xml/Microsoft.Extensions.Configuration/IConfiguration.xml
electricalArt Nov 8, 2021
10119af
Update obsoletion note in summary (#7359)
gewarren Nov 8, 2021
b989fd3
Update SecureString.xml (#7344)
tangentyh Nov 8, 2021
ed13070
Add exception (#7360)
gewarren Nov 9, 2021
0ed967e
Merge pull request #7363 from Narick9/patch-1
eerhardt Nov 9, 2021
0ac6458
add new exceptions (#7367)
gewarren Nov 9, 2021
86b113a
merge main branch
cxwtool Nov 9, 2021
File filter

Filter by extension

Filter by extension 8000
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 29 additions & 29 deletions ...sharp/VS_Snippets_CLR_System/system.threading.cancellationtokensource.class/cs/cancel1.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,43 +20,43 @@ public static void Main()
for (int taskCtr = 0; taskCtr <= 10; taskCtr++) {
int iteration = taskCtr + 1;
tasks.Add(factory.StartNew( () => {
int value;
int[] values = new int[10];
for (int ctr = 1; ctr <= 10; ctr++) {
lock (lockObj) {
value = rnd.Next(0,101);
}
if (value == 0) {
source.Cancel();
Console.WriteLine("Cancelling at task {0}", iteration);
break;
}
values[ctr-1] = value;
}
return values;
}, token));
int value;
int[] values = new int[10];
for (int ctr = 1; ctr <= 10; ctr++) {
lock (lockObj) {
value = rnd.Next(0,101);
}
if (value == 0) {
source.Cancel();
Console.WriteLine("Cancelling at task {0}", iteration);
break;
}
values[ctr-1] = value;
}
return values;
}, token));
}
try {
Task<double> fTask = factory.ContinueWhenAll(tasks.ToArray(),
(results) => {
Console.WriteLine("Calculating overall mean...");
long sum = 0;
int n = 0;
foreach (var t in results) {
foreach (var r in t.Result) {
sum += r;
n++;
}
}
return sum/(double) n;
} , token);
(results) => {
Console.WriteLine("Calculating overall mean...");
long sum = 0;
int n = 0;
foreach (var t in results) {
foreach (var r in t.Result) {
sum += r;
n++;
}
}
return sum/(double) n;
} , token);
Console.WriteLine("The mean is {0}.", fTask.Result);
}
catch (AggregateException ae) {
foreach (Exception e in ae.InnerExceptions) {
if (e is TaskCanceledException)
Console.WriteLine("Unable to compute mean: {0}",
((TaskCanceledException) e).Message);
((TaskCanceledException) e).Message);
else
Console.WriteLine("Exception: " + e.GetType().Name);
}
Expand Down Expand Up @@ -99,4 +99,4 @@ public static void Main()
//
// Calculating overall mean...
// The mean is 4.86545454545455.
// </Snippet1>
// </Snippet1>
4 changes: 3 additions & 1 deletion xml/Microsoft.Extensions.Configuration/IConfiguration.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,9 @@
<summary>Gets a configuration sub-section with the specified key.</summary>
<returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationSection" />.</returns>
<remarks>This method will never return <see langword="null" />. If no matching sub-section is found with the specified key,
an empty <see cref="T:Microsoft.Extensions.Configuration.IConfigurationSection" /> will be returned.</remarks>
an empty <see cref="T:Microsoft.Extensions.Configuration.IConfigurationSection" /> will be returned.

You can reach a sub-subsection by passing "section1:section2:section.." for <paramref name="key"/>.</remarks>
</Docs>
</Member>
<Member MemberName="Item">
Expand Down
13 changes: 6 additions & 7 deletions xml/Microsoft.Extensions.DependencyInjection/ISupportRequiredService.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,7 @@
</AssemblyInfo>
<Interfaces />
<Docs>
<summary>Optional contract used by <see cref="M:Microsoft.Extensions.DependencyInjection.ServiceProviderServiceExtensions.GetRequiredService``1(System.IServiceProvider)" />
to resolve services if supported by <see cref="T:System.IServiceProvider" />.</summary>
<summary>Optional contract used by <see cref="M:Microsoft.Extensions.DependencyInjection.ServiceProviderServiceExtensions.GetRequiredService``1(System.IServiceProvider)" /> to resolve services if supported by <see cref="T:System.IServiceProvider" />.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
Expand Down Expand Up @@ -51,12 +50,12 @@
<Parameter Name="serviceType" Type="System.Type" />
</Parameters>
<Docs>
<param name="serviceType">An object that specifies the type of service object to get.</param>
<summary>Gets service of type <paramref name="serviceType" /> from the <see cref="T:System.IServiceProvider" /> implementing
this interface.</summary>
<returns>A service object of type <paramref name="serviceType" />.
Throws an exception if the <see cref="T:System.IServiceProvider" /> cannot create the object.</returns>
<param name="serviceType">The type of service object to get.</param>
<summary>Gets service of type <paramref name="serviceType" /> from the <see cref="T:System.IServiceProvider" /> that implements this interface.</summary>
<returns>A service object of type <paramref name="serviceType" />. Throws an exception if the <see cref="T:System.IServiceProvider" /> cannot create the object.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ObjectDisposedException">
<paramref name="provider" /> has already been disposed.</exception>
</Docs>
</Member>
</Members>
Expand Down
4 changes: 4 additions & 0 deletions xml/Microsoft.Extensions.DependencyInjection/ServiceProviderServiceExtensions.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,6 +142,8 @@
<returns>A service object of type <paramref name="serviceType" />.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.InvalidOperationException">There is no service of type <paramref name="serviceType" />.</exception>
<exception cref="T:System.ObjectDisposedException">
<paramref name="provider" /> has already been disposed.</exception>
</Docs>
</Member>
<Member MemberName="GetRequiredService&lt;T&gt;">
Expand Down Expand Up @@ -180,6 +182,8 @@
<returns>A service object of type <typeparamref name="T" />.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.InvalidOperationException">There is no service of type <typeparamref name="T" />.</exception>
<exception cref="T:System.ObjectDisposedException">
<paramref name="provider" /> has already been disposed.</exception>
</Docs>
</Member>
<Member MemberName="GetService&lt;T&gt;">
Expand Down
20 changes: 11 additions & 9 deletions xml/Microsoft.Extensions.Logging/LoggerFactory.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
</Interface>
</Interfaces>
<Docs>
<summary>Produces instances of <see cref="T:Microsoft.Extensions.Logging.ILogger" /> classes based on the given providers.</summary>
<summary>Produces instances of <see cref="T:Microsoft.Extensions.Logging.ILogger" /> classes based on the specified providers.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
Expand Down Expand Up @@ -81,7 +81,7 @@
</Parameters>
<Docs>
<param name="providers">The providers to use in producing <see cref="T:Microsoft.Extensions.Logging.ILogger" /> instances.</param>
<summary>Creates a new <see cref="T:Microsoft.Extensions.Logging.LoggerFactory" /> instance.</summary>
<summary>Creates a new <see cref="T:Microsoft.Extensions.Logging.LoggerFactory" /> instance with the specified providers.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -110,7 +110,7 @@
<Docs>
<param name="providers">The providers to use in producing <see cref="T:Microsoft.Extensions.Logging.ILogger" /> instances.</param>
<param name="filterOptions">The filter options to use.</param>
<summary>Creates a new <see cref="T:Microsoft.Extensions.Logging.LoggerFactory" /> instance.</summary>
<summary>Creates a new <see cref="T:Microsoft.Extensions.Logging.LoggerFactory" /> instance with the specified providers and filter options.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -139,7 +139,7 @@
<Docs>
<param name="providers">The providers to use in producing <see cref="T:Microsoft.Extensions.Logging.ILogger" /> instances.</param>
<param name="filterOption">The filter option to use.</param>
<summary>Creates a new <see cref="T:Microsoft.Extensions.Logging.LoggerFactory" /> instance.</summary>
<summary>Creates a new <see cref="T:Microsoft.Extensions.Logging.LoggerFactory" /> instance with the specified providers and filter option.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -164,7 +164,7 @@
<param name="providers">The providers to use in producing <see cref="T:Microsoft.Extensions.Logging.ILogger" /> instances.</param>
<param name="filterOption">The filter option to use.</param>
<param name="options">The logger factory options.</param>
<summary>Creates a new <see cref="T:Microsoft.Extensions.Logging.LoggerFactory" /> instance with the specified providers, filter option and logger factory options.</summary>
<summary>Creates a new <see cref="T:Microsoft.Extensions.Logging.LoggerFactory" /> instance with the specified providers, filter option, and logger factory options.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -199,8 +199,10 @@
</Parameters>
<Docs>
<param name="provider">The <see cref="T:Microsoft.Extensions.Logging.ILoggerProvider" /> to add.</param>
<summary>Adds the given provider to those used in creating <see cref="T:Microsoft.Extensions.Logging.ILogger" /> instances.</summary>
<summary>Adds the specified provider to the collection of providers used in creating <see cref="T:Microsoft.Extensions.Logging.ILogger" /> instances.</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="provider" /> is <see langword="null" />.</exception>
</Docs>
</Member>
<Member MemberName="CheckDisposed">
Expand All @@ -227,7 +229,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>Check if the factory has been disposed.</summary>
<summary>Checks if the factory has been disposed.</summary>
<returns>
<see langword="true" /> if <see cref="M:Microsoft.Extensions.Logging.LoggerFactory.Dispose" /> has been called; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
Expand Down Expand Up @@ -256,7 +258,7 @@
</Parameters>
<Docs>
<param name="configure">A delegate to configure the <see cref="T:Microsoft.Extensions.Logging.ILoggingBuilder" />.</param>
<summary>Creates new instance of <see cref="T:Microsoft.Extensions.Logging.ILoggerFactory" /> configured using provided <paramref name="configure" /> delegate.</summary>
<summary>Creates a new instance of <see cref="T:Microsoft.Extensions.Logging.ILoggerFactory" /> that's configured using the provided <paramref name="configure" /> delegate.</summary>
<returns>The <see cref="T:Microsoft.Extensions.Logging.ILoggerFactory" /> that was created.</returns>
<remarks>To be added.</remarks>
</Docs>
Expand Down Expand Up @@ -292,7 +294,7 @@
</Parameters>
<Docs>
<param name="categoryName">The category name for messages produced by the logger.</param>
<summary>Creates an <see cref="T:Microsoft.Extensions.Logging.ILogger" /> with the given <paramref name="categoryName" />.</summary>
<summary>Creates an <see cref="T:Microsoft.Extensions.Logging.ILogger" /> with the specified <paramref name="categoryName" />.</summary>
<returns>The <see cref="T:Microsoft.Extensions.Logging.ILogger" /> that was created.</returns>
<remarks>To be added.</remarks>
</Docs>
Expand Down
2 changes: 1 addition & 1 deletion xml/System.Net.Mail/SmtpClient.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@
</Attribute>
</Attributes>
<Docs>
<summary>Allows applications to send email by using the Simple Mail Transfer Protocol (SMTP). The <c>SmtpClient</c> type is now obsolete.</summary>
<summary>Allows applications to send email by using the Simple Mail Transfer Protocol (SMTP). The <see cref="T:System.Net.Mail.SmtpClient" /> type is obsolete on some platforms and not recommended on others; for more information, see the Remarks section.</summary>
<remarks>
<format type="text/markdown"><![CDATA[

Expand Down
4 changes: 2 additions & 2 deletions xml/System.Security/SecureString.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@

- <xref:System.Runtime.InteropServices.Marshal.SecureStringToCoTaskMemAnsi%2A?displayPrope 10000 rty=nameWithType> and <xref:System.Runtime.InteropServices.Marshal.SecureStringToGlobalAllocAnsi%2A?displayProperty=nameWithType>, which copy the <xref:System.Security.SecureString> string value to an ANSI string in unmanaged memory.

- <xref:System.Runtime.InteropServices.Marshal.SecureStringToCoTaskMemUnicode%2A?displayProperty=nameWithType> and <xref:System.Runtime.InteropServices.Marshal.SecureStringToCoTaskMemUnicode%2A?displayProperty=nameWithType>, which copy the <xref:System.Security.SecureString> string value to a Unicode string in unmanaged memory.
- <xref:System.Runtime.InteropServices.Marshal.SecureStringToCoTaskMemUnicode%2A?displayProperty=nameWithType> and <xref:System.Runtime.InteropServices.Marshal.SecureStringToGlobalAllocUnicode%2A?displayProperty=nameWithType>, which copy the <xref:System.Security.SecureString> string value to a Unicode string in unmanaged memory.

Each of these methods creates a clear-text string in unmanaged memory. It is the responsibility of the developer to zero out and free that memory as soon as it is no longer needed. Each of the string conversion and memory allocation methods has a corresponding method to zero out and free the allocated memory:

Expand All @@ -139,7 +139,7 @@
|<xref:System.Runtime.InteropServices.Marshal.SecureStringToCoTaskMemAnsi%2A?displayProperty=nameWithType>|<xref:System.Runtime.InteropServices.Marshal.ZeroFreeCoTaskMemAnsi%2A?displayProperty=nameWithType>|
|<xref:System.Runtime.InteropServices.Marshal.SecureStringToCoTaskMemUnicode%2A?displayProperty=nameWithType>|<xref:System.Runtime.InteropServices.Marshal.ZeroFreeCoTaskMemUnicode%2A?displayProperty=nameWithType>|
|<xref:System.Runtime.InteropServices.Marshal.SecureStringToGlobalAllocAnsi%2A?displayProperty=nameWithType>|<xref:System.Runtime.InteropServices.Marshal.ZeroFreeGlobalAllocAnsi%2A?displayProperty=nameWithType>|
|<xref:System.Runtime.InteropServices.Marshal.SecureStringToCoTaskMemUnicode%2A?displayProperty=nameWithType>|<xref:System.Runtime.InteropServices.Marshal.ZeroFreeGlobalAllocUnicode%2A?displayProperty=nameWithType>|
|<xref:System.Runtime.InteropServices.Marshal.SecureStringToGlobalAllocUnicode%2A?displayProperty=nameWithType>|<xref:System.Runtime.InteropServices.Marshal.ZeroFreeGlobalAllocUnicode%2A?displayProperty=nameWithType>|

[Back to top](#top)

Expand Down
2 changes: 2 additions & 0 deletions xml/System/IntPtr.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,8 @@
The <xref:System.IntPtr> type is CLS-compliant, while the <xref:System.UIntPtr> type is not. Only the <xref:System.IntPtr> type is used in the common language runtime. The <xref:System.UIntPtr> type is provided mostly to maintain architectural symmetry with the <xref:System.IntPtr> type.

This type implements the <xref:System.Runtime.Serialization.ISerializable>, and, in .NET 5.0 and later, the <xref:System.IFormattable> interfaces.

In C# starting from version 9.0, you can use the built-in `nint` type to define native-sized integers. This type is represented by the <xref:System.IntPtr> type internally and provides operations and conversions that are appropriate for integer types. For more information, see [nint and nuint types](/dotnet/csharp/language-reference/builtin-types/nint-nuint).

## Examples

Expand Down
2 changes: 2 additions & 0 deletions xml/System/UIntPtr.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,8 @@
The <xref:System.UIntPtr> type can be used by languages that support pointers, and as a common means of referring to data between languages that do and do not support pointers. <xref:System.UIntPtr> objects can also be used to hold handles.

This type implements the <xref:System.Runtime.Serialization.ISerializable>, and, in .NET 5.0 and later, the <xref:System.IFormattable> interfaces.

In C# starting from version 9.0, you can use the built-in `nuint` type to define native-sized integers. This type is represented by the <xref:System.UIntPtr> type internally and provides operations and conversions that are appropriate for integer types. For more information, see [nint and nuint types](/dotnet/csharp/language-reference/builtin-types/nint-nuint).

]]></format>
</remarks>
Expand Down
0