diff --git a/xml/Microsoft.Extensions.Caching.Distributed/DistributedCacheExtensions.xml b/xml/Microsoft.Extensions.Caching.Distributed/DistributedCacheExtensions.xml index 31273638650..537ac4efd7d 100644 --- a/xml/Microsoft.Extensions.Caching.Distributed/DistributedCacheExtensions.xml +++ b/xml/Microsoft.Extensions.Caching.Distributed/DistributedCacheExtensions.xml @@ -145,6 +145,7 @@ Asynchronously gets a string from the specified cache with the specified key. A task that gets the string value from the stored cache key. 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 . + The cancellation token was canceled. This exception is stored into the returned task. @@ -257,6 +258,7 @@ 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 . or is null. + The cancellation token was canceled. This exception is stored into the returned task. @@ -445,6 +447,7 @@ 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 . or is null. + The cancellation token was canceled. This exception is stored into the returned task. @@ -487,6 +490,7 @@ 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 . or is null. + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/Microsoft.Extensions.Caching.Distributed/IDistributedCache.xml b/xml/Microsoft.Extensions.Caching.Distributed/IDistributedCache.xml index f30cfc8f682..09e39478d97 100644 --- a/xml/Microsoft.Extensions.Caching.Distributed/IDistributedCache.xml +++ b/xml/Microsoft.Extensions.Caching.Distributed/IDistributedCache.xml @@ -126,6 +126,7 @@ Gets a value with the given key. The that represents the asynchronous operation, containing the located value or null. 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 . + The cancellation token was canceled. This exception is stored into the returned task. @@ -220,6 +221,7 @@ Refreshes a value in the cache based on its key, resetting its sliding expiration timeout (if any). The that represents the asynchronous operation. 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 . + The cancellation token was canceled. This exception is stored into the returned task. @@ -314,6 +316,7 @@ Removes the value with the given key. The that represents the asynchronous operation. 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 . + The cancellation token was canceled. This exception is stored into the returned task. @@ -420,6 +423,7 @@ Sets the value with the given key. The that represents the asynchronous operation. 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 . + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/Microsoft.Extensions.Caching.Distributed/MemoryDistributedCache.xml b/xml/Microsoft.Extensions.Caching.Distributed/MemoryDistributedCache.xml index 54f948c354c..74adbfce3e7 100644 --- a/xml/Microsoft.Extensions.Caching.Distributed/MemoryDistributedCache.xml +++ b/xml/Microsoft.Extensions.Caching.Distributed/MemoryDistributedCache.xml @@ -225,6 +225,7 @@ Gets a value with the given key. The that represents the asynchronous operation, containing the located value or . 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 . + The cancellation token was canceled. This exception is stored into the returned task. @@ -328,6 +329,7 @@ Refreshes a value in the cache based on its key, resetting its sliding expiration timeout (if any). The that represents the asynchronous operation. 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 . + The cancellation token was canceled. This exception is stored into the returned task. @@ -431,6 +433,7 @@ Removes the value with the given key. The that represents the asynchronous operation. 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 . + The cancellation token was canceled. This exception is stored into the returned task. @@ -546,6 +549,7 @@ Sets the value with the given key. The that represents the asynchronous operation. 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 . + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/Microsoft.Extensions.Caching.Redis/RedisCache.xml b/xml/Microsoft.Extensions.Caching.Redis/RedisCache.xml index f03fc5b692e..3fc7650055a 100644 --- a/xml/Microsoft.Extensions.Caching.Redis/RedisCache.xml +++ b/xml/Microsoft.Extensions.Caching.Redis/RedisCache.xml @@ -172,6 +172,7 @@ Gets a value with the given key. The that represents the asynchronous operation, containing the located value or . 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 . + The cancellation token was canceled. This exception is stored into the returned task. @@ -263,6 +264,7 @@ Refreshes a value in the cache based on its key, resetting its sliding expiration timeout (if any). The that represents the asynchronous operation. 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 . + The cancellation token was canceled. This exception is stored into the returned task. @@ -354,6 +356,7 @@ Removes the value with the given key. The that represents the asynchronous operation. 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 . + The cancellation token was canceled. This exception is stored into the returned task. @@ -457,6 +460,7 @@ Sets the value with the given key. The that represents the asynchronous operation. 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 . + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/Microsoft.Extensions.Caching.SqlServer/SqlServerCache.xml b/xml/Microsoft.Extensions.Caching.SqlServer/SqlServerCache.xml index d54b0b0a2f3..1a8eb1e4bb2 100644 --- a/xml/Microsoft.Extensions.Caching.SqlServer/SqlServerCache.xml +++ b/xml/Microsoft.Extensions.Caching.SqlServer/SqlServerCache.xml @@ -149,6 +149,7 @@ Gets a value with the given key. The that represents the asynchronous operation, containing the located value or . 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 . + The cancellation token was canceled. This exception is stored into the returned task. @@ -244,6 +245,7 @@ Refreshes a value in the cache based on its key, resetting its sliding expiration timeout (if any). The that represents the asynchronous operation. 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 . + The cancellation token was canceled. This exception is stored into the returned task. @@ -339,6 +341,7 @@ Removes the value with the given key. The that represents the asynchronous operation. 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 . + The cancellation token was canceled. This exception is stored into the returned task. @@ -446,6 +449,7 @@ Sets the value with the given key. The that represents the asynchronous operation. 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 . + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/Microsoft.Extensions.Caching.StackExchangeRedis/RedisCache.xml b/xml/Microsoft.Extensions.Caching.StackExchangeRedis/RedisCache.xml index 558e1a5ecb6..32a31b304df 100644 --- a/xml/Microsoft.Extensions.Caching.StackExchangeRedis/RedisCache.xml +++ b/xml/Microsoft.Extensions.Caching.StackExchangeRedis/RedisCache.xml @@ -135,6 +135,7 @@ Gets a value with the given key. The that represents the asynchronous operation, containing the located value or . 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 . + The cancellation token was canceled. This exception is stored into the returned task. @@ -195,6 +196,7 @@ Refreshes a value in the cache based on its key, resetting its sliding expiration timeout (if any). The that represents the asynchronous operation. 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 . + The cancellation token was canceled. This exception is stored into the returned task. @@ -255,6 +257,7 @@ Removes the value with the given key. The that represents the asynchronous operation. 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 . + The cancellation token was canceled. This exception is stored into the returned task. @@ -323,6 +326,7 @@ Sets the value with the given key. The that represents the asynchronous operation. 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 . + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/Microsoft.Extensions.Diagnostics.HealthChecks/HealthCheckService.xml b/xml/Microsoft.Extensions.Diagnostics.HealthChecks/HealthCheckService.xml index 7e9adbcfd5d..61b3d7ec11d 100644 --- a/xml/Microsoft.Extensions.Diagnostics.HealthChecks/HealthCheckService.xml +++ b/xml/Microsoft.Extensions.Diagnostics.HealthChecks/HealthCheckService.xml @@ -104,6 +104,7 @@ yielding a containing the results. To be added. + The cancellation token was canceled. This exception is stored into the returned task. @@ -149,6 +150,7 @@ yielding a containing the results. . To be added. + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/Microsoft.Extensions.Diagnostics.HealthChecks/IHealthCheck.xml b/xml/Microsoft.Extensions.Diagnostics.HealthChecks/IHealthCheck.xml index 49d3dfae255..8d6be21f09c 100644 --- a/xml/Microsoft.Extensions.Diagnostics.HealthChecks/IHealthCheck.xml +++ b/xml/Microsoft.Extensions.Diagnostics.HealthChecks/IHealthCheck.xml @@ -58,6 +58,7 @@ Runs the health check, returning the status of the component being checked. A that completes when the health check has finished, yielding the status of the component being checked. To be added. + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/Microsoft.Extensions.Diagnostics.HealthChecks/IHealthCheckPublisher.xml b/xml/Microsoft.Extensions.Diagnostics.HealthChecks/IHealthCheckPublisher.xml index 40be8a3eba4..df572dabb2d 100644 --- a/xml/Microsoft.Extensions.Diagnostics.HealthChecks/IHealthCheckPublisher.xml +++ b/xml/Microsoft.Extensions.Diagnostics.HealthChecks/IHealthCheckPublisher.xml @@ -74,6 +74,7 @@ Publishes the provided . A which will complete when publishing is complete. To be added. + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/Microsoft.Extensions.Diagnostics.ResourceMonitoring/IResourceUtilizationPublisher.xml b/xml/Microsoft.Extensions.Diagnostics.ResourceMonitoring/IResourceUtilizationPublisher.xml index f1edb13de50..ed9935ca45f 100644 --- a/xml/Microsoft.Extensions.Diagnostics.ResourceMonitoring/IResourceUtilizationPublisher.xml +++ b/xml/Microsoft.Extensions.Diagnostics.ResourceMonitoring/IResourceUtilizationPublisher.xml @@ -44,6 +44,7 @@ ValueTask because operation can finish synchronously. To be added. + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/Microsoft.Extensions.Hosting.Internal/ConsoleLifetime.xml b/xml/Microsoft.Extensions.Hosting.Internal/ConsoleLifetime.xml index 6bb2d91951f..15ced5d06bc 100644 --- a/xml/Microsoft.Extensions.Hosting.Internal/ConsoleLifetime.xml +++ b/xml/Microsoft.Extensions.Hosting.Internal/ConsoleLifetime.xml @@ -1,291 +1,293 @@ - - - - - - - - - Microsoft.Extensions.Hosting - 2.1.0.0 - 2.2.0.0 - 3.0.0.0 - 3.1.0.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - System.Object - - - - Microsoft.Extensions.Hosting.IHostLifetime - - - System.IDisposable - - - - - [System.Runtime.Versioning.UnsupportedOSPlatform("android")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("android")>] - - - [System.Runtime.Versioning.UnsupportedOSPlatform("browser")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("browser")>] - - - [System.Runtime.Versioning.UnsupportedOSPlatform("ios")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("ios")>] - - - [System.Runtime.Versioning.UnsupportedOSPlatform("tvos")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("tvos")>] - - - [System.Runtime.CompilerServices.Nullable(0)] - [<System.Runtime.CompilerServices.Nullable(0)>] - - - [System.Runtime.CompilerServices.NullableContext(1)] - [<System.Runtime.CompilerServices.NullableContext(1)>] - - - - Listens for Ctrl+C or SIGTERM and initiates shutdown. - + + + + + + + + + Microsoft.Extensions.Hosting + 2.1.0.0 + 2.2.0.0 + 3.0.0.0 + 3.1.0.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + System.Object + + + + Microsoft.Extensions.Hosting.IHostLifetime + + + System.IDisposable + + + + + [System.Runtime.Versioning.UnsupportedOSPlatform("android")] + [<System.Runtime.Versioning.UnsupportedOSPlatform("android")>] + + + [System.Runtime.Versioning.UnsupportedOSPlatform("browser")] + [<System.Runtime.Versioning.UnsupportedOSPlatform("browser")>] + + + [System.Runtime.Versioning.UnsupportedOSPlatform("ios")] + [<System.Runtime.Versioning.UnsupportedOSPlatform("ios")>] + + + [System.Runtime.Versioning.UnsupportedOSPlatform("tvos")] + [<System.Runtime.Versioning.UnsupportedOSPlatform("tvos")>] + + + [System.Runtime.CompilerServices.Nullable(0)] + [<System.Runtime.CompilerServices.Nullable(0)>] + + + [System.Runtime.CompilerServices.NullableContext(1)] + [<System.Runtime.CompilerServices.NullableContext(1)>] + + + + Listens for Ctrl+C or SIGTERM and initiates shutdown. + - - - - - - - - - - - Constructor - - Microsoft.Extensions.Hosting - 2.1.0.0 - 2.2.0.0 - - - - - - - - To be added. - To be added. - To be added. - This API supports infrastructure and is not intended to be used directly from your code. This API may change or be removed in future releases. - To be added. - - - - - - - - - - Constructor - - Microsoft.Extensions.Hosting - 3.0.0.0 - 3.1.0.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - - - - - - - An object used to retrieve instances. - An object that contains information about the hosting environment an application is running in. - An object that allows consumers to be notified of application lifetime events. - An object used to retrieve instances. - This API supports infrastructure and is not intended to be used directly from your code. This API may change or be removed in future releases. - To be added. - - or or or is . - - - - - - - - - - Constructor - - Microsoft.Extensions.Hosting - 3.0.0.0 - 3.1.0.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - - - - - - - - An object used to retrieve instances - An object that contains information about the hosting environment an application is running in. - An object that allows consumers to be notified of application lifetime events. - An object used to retrieve instances. - An object to configure the logging system and create instances of from the registered . - This API supports infrastructure and is not intended to be used directly from your code. This API may change or be removed in future releases. - To be added. - - or or or or is . - - - - - - - - - - Method - - M:System.IDisposable.Dispose - - - Microsoft.Extensions.Hosting - 2.1.0.0 - 2.2.0.0 - 3.0.0.0 - 3.1.0.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - System.Void - - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - +]]> + + + + + + + + + + + Constructor + + Microsoft.Extensions.Hosting + 2.1.0.0 + 2.2.0.0 + + + + + + + + To be added. + To be added. + To be added. + This API supports infrastructure and is not intended to be used directly from your code. This API may change or be removed in future releases. + To be added. + + + + + + + + + + Constructor + + Microsoft.Extensions.Hosting + 3.0.0.0 + 3.1.0.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + + + + + + + An object used to retrieve instances. + Information about the hosting environment an application is running in. + An object that allows consumers to be notified of application lifetime events. + An object used to retrieve internal host options instances. + This API supports infrastructure and is not intended to be used directly from your code. This API may change or be removed in future releases. + To be added. + + or or or is . + + + + + + + + + + Constructor + + Microsoft.Extensions.Hosting + 3.0.0.0 + 3.1.0.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + + + + + + + + An object used to retrieve instances + Information about the hosting environment an application is running in. + An object that allows consumers to be notified of application lifetime events. + An object used to retrieve internal host options instances. + An object to configure the logging system and create instances of from the registered . + This API supports infrastructure and is not intended to be used directly from your code. This API may change or be removed in future releases. + To be added. + + or or or or is . + + + + + + + + + + Method + + M:System.IDisposable.Dispose + + + Microsoft.Extensions.Hosting + 2.1.0.0 + 2.2.0.0 + 3.0.0.0 + 3.1.0.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + System.Void + + + + Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. + - - - - - - - - - - - Method - - M:Microsoft.Extensions.Hosting.IHostLifetime.StopAsync(System.Threading.CancellationToken) - - - Microsoft.Extensions.Hosting - 2.1.0.0 - 2.2.0.0 - 3.0.0.0 - 3.1.0.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - System.Threading.Tasks.Task - - - - - - Used to indicate when stop should no longer be graceful. - Called from to indicate that the host is stopping and it's time to shut down. - A . - +]]> + + + + + + + + + + + Method + + M:Microsoft.Extensions.Hosting.IHostLifetime.StopAsync(System.Threading.CancellationToken) + + + Microsoft.Extensions.Hosting + 2.1.0.0 + 2.2.0.0 + 3.0.0.0 + 3.1.0.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + System.Threading.Tasks.Task + + + + + + Used to indicate when stop should no longer be graceful. + Called from to indicate that the host is stopping and it's time to shut down. + A . + - - - - - - - - - - - Method - - M:Microsoft.Extensions.Hosting.IHostLifetime.WaitForStartAsync(System.Threading.CancellationToken) - - - Microsoft.Extensions.Hosting - 2.1.0.0 - 2.2.0.0 - 3.0.0.0 - 3.1.0.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - System.Threading.Tasks.Task - - - - - - Used to indicate when stop should no longer be graceful. - Called at the start of , which will wait until it's complete before continuing. This can be used to delay startup until signaled by an external event. - A . - +]]> + + The cancellation token was canceled. This exception is stored into the returned task. + + + + + + + + + + Method + + M:Microsoft.Extensions.Hosting.IHostLifetime.WaitForStartAsync(System.Threading.CancellationToken) + + + Microsoft.Extensions.Hosting + 2.1.0.0 + 2.2.0.0 + 3.0.0.0 + 3.1.0.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + System.Threading.Tasks.Task + + + + + + Used to indicate when stop should no longer be graceful. + Called at the start of , which will wait until it's complete before continuing. This can be used to delay startup until signaled by an external event. + A . + - - - - - +]]> + + The cancellation token was canceled. This exception is stored into the returned task. + + + + diff --git a/xml/Microsoft.Extensions.Hosting.Systemd/SystemdLifetime.xml b/xml/Microsoft.Extensions.Hosting.Systemd/SystemdLifetime.xml index 246a856845c..5b62d720bea 100644 --- a/xml/Microsoft.Extensions.Hosting.Systemd/SystemdLifetime.xml +++ b/xml/Microsoft.Extensions.Hosting.Systemd/SystemdLifetime.xml @@ -106,6 +106,7 @@ Asynchronously stops and shuts down the host. This method is called from . A task that represents the asynchronous stop operation. To be added. + The cancellation token was canceled. This exception is stored into the returned task. @@ -135,6 +136,7 @@ Asynchronously waits until the start operation is complete before continuing. This method is called at the beginning of . This can be used to delay startup until signaled by an external event. A task that represents the waiting for start operation. To be added. + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/Microsoft.Extensions.Hosting.Testing/FakeHost.xml b/xml/Microsoft.Extensions.Hosting.Testing/FakeHost.xml index b4cb3a2b6b4..7d9d6808781 100644 --- a/xml/Microsoft.Extensions.Hosting.Testing/FakeHost.xml +++ b/xml/Microsoft.Extensions.Hosting.Testing/FakeHost.xml @@ -194,6 +194,7 @@ A that will be completed when the starts. If no cancellation token is given, a new one using is used. + The cancellation token was canceled. This exception is stored into the returned task. @@ -223,6 +224,7 @@ A that will be completed when the stops. If no cancellation token is given, a new one using is used. + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/Microsoft.Extensions.Hosting.Testing/HostingFakesExtensions.xml b/xml/Microsoft.Extensions.Hosting.Testing/HostingFakesExtensions.xml index bf3a1becaba..11a484af194 100644 --- a/xml/Microsoft.Extensions.Hosting.Testing/HostingFakesExtensions.xml +++ b/xml/Microsoft.Extensions.Hosting.Testing/HostingFakesExtensions.xml @@ -324,6 +324,7 @@ A representing the asynchronous operation. To be added. + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/Microsoft.Extensions.Hosting.WindowsServices/WindowsServiceLifetime.xml b/xml/Microsoft.Extensions.Hosting.WindowsServices/WindowsServiceLifetime.xml index 83d319a8439..37e55f04555 100644 --- a/xml/Microsoft.Extensions.Hosting.WindowsServices/WindowsServiceLifetime.xml +++ b/xml/Microsoft.Extensions.Hosting.WindowsServices/WindowsServiceLifetime.xml @@ -1,189 +1,191 @@ - - - - - - - - - Microsoft.Extensions.Hosting.WindowsServices - 3.0.0.0 - 3.1.0.0 - - - System.ServiceProcess.ServiceBase - - - - Microsoft.Extensions.Hosting.IHostLifetime - - - - Listens for shutdown signal and tracks the status of the Windows service. - To be added. - - - - - - - - - - Constructor - - Microsoft.Extensions.Hosting.WindowsServices - 3.0.0.0 - 3.1.0.0 - - - - - - - - - Information about the host. - The that tracks the service lifetime. - The used to instantiate the lifetime logger. - The containing options for the service. - Initializes a new instance. - To be added. - - - - - - - - - - Method - - Microsoft.Extensions.Hosting.WindowsServices - 3.0.0.0 - 3.1.0.0 - - - System.Void - - - - - - - only when called from ; otherwise, . - Releases the resources used by the . - To be added. - - - - - - - - - - Method - - Microsoft.Extensions.Hosting.WindowsServices - 3.0.0.0 - 3.1.0.0 - - - System.Void - - - - - - To be added. - To be added. - To be added. - - - - - - - - - - - Method - - Microsoft.Extensions.Hosting.WindowsServices - 3.0.0.0 - 3.1.0.0 - - - System.Void - - - + + + + + + + + + Microsoft.Extensions.Hosting.WindowsServices + 3.0.0.0 + 3.1.0.0 + + + System.ServiceProcess.ServiceBase + + + + Microsoft.Extensions.Hosting.IHostLifetime + + + + Listens for shutdown signal and tracks the status of the Windows service. + To be added. + + + + + + + + + + Constructor + + Microsoft.Extensions.Hosting.WindowsServices + 3.0.0.0 + 3.1.0.0 + + + + + + + + + Information about the host. + The that tracks the service lifetime. + The used to instantiate the lifetime logger. + The containing options for the service. + Initializes a new instance. + To be added. + + + + + + + + + + Method + + Microsoft.Extensions.Hosting.WindowsServices + 3.0.0.0 + 3.1.0.0 + + + System.Void + + + + + + + only when called from ; otherwise, . + Releases the resources used by the . + To be added. + + + + + + + + + + Method + + Microsoft.Extensions.Hosting.WindowsServices + 3.0.0.0 + 3.1.0.0 + + + System.Void + + + + + + To be added. + To be added. + To be added. + + + + + + + + + + + Method + + Microsoft.Extensions.Hosting.WindowsServices + 3.0.0.0 + 3.1.0.0 + + + System.Void + + + Executes when a Stop command is sent to the service by the Service Control Manager (SCM). Triggers and waits for . - Shortly after this method returns, the Service will be marked as stopped in SCM and the process may exit at any point. - To be added. - - - - - - - - - - Method - - M:Microsoft.Extensions.Hosting.IHostLifetime.StopAsync(System.Threading.CancellationToken) - - - Microsoft.Extensions.Hosting.WindowsServices - 3.0.0.0 - 3.1.0.0 - - - System.Threading.Tasks.Task - - - - - - A cancellation token that indicates when stop should no longer be graceful. - Asynchronously stops and shuts down the host. This method is called from . - A task that represents the asynchronous stop operation. - To be added. - - - - - - - - - - Method - - M:Microsoft.Extensions.Hosting.IHostLifetime.WaitForStartAsync(System.Threading.CancellationToken) - - - Microsoft.Extensions.Hosting.WindowsServices - 3.0.0.0 - 3.1.0.0 - - - System.Threading.Tasks.Task - - - - - - A cancellation token that indicates when stop should no longer be graceful. - Asynchronously waits until start is complete before continuing. This method is called at the beginning of . This can be used to delay startup until signaled by an external event. - A task that represents the asynchronous waiting for start operation. - To be added. - - - - + Shortly after this method returns, the Service will be marked as stopped in SCM and the process may exit at any point. + To be added. + + + + + + + + + + Method + + M:Microsoft.Extensions.Hosting.IHostLifetime.StopAsync(System.Threading.CancellationToken) + + + Microsoft.Extensions.Hosting.WindowsServices + 3.0.0.0 + 3.1.0.0 + + + System.Threading.Tasks.Task + + + + + + A cancellation token that indicates when stop should no longer be graceful. + Asynchronously stops and shuts down the host. This method is called from . + A task that represents the asynchronous stop operation. + To be added. + The cancellation token was canceled. This exception is stored into the returned task. + + + + + + + + + + Method + + M:Microsoft.Extensions.Hosting.IHostLifetime.WaitForStartAsync(System.Threading.CancellationToken) + + + Microsoft.Extensions.Hosting.WindowsServices + 3.0.0.0 + 3.1.0.0 + + + System.Threading.Tasks.Task + + + + + + A cancellation token that indicates when stop should no longer be graceful. + Asynchronously waits until start is complete before continuing. This method is called at the beginning of . This can be used to delay startup until signaled by an external event. + A task that represents the asynchronous waiting for start operation. + To be added. + The cancellation token was canceled. This exception is stored into the returned task. + + + + diff --git a/xml/Microsoft.Extensions.Hosting/BackgroundService.xml b/xml/Microsoft.Extensions.Hosting/BackgroundService.xml index 54ef64e3930..47a758b5c92 100644 --- a/xml/Microsoft.Extensions.Hosting/BackgroundService.xml +++ b/xml/Microsoft.Extensions.Hosting/BackgroundService.xml @@ -1,267 +1,270 @@ - - - - - - - - - Microsoft.Extensions.Hosting.Abstractions - 2.1.0.0 - 2.2.0.0 - 3.0.0.0 - 3.1.0.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - System.Object - - - - Microsoft.Extensions.Hosting.IHostedService - - - System.IDisposable - - - - Base class for implementing a long running . - To be added. - - - - - - - - - Constructor - - Microsoft.Extensions.Hosting.Abstractions - 2.1.0.0 - 2.2.0.0 - 3.0.0.0 - 3.1.0.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - - Initializes a new instance of the class. - To be added. - - - - - - - - - - Method - - M:System.IDisposable.Dispose - - - Microsoft.Extensions.Hosting.Abstractions - 2.1.0.0 - 2.2.0.0 - 3.0.0.0 - 3.1.0.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - System.Void - - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - To be added. - - - - - - - - - - - Method - - Microsoft.Extensions.Hosting.Abstractions - 2.1.0.0 - 2.2.0.0 - 3.0.0.0 - 3.1.0.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - - [System.Runtime.CompilerServices.NullableContext(1)] - [<System.Runtime.CompilerServices.NullableContext(1)>] - - - - System.Threading.Tasks.Task - - - - - - Triggered when is called. + + + + + + + + + Microsoft.Extensions.Hosting.Abstractions + 2.1.0.0 + 2.2.0.0 + 3.0.0.0 + 3.1.0.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + System.Object + + + + Microsoft.Extensions.Hosting.IHostedService + + + System.IDisposable + + + + Base class for implementing a long running . + To be added. + + + + + + + + + Constructor + + Microsoft.Extensions.Hosting.Abstractions + 2.1.0.0 + 2.2.0.0 + 3.0.0.0 + 3.1.0.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + + Initializes a new instance of the class. + To be added. + + + + + + + + + + Method + + M:System.IDisposable.Dispose + + + Microsoft.Extensions.Hosting.Abstractions + 2.1.0.0 + 2.2.0.0 + 3.0.0.0 + 3.1.0.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + System.Void + + + + Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. + To be added. + + + + + + + + + + + Method + + Microsoft.Extensions.Hosting.Abstractions + 2.1.0.0 + 2.2.0.0 + 3.0.0.0 + 3.1.0.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + + [System.Runtime.CompilerServices.NullableContext(1)] + [<System.Runtime.CompilerServices.NullableContext(1)>] + + + + System.Threading.Tasks.Task + + + + + + Triggered when is called. This method is called when the starts. The implementation should return a task that represents - the lifetime of the long running operation(s) being performed. - A that represents the long running operations. - + the lifetime of the long running operation(s) being performed. + A that represents the long running operations. + - - - - - - - - - - - - Property - - Microsoft.Extensions.Hosting.Abstractions - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - - [System.Runtime.CompilerServices.Nullable(2)] - [<System.Runtime.CompilerServices.Nullable(2)>] - - - [get: System.Runtime.CompilerServices.NullableContext(2)] - [<get: System.Runtime.CompilerServices.NullableContext(2)>] - - - - System.Threading.Tasks.Task - - - Gets the Task that executes the background operation. - To be added. - + ]]> + + The cancellation token was canceled. This exception is stored into the returned task. + + + + + + + + + + + Property + + Microsoft.Extensions.Hosting.Abstractions + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + + [System.Runtime.CompilerServices.Nullable(2)] + [<System.Runtime.CompilerServices.Nullable(2)>] + + + [get: System.Runtime.CompilerServices.NullableContext(2)] + [<get: System.Runtime.CompilerServices.NullableContext(2)>] + + + + System.Threading.Tasks.Task + + + Gets the Task that executes the background operation. + To be added. + - - - - - - - - - - - Method - - M:Microsoft.Extensions.Hosting.IHostedService.StartAsync(System.Threading.CancellationToken) - - - Microsoft.Extensions.Hosting.Abstractions - 2.1.0.0 - 2.2.0.0 - 3.0.0.0 - 3.1.0.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - - [System.Runtime.CompilerServices.NullableContext(1)] - [<System.Runtime.CompilerServices.NullableContext(1)>] - - - - System.Threading.Tasks.Task - - - - - - Indicates that the start process has been aborted. - Triggered when the application host is ready to start the service. - A that represents the asynchronous Start operation. - To be added. - - - - - - - - - - Method - - M:Microsoft.Extensions.Hosting.IHostedService.StopAsync(System.Threading.CancellationToken) - - - Microsoft.Extensions.Hosting.Abstractions - 2.1.0.0 - 2.2.0.0 - 3.0.0.0 - 3.1.0.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - - [System.Diagnostics.DebuggerStepThrough] - [<System.Diagnostics.DebuggerStepThrough>] - - - [System.Runtime.CompilerServices.NullableContext(1)] - [<System.Runtime.CompilerServices.NullableContext(1)>] - - - - System.Threading.Tasks.Task - - - - - - Indicates that the shutdown process should no longer be graceful. - Triggered when the application host is performing a graceful shutdown. - A that represents the asynchronous Stop operation. - To be added. - - - - + ]]> + + + + + + + + + + + Method + + M:Microsoft.Extensions.Hosting.IHostedService.StartAsync(System.Threading.CancellationToken) + + + Microsoft.Extensions.Hosting.Abstractions + 2.1.0.0 + 2.2.0.0 + 3.0.0.0 + 3.1.0.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + + [System.Runtime.CompilerServices.NullableContext(1)] + [<System.Runtime.CompilerServices.NullableContext(1)>] + + + + System.Threading.Tasks.Task + + + + + + Indicates that the start process has been aborted. + Triggered when the application host is ready to start the service. + A that represents the asynchronous Start operation. + To be added. + The cancellation token was canceled. This exception is stored into the returned task. + + + + + + + + + + Method + + M:Microsoft.Extensions.Hosting.IHostedService.StopAsync(System.Threading.CancellationToken) + + + Microsoft.Extensions.Hosting.Abstractions + 2.1.0.0 + 2.2.0.0 + 3.0.0.0 + 3.1.0.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + + [System.Diagnostics.DebuggerStepThrough] + [<System.Diagnostics.DebuggerStepThrough>] + + + [System.Runtime.CompilerServices.NullableContext(1)] + [<System.Runtime.CompilerServices.NullableContext(1)>] + + + + System.Threading.Tasks.Task + + + + + + Indicates that the shutdown process should no longer be graceful. + Triggered when the application host is performing a graceful shutdown. + A that represents the asynchronous Stop operation. + To be added. + The cancellation token was canceled. This exception is stored into the returned task. + + + + diff --git a/xml/Microsoft.Extensions.Hosting/HostingAbstractionsHostBuilderExtensions.xml b/xml/Microsoft.Extensions.Hosting/HostingAbstractionsHostBuilderExtensions.xml index c8a5d336752..1ccb9a8fd7a 100644 --- a/xml/Microsoft.Extensions.Hosting/HostingAbstractionsHostBuilderExtensions.xml +++ b/xml/Microsoft.Extensions.Hosting/HostingAbstractionsHostBuilderExtensions.xml @@ -102,6 +102,7 @@ Builds and starts the host. The started . 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 . + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/Microsoft.Extensions.Hosting/HostingAbstractionsHostExtensions.xml b/xml/Microsoft.Extensions.Hosting/HostingAbstractionsHostExtensions.xml index be61ad04a20..98dbcb279bc 100644 --- a/xml/Microsoft.Extensions.Hosting/HostingAbstractionsHostExtensions.xml +++ b/xml/Microsoft.Extensions.Hosting/HostingAbstractionsHostExtensions.xml @@ -1,245 +1,247 @@ - - - - - - - - - Microsoft.Extensions.Hosting.Abstractions - 2.1.0.0 - 2.2.0.0 - 3.0.0.0 - 3.1.0.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - System.Object - - - - - [System.Runtime.CompilerServices.Nullable(0)] - [<System.Runtime.CompilerServices.Nullable(0)>] - - - [System.Runtime.CompilerServices.NullableContext(1)] - [<System.Runtime.CompilerServices.NullableContext(1)>] - - - - Provides extension methods for the from the hosting abstractions package. - To be added. - - - - - - - - - - Method - - Microsoft.Extensions.Hosting.Abstractions - 2.1.0.0 - 2.2.0.0 - 3.0.0.0 - 3.1.0.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - System.Void - - - - - - The to run. - Runs an application and blocks the calling thread until host shutdown is triggered and all instances are stopped. - To be added. - - - - - - - - - Method - - Microsoft.Extensions.Hosting.Abstractions - 2.1.0.0 - 2.2.0.0 - 3.0.0.0 - 3.1.0.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - - [System.Diagnostics.DebuggerStepThrough] - [<System.Diagnostics.DebuggerStepThrough>] - - - - System.Threading.Tasks.Task - - - - - - - The to run. - The token to trigger shutdown. - Runs an application and returns a Task that only completes when the token is triggered or shutdown is triggered and all instances are stopped. - The that represents the asynchronous operation. - 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 . - - - - - - - - - - Method - - Microsoft.Extensions.Hosting.Abstractions - 2.1.0.0 - 2.2.0.0 - 3.0.0.0 - 3.1.0.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - System.Void - - - - - - The to start. - Starts the host synchronously. - To be added. - - - - - - - - - - Method - - Microsoft.Extensions.Hosting.Abstractions - 2.1.0.0 - 2.2.0.0 - 3.0.0.0 - 3.1.0.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - System.Threading.Tasks.Task - - - - - - - The to stop. + + + + + + + + + Microsoft.Extensions.Hosting.Abstractions + 2.1.0.0 + 2.2.0.0 + 3.0.0.0 + 3.1.0.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + System.Object + + + + + [System.Runtime.CompilerServices.Nullable(0)] + [<System.Runtime.CompilerServices.Nullable(0)>] + + + [System.Runtime.CompilerServices.NullableContext(1)] + [<System.Runtime.CompilerServices.NullableContext(1)>] + + + + Provides extension methods for the from the hosting abstractions package. + To be added. + + + + + + + + + + Method + + Microsoft.Extensions.Hosting.Abstractions + 2.1.0.0 + 2.2.0.0 + 3.0.0.0 + 3.1.0.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + System.Void + + + + + + The to run. + Runs an application and blocks the calling thread until host shutdown is triggered and all instances are stopped. + To be added. + + + + + + + + + Method + + Microsoft.Extensions.Hosting.Abstractions + 2.1.0.0 + 2.2.0.0 + 3.0.0.0 + 3.1.0.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + + [System.Diagnostics.DebuggerStepThrough] + [<System.Diagnostics.DebuggerStepThrough>] + + + + System.Threading.Tasks.Task + + + + + + + The to run. + The token to trigger shutdown. + Runs an application and returns a Task that only completes when the token is triggered or shutdown is triggered and all instances are stopped. + The that represents the asynchronous operation. + 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 . + The cancellation token was canceled. This exception is stored into the returned task. + + + + + + + + + + Method + + Microsoft.Extensions.Hosting.Abstractions + 2.1.0.0 + 2.2.0.0 + 3.0.0.0 + 3.1.0.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + System.Void + + + + + + The to start. + Starts the host synchronously. + To be added. + + + + + + + + + + Method + + Microsoft.Extensions.Hosting.Abstractions + 2.1.0.0 + 2.2.0.0 + 3.0.0.0 + 3.1.0.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + System.Threading.Tasks.Task + + + + + + + The to stop. The timeout for stopping gracefully. Once expired the - server may terminate any remaining active connections. - Attempts to gracefully stop the host with the given timeout. - The that represents the asynchronous operation. - To be added. - - - - - - - - - - Method - - Microsoft.Extensions.Hosting.Abstractions - 2.1.0.0 - 2.2.0.0 - 3.0.0.0 - 3.1.0.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - System.Void - - - - - - The running . - Blocks the calling thread until shutdown is triggered via Ctrl+C or SIGTERM. - To be added. - - - - - - - - - Method - - Microsoft.Extensions.Hosting.Abstractions - 2.1.0.0 - 2.2.0.0 - 3.0.0.0 - 3.1.0.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - - [System.Diagnostics.DebuggerStepThrough] - [<System.Diagnostics.DebuggerStepThrough>] - - - - System.Threading.Tasks.Task - - - - - - - The running . - The token to trigger shutdown. - Returns a Task that completes when shutdown is triggered via the given token. - The that represents the asynchronous operation. - 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 . - - - - + server may terminate any remaining active connections. + Attempts to gracefully stop the host with the given timeout. + The that represents the asynchronous operation. + To be added. + + + + + + + + + + Method + + Microsoft.Extensions.Hosting.Abstractions + 2.1.0.0 + 2.2.0.0 + 3.0.0.0 + 3.1.0.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + System.Void + + + + + + The running . + Blocks the calling thread until shutdown is triggered via Ctrl+C or SIGTERM. + To be added. + + + + + + + + + Method + + Microsoft.Extensions.Hosting.Abstractions + 2.1.0.0 + 2.2.0.0 + 3.0.0.0 + 3.1.0.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + + [System.Diagnostics.DebuggerStepThrough] + [<System.Diagnostics.DebuggerStepThrough>] + + + + System.Threading.Tasks.Task + + + + + + + The running . + The token to trigger shutdown. + Returns a Task that completes when shutdown is triggered via the given token. + The that represents the asynchronous operation. + 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 . + The cancellation token was canceled. This exception is stored into the returned task. + + + + diff --git a/xml/Microsoft.Extensions.Hosting/HostingHostBuilderExtensions.xml b/xml/Microsoft.Extensions.Hosting/HostingHostBuilderExtensions.xml index 03aee90c432..91d13e773e6 100644 --- a/xml/Microsoft.Extensions.Hosting/HostingHostBuilderExtensions.xml +++ b/xml/Microsoft.Extensions.Hosting/HostingHostBuilderExtensions.xml @@ -1,164 +1,164 @@ - - - - - - - - - Microsoft.Extensions.Hosting - 2.1.0.0 - 2.2.0.0 - 3.0.0.0 - 3.1.0.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - System.Object - - - - - [System.Runtime.CompilerServices.Nullable(0)] - [<System.Runtime.CompilerServices.Nullable(0)>] - - - [System.Runtime.CompilerServices.NullableContext(1)] - [<System.Runtime.CompilerServices.NullableContext(1)>] - - - - Provides extension methods for the from the hosting package. - To be added. - - - - - - - - - - Method - - Microsoft.Extensions.Hosting - 2.1.0.0 - 2.2.0.0 - 3.0.0.0 - 3.1.0.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - Microsoft.Extensions.Hosting.IHostBuilder - - - - - - - The to configure. + + + + + + + + + Microsoft.Extensions.Hosting + 2.1.0.0 + 2.2.0.0 + 3.0.0.0 + 3.1.0.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + System.Object + + + + + [System.Runtime.CompilerServices.Nullable(0)] + [<System.Runtime.CompilerServices.Nullable(0)>] + + + [System.Runtime.CompilerServices.NullableContext(1)] + [<System.Runtime.CompilerServices.NullableContext(1)>] + + + + Provides extension methods for the from the hosting package. + To be added. + + + + + + + + + + Method + + Microsoft.Extensions.Hosting + 2.1.0.0 + 2.2.0.0 + 3.0.0.0 + 3.1.0.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + Microsoft.Extensions.Hosting.IHostBuilder + + + + + + + The to configure. The delegate for configuring the that will be used - to construct the for the host. + to construct the for the host. Sets up the configuration for the remainder of the build process and application. This can be called multiple times and the results will be additive. The results will be available at for - subsequent operations, as well as in . - The same instance of the for chaining. - To be added. - - - - - - - - - - Method - - Microsoft.Extensions.Hosting - 2.1.0.0 - 2.2.0.0 - 3.0.0.0 - 3.1.0.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - Microsoft.Extensions.Hosting.IHostBuilder - - - - - - [System.Runtime.CompilerServices.Nullable(2)] - [<System.Runtime.CompilerServices.Nullable(2)>] - - - - - - - - - - The type of the builder. - The to configure. - The delegate for configuring the . + subsequent operations, as well as in . + The same instance of the for chaining. + To be added. + + + + + + + + + + Method + + Microsoft.Extensions.Hosting + 2.1.0.0 + 2.2.0.0 + 3.0.0.0 + 3.1.0.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + Microsoft.Extensions.Hosting.IHostBuilder + + + + + + [System.Runtime.CompilerServices.Nullable(2)] + [<System.Runtime.CompilerServices.Nullable(2)>] + + + + + + + + + + The type of the builder. + The to configure. + The delegate for configuring the . Enables configuring the instantiated dependency container. This can be called multiple times and - the results will be additive. - The same instance of the for chaining. - To be added. - - - - - - - - - - - Method - - Microsoft.Extensions.Hosting - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - - [System.Diagnostics.CodeAnalysis.RequiresDynamicCode("Hosting uses Microsoft.Extensions.DependencyInjection, which may require generating code dynamically at runtime.")] - [<System.Diagnostics.CodeAnalysis.RequiresDynamicCode("Hosting uses Microsoft.Extensions.DependencyInjection, which may require generating code dynamically at runtime.")>] - - - - Microsoft.Extensions.Hosting.IHostBuilder - - - - - - - [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 2, 1 })] - [<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 2, 1 })>] - - - - - - The existing builder to configure. - The command line args. - Configures an existing instance with pre-configured defaults. This will overwrite previously configured values and is intended to be called before additional configuration calls. - The same instance of the for chaining. - + the results will be additive. + The same instance of the for chaining. + To be added. + + + + + + + + + + + Method + + Microsoft.Extensions.Hosting + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + + [System.Diagnostics.CodeAnalysis.RequiresDynamicCode("Hosting uses Microsoft.Extensions.DependencyInjection, which may require generating code dynamically at runtime.")] + [<System.Diagnostics.CodeAnalysis.RequiresDynamicCode("Hosting uses Microsoft.Extensions.DependencyInjection, which may require generating code dynamically at runtime.")>] + + + + Microsoft.Extensions.Hosting.IHostBuilder + + + + + + + [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 2, 1 })] + [<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 2, 1 })>] + + + + + + The existing builder to configure. + The command line args. + Configures an existing instance with pre-configured defaults. This will overwrite previously configured values and is intended to be called before additional configuration calls. + The same instance of the for chaining. + to log to the console, debug, and event source output * enables scope validation on the dependency injection container when is 'Development' - ]]> - - - - - - - - - - - Method - - Microsoft.Extensions.Hosting - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - Microsoft.Extensions.Hosting.IHostBuilder - - - - - - - The to configure. - The delegate for configuring the . - Adds a delegate for configuring the of the . - The same instance of the for chaining. - To be added. - - - - - - - - - - Method - - Microsoft.Extensions.Hosting - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - Microsoft.Extensions.Hosting.IHostBuilder - - - - - - - The to configure. - The delegate for configuring the . - Adds a delegate for configuring the of the instance related to th. - The same instance of the for chaining. - To be added. - - - - - - - - - - Method - - Microsoft.Extensions.Hosting - 2.1.0.0 - 2.2.0.0 - 3.0.0.0 - 3.1.0.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - Microsoft.Extensions.Hosting.IHostBuilder - - - - - - - The to configure. - The delegate that configures the . - Adds a delegate for configuring the provided . This may be called multiple times. - The same instance of the for chaining. - To be added. - - - - - - - - - - Method - - Microsoft.Extensions.Hosting - 2.1.0.0 - 2.2.0.0 - 3.0.0.0 - 3.1.0.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - Microsoft.Extensions.Hosting.IHostBuilder - - - - - - - The to configure. - The delegate that configures the . - Adds a delegate for configuring the provided . This may be called multiple times. - The same instance of the for chaining. - To be added. - - - - - - - - - - Method - - Microsoft.Extensions.Hosting - 8.0.0.0 - - - Microsoft.Extensions.Hosting.IHostBuilder - - - - - - - The to configure. - The delegate that configures the . - Adds a delegate for configuring the provided . This may be called multiple times. - The same instance of the for chaining. - To be added. - - - - - - - - - - Method - - Microsoft.Extensions.Hosting - 8.0.0.0 - - - Microsoft.Extensions.Hosting.IHostBuilder - - - - - - - The to configure. - The delegate that configures the . - Adds a delegate for configuring the provided . This may be called multiple times. - The same instance of the for chaining. - To be added. - - - - - - - - - - Method - - Microsoft.Extensions.Hosting - 2.1.0.0 - 2.2.0.0 - 3.0.0.0 - 3.1.0.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - Microsoft.Extensions.Hosting.IHostBuilder - - - - - - - The to configure. - The delegate for configuring the . - Adds services to the container. This can be called multiple times and the results will be additive. - The same instance of the for chaining. - To be added. - - - - - - - - - Method - - Microsoft.Extensions.Hosting - 2.1.0.0 - 2.2.0.0 - 3.0.0.0 - 3.1.0.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - - [System.Runtime.Versioning.UnsupportedOSPlatform("android")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("android")>] - - - [System.Runtime.Versioning.UnsupportedOSPlatform("browser")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("browser")>] - - - [System.Runtime.Versioning.UnsupportedOSPlatform("ios")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("ios")>] - - - [System.Runtime.Versioning.UnsupportedOSPlatform("tvos")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("tvos")>] - - - - System.Threading.Tasks.Task - - - - - - - The to configure. - A that can be used to cancel the console. - Enables console support, builds and starts the host, and waits for Ctrl+C or SIGTERM to shut down. - A that only completes when the token is signaled or application is shutdown. - To be added. - - - - - - - - - Method - - Microsoft.Extensions.Hosting - 3.0.0.0 - 3.1.0.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - - [System.Runtime.Versioning.UnsupportedOSPlatform("android")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("android")>] - - - [System.Runtime.Versioning.UnsupportedOSPlatform("browser")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("browser")>] - - - [System.Runtime.Versioning.UnsupportedOSPlatform("ios")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("ios")>] - - - [System.Runtime.Versioning.UnsupportedOSPlatform("tvos")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("tvos")>] - - - - System.Threading.Tasks.Task - - - - - - - - The to configure. - The delegate for configuring the . - A that can be used to cancel the console. - Enables console support, builds and starts the host, and waits for Ctrl+C or SIGTERM to shut down. - A that only completes when the token is signaled or application is shutdown. - To be added. - - - - - - - - - - Method - - Microsoft.Extensions.Hosting - 2.1.0.0 - 2.2.0.0 - 3.0.0.0 - 3.1.0.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - - [System.Runtime.Versioning.UnsupportedOSPlatform("android")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("android")>] - - - [System.Runtime.Versioning.UnsupportedOSPlatform("browser")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("browser")>] - - - [System.Runtime.Versioning.UnsupportedOSPlatform("ios")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("ios")>] - - - [System.Runtime.Versioning.UnsupportedOSPlatform("tvos")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("tvos")>] - - - - Microsoft.Extensions.Hosting.IHostBuilder - - - - - - The to configure. + ]]> + + + + + + + + + + + Method + + Microsoft.Extensions.Hosting + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + Microsoft.Extensions.Hosting.IHostBuilder + + + + + + + The to configure. + The delegate for configuring the . + Adds a delegate for configuring the of the . + The same instance of the for chaining. + To be added. + + + + + + + + + + Method + + Microsoft.Extensions.Hosting + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + Microsoft.Extensions.Hosting.IHostBuilder + + + + + + + The to configure. + The delegate for configuring the . + Adds a delegate for configuring the of the instance related to th. + The same instance of the for chaining. + To be added. + + + + + + + + + + Method + + Microsoft.Extensions.Hosting + 2.1.0.0 + 2.2.0.0 + 3.0.0.0 + 3.1.0.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + Microsoft.Extensions.Hosting.IHostBuilder + + + + + + + The to configure. + The delegate that configures the . + Adds a delegate for configuring the provided . This may be called multiple times. + The same instance of the for chaining. + To be added. + + + + + + + + + + Method + + Microsoft.Extensions.Hosting + 2.1.0.0 + 2.2.0.0 + 3.0.0.0 + 3.1.0.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + Microsoft.Extensions.Hosting.IHostBuilder + + + + + + + The to configure. + The delegate that configures the . + Adds a delegate for configuring the provided . This may be called multiple times. + The same instance of the for chaining. + To be added. + + + + + + + + + + Method + + Microsoft.Extensions.Hosting + 8.0.0.0 + + + Microsoft.Extensions.Hosting.IHostBuilder + + + + + + + The to configure. + The delegate that configures the . + Adds a delegate for configuring the provided . This may be called multiple times. + The same instance of the for chaining. + To be added. + + + + + + + + + + Method + + Microsoft.Extensions.Hosting + 8.0.0.0 + + + Microsoft.Extensions.Hosting.IHostBuilder + + + + + + + The to configure. + The delegate that configures the . + Adds a delegate for configuring the provided . This may be called multiple times. + The same instance of the for chaining. + To be added. + + + + + + + + + + Method + + Microsoft.Extensions.Hosting + 2.1.0.0 + 2.2.0.0 + 3.0.0.0 + 3.1.0.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + Microsoft.Extensions.Hosting.IHostBuilder + + + + + + + The to configure. + The delegate for configuring the . + Adds services to the container. This can be called multiple times and the results will be additive. + The same instance of the for chaining. + To be added. + + + + + + + + + Method + + Microsoft.Extensions.Hosting + 2.1.0.0 + 2.2.0.0 + 3.0.0.0 + 3.1.0.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + + [System.Runtime.Versioning.UnsupportedOSPlatform("android")] + [<System.Runtime.Versioning.UnsupportedOSPlatform("android")>] + + + [System.Runtime.Versioning.UnsupportedOSPlatform("browser")] + [<System.Runtime.Versioning.UnsupportedOSPlatform("browser")>] + + + [System.Runtime.Versioning.UnsupportedOSPlatform("ios")] + [<System.Runtime.Versioning.UnsupportedOSPlatform("ios")>] + + + [System.Runtime.Versioning.UnsupportedOSPlatform("tvos")] + [<System.Runtime.Versioning.UnsupportedOSPlatform("tvos")>] + + + + System.Threading.Tasks.Task + + + + + + + The to configure. + A that can be used to cancel the console. + Enables console support, builds and starts the host, and waits for Ctrl+C or SIGTERM to shut down. + A that only completes when the token is signaled or application is shutdown. + To be added. + The cancellation token was canceled. This exception is stored into the returned task. + + + + + + + + + Method + + Microsoft.Extensions.Hosting + 3.0.0.0 + 3.1.0.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + + [System.Runtime.Versioning.UnsupportedOSPlatform("android")] + [<System.Runtime.Versioning.UnsupportedOSPlatform("android")>] + + + [System.Runtime.Versioning.UnsupportedOSPlatform("browser")] + [<System.Runtime.Versioning.UnsupportedOSPlatform("browser")>] + + + [System.Runtime.Versioning.UnsupportedOSPlatform("ios")] + [<System.Runtime.Versioning.UnsupportedOSPlatform("ios")>] + + + [System.Runtime.Versioning.UnsupportedOSPlatform("tvos")] + [<System.Runtime.Versioning.UnsupportedOSPlatform("tvos")>] + + + + System.Threading.Tasks.Task + + + + + + + + The to configure. + The delegate for configuring the . + A that can be used to cancel the console. + Enables console support, builds and starts the host, and waits for Ctrl+C or SIGTERM to shut down. + A that only completes when the token is signaled or application is shutdown. + To be added. + The cancellation token was canceled. This exception is stored into the returned task. + + + + + + + + + + Method + + Microsoft.Extensions.Hosting + 2.1.0.0 + 2.2.0.0 + 3.0.0.0 + 3.1.0.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + + [System.Runtime.Versioning.UnsupportedOSPlatform("android")] + [<System.Runtime.Versioning.UnsupportedOSPlatform("android")>] + + + [System.Runtime.Versioning.UnsupportedOSPlatform("browser")] + [<System.Runtime.Versioning.UnsupportedOSPlatform("browser")>] + + + [System.Runtime.Versioning.UnsupportedOSPlatform("ios")] + [<System.Runtime.Versioning.UnsupportedOSPlatform("ios")>] + + + [System.Runtime.Versioning.UnsupportedOSPlatform("tvos")] + [<System.Runtime.Versioning.UnsupportedOSPlatform("tvos")>] + + + + Microsoft.Extensions.Hosting.IHostBuilder + + + + + + The to configure. Listens for Ctrl+C or SIGTERM and calls to start the shutdown process. - This will unblock extensions like RunAsync and WaitForShutdownAsync. - The same instance of the for chaining. - To be added. - - - - - - - - - - Method - - Microsoft.Extensions.Hosting - 3.0.0.0 - 3.1.0.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - - [System.Runtime.Versioning.UnsupportedOSPlatform("android")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("android")>] - - - [System.Runtime.Versioning.UnsupportedOSPlatform("browser")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("browser")>] - - - [System.Runtime.Versioning.UnsupportedOSPlatform("ios")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("ios")>] - - - [System.Runtime.Versioning.UnsupportedOSPlatform("tvos")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("tvos")>] - - - - Microsoft.Extensions.Hosting.IHostBuilder - - - - - - - The to configure. - The delegate for configuring the . + This will unblock extensions like RunAsync and WaitForShutdownAsync. + The same instance of the for chaining. + To be added. + + + + + + + + + + Method + + Microsoft.Extensions.Hosting + 3.0.0.0 + 3.1.0.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + + [System.Runtime.Versioning.UnsupportedOSPlatform("android")] + [<System.Runtime.Versioning.UnsupportedOSPlatform("android")>] + + + [System.Runtime.Versioning.UnsupportedOSPlatform("browser")] + [<System.Runtime.Versioning.UnsupportedOSPlatform("browser")>] + + + [System.Runtime.Versioning.UnsupportedOSPlatform("ios")] + [<System.Runtime.Versioning.UnsupportedOSPlatform("ios")>] + + + [System.Runtime.Versioning.UnsupportedOSPlatform("tvos")] + [<System.Runtime.Versioning.UnsupportedOSPlatform("tvos")>] + + + + Microsoft.Extensions.Hosting.IHostBuilder + + + + + + + The to configure. + The delegate for configuring the . Listens for Ctrl+C or SIGTERM and calls to start the shutdown process. - This will unblock extensions like RunAsync and WaitForShutdownAsync. - The same instance of the for chaining. - To be added. - - - - - - - - - - Method - - Microsoft.Extensions.Hosting - 2.1.0.0 - 2.2.0.0 - 3.0.0.0 - 3.1.0.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - Microsoft.Extensions.Hosting.IHostBuilder - - - - - - - The to configure. - Path to root directory of the application. - Specifies the content root directory to be used by the host. - The . - To be added. - - - - - - - - - - Method - - Microsoft.Extensions.Hosting - 3.0.0.0 - 3.1.0.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - - [System.Diagnostics.CodeAnalysis.RequiresDynamicCode("Hosting uses Microsoft.Extensions.DependencyInjection, which may require generating code dynamically at runtime.")] - [<System.Diagnostics.CodeAnalysis.RequiresDynamicCode("Hosting uses Microsoft.Extensions.DependencyInjection, which may require generating code dynamically at runtime.")>] - - - - Microsoft.Extensions.Hosting.IHostBuilder - - - - - - - The to configure. - The delegate that configures the . - Specifies the to be the default one. - The . - To be added. - - - - - - - - - - Method - - Microsoft.Extensions.Hosting - 3.0.0.0 - 3.1.0.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - - [System.Diagnostics.CodeAnalysis.RequiresDynamicCode("Hosting uses Microsoft.Extensions.DependencyInjection, which may require generating code dynamically at runtime.")] - [<System.Diagnostics.CodeAnalysis.RequiresDynamicCode("Hosting uses Microsoft.Extensions.DependencyInjection, which may require generating code dynamically at runtime.")>] - - - - Microsoft.Extensions.Hosting.IHostBuilder - - - - - - - The to configure. - The delegate that configures the . - Specifies the to be the default one. - The . - To be added. - - - - - - - - - - Method - - Microsoft.Extensions.Hosting - 2.1.0.0 - 2.2.0.0 - 3.0.0.0 - 3.1.0.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - Microsoft.Extensions.Hosting.IHostBuilder - - - - - - - The to configure. - The environment to host the application in. - Specifies the environment to be used by the host. - The . - To be added. - - - - + This will unblock extensions like RunAsync and WaitForShutdownAsync. + The same instance of the for chaining. + To be added. + + + + + + + + + + Method + + Microsoft.Extensions.Hosting + 2.1.0.0 + 2.2.0.0 + 3.0.0.0 + 3.1.0.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + Microsoft.Extensions.Hosting.IHostBuilder + + + + + + + The to configure. + Path to root directory of the application. + Specifies the content root directory to be used by the host. + The . + To be added. + + + + + + + + + + Method + + Microsoft.Extensions.Hosting + 3.0.0.0 + 3.1.0.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + + [System.Diagnostics.CodeAnalysis.RequiresDynamicCode("Hosting uses Microsoft.Extensions.DependencyInjection, which may require generating code dynamically at runtime.")] + [<System.Diagnostics.CodeAnalysis.RequiresDynamicCode("Hosting uses Microsoft.Extensions.DependencyInjection, which may require generating code dynamically at runtime.")>] + + + + Microsoft.Extensions.Hosting.IHostBuilder + + + + + + + The to configure. + The delegate that configures the . + Specifies the to be the default one. + The . + To be added. + + + + + + + + + + Method + + Microsoft.Extensions.Hosting + 3.0.0.0 + 3.1.0.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + + [System.Diagnostics.CodeAnalysis.RequiresDynamicCode("Hosting uses Microsoft.Extensions.DependencyInjection, which may require generating code dynamically at runtime.")] + [<System.Diagnostics.CodeAnalysis.RequiresDynamicCode("Hosting uses Microsoft.Extensions.DependencyInjection, which may require generating code dynamically at runtime.")>] + + + + Microsoft.Extensions.Hosting.IHostBuilder + + + + + + + The to configure. + The delegate that configures the . + Specifies the to be the default one. + The . + To be added. + + + + + + + + + + Method + + Microsoft.Extensions.Hosting + 2.1.0.0 + 2.2.0.0 + 3.0.0.0 + 3.1.0.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + Microsoft.Extensions.Hosting.IHostBuilder + + + + + + + The to configure. + The environment to host the application in. + Specifies the environment to be used by the host. + The . + To be added. + + + + diff --git a/xml/Microsoft.Extensions.Hosting/IHost.xml b/xml/Microsoft.Extensions.Hosting/IHost.xml index 747768580f6..b084cde3839 100644 --- a/xml/Microsoft.Extensions.Hosting/IHost.xml +++ b/xml/Microsoft.Extensions.Hosting/IHost.xml @@ -89,6 +89,7 @@ Starts the program. A that will be completed when the starts. To be added. + The cancellation token was canceled. This exception is stored into the returned task. @@ -120,6 +121,7 @@ Attempts to gracefully stop the program. A that will be completed when the stops. To be added. + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/Microsoft.Extensions.Hosting/IHostLifetime.xml b/xml/Microsoft.Extensions.Hosting/IHostLifetime.xml index cddf2aac3a9..af27213e61e 100644 --- a/xml/Microsoft.Extensions.Hosting/IHostLifetime.xml +++ b/xml/Microsoft.Extensions.Hosting/IHostLifetime.xml @@ -1,97 +1,99 @@ - - - - - - - - - Microsoft.Extensions.Hosting.Abstractions - 2.1.0.0 - 2.2.0.0 - 3.0.0.0 - 3.1.0.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - - - [System.Runtime.CompilerServices.NullableContext(1)] - [<System.Runtime.CompilerServices.NullableContext(1)>] - - - - Tracks host lifetime. - To be added. - - - - - - - - - - Method - - Microsoft.Extensions.Hosting.Abstractions - 2.1.0.0 - 2.2.0.0 - 3.0.0.0 - 3.1.0.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - System.Threading.Tasks.Task - - - - - - Used to indicate when stop should no longer be graceful. - Called from to indicate that the host is stopping and it's time to shut down. - A . - To be added. - - - - - - - - - - Method - - Microsoft.Extensions.Hosting.Abstractions - 2.1.0.0 - 2.2.0.0 - 3.0.0.0 - 3.1.0.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - System.Threading.Tasks.Task - - - - - - Used to indicate when stop should no longer be graceful. + + + + + + + + + Microsoft.Extensions.Hosting.Abstractions + 2.1.0.0 + 2.2.0.0 + 3.0.0.0 + 3.1.0.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + + + [System.Runtime.CompilerServices.NullableContext(1)] + [<System.Runtime.CompilerServices.NullableContext(1)>] + + + + Tracks host lifetime. + To be added. + + + + + + + + + + Method + + Microsoft.Extensions.Hosting.Abstractions + 2.1.0.0 + 2.2.0.0 + 3.0.0.0 + 3.1.0.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + System.Threading.Tasks.Task + + + + + + Used to indicate when stop should no longer be graceful. + Called from to indicate that the host is stopping and it's time to shut down. + A . + To be added. + The cancellation token was canceled. This exception is stored into the returned task. + + + + + + + + + + Method + + Microsoft.Extensions.Hosting.Abstractions + 2.1.0.0 + 2.2.0.0 + 3.0.0.0 + 3.1.0.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + System.Threading.Tasks.Task + + + + + + Used to indicate when stop should no longer be graceful. Called at the start of which will wait until it's complete before - continuing. This can be used to delay startup until signaled by an external event. - A . - To be added. - - - - + continuing. This can be used to delay startup until signaled by an external event. + A . + To be added. + The cancellation token was canceled. This exception is stored into the returned task. + + + + diff --git a/xml/Microsoft.Extensions.Hosting/IHostedLifecycleService.xml b/xml/Microsoft.Extensions.Hosting/IHostedLifecycleService.xml index c628c5d17db..4c22c524bde 100644 --- a/xml/Microsoft.Extensions.Hosting/IHostedLifecycleService.xml +++ b/xml/Microsoft.Extensions.Hosting/IHostedLifecycleService.xml @@ -48,6 +48,7 @@ Triggered after . A that represents the asynchronous operation. To be added. + The cancellation token was canceled. This exception is stored into the returned task. @@ -73,6 +74,7 @@ Triggered before . A that represents the asynchronous operation. To be added. + The cancellation token was canceled. This exception is stored into the returned task. @@ -98,6 +100,7 @@ Triggered after . A that represents the asynchronous operation. To be added. + The cancellation token was canceled. This exception is stored into the returned task. @@ -123,6 +126,7 @@ Triggered before . A that represents the asynchronous operation. To be added. + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/Microsoft.Extensions.Hosting/IHostedService.xml b/xml/Microsoft.Extensions.Hosting/IHostedService.xml index 3ab7a8230a8..02b1b5bcbe4 100644 --- a/xml/Microsoft.Extensions.Hosting/IHostedService.xml +++ b/xml/Microsoft.Extensions.Hosting/IHostedService.xml @@ -60,6 +60,7 @@ Triggered when the application host is ready to start the service. A that represents the asynchronous Start operation. To be added. + The cancellation token was canceled. This exception is stored into the returned task. @@ -93,6 +94,7 @@ Triggered when the application host is performing a graceful shutdown. A that represents the asynchronous Stop operation. To be added. + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/Microsoft.Extensions.Http.AutoClient/AutoClientHttpError.xml b/xml/Microsoft.Extensions.Http.AutoClient/AutoClientHttpError.xml index ea30c78338f..64044b44890 100644 --- a/xml/Microsoft.Extensions.Http.AutoClient/AutoClientHttpError.xml +++ b/xml/Microsoft.Extensions.Http.AutoClient/AutoClientHttpError.xml @@ -96,6 +96,7 @@ An instance of . To be added. + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/Microsoft.Extensions.Http.Logging/IHttpClientAsyncLogger.xml b/xml/Microsoft.Extensions.Http.Logging/IHttpClientAsyncLogger.xml index 27200cb77d2..1a8cf48039a 100644 --- a/xml/Microsoft.Extensions.Http.Logging/IHttpClientAsyncLogger.xml +++ b/xml/Microsoft.Extensions.Http.Logging/IHttpClientAsyncLogger.xml @@ -1,156 +1,159 @@ - - - - - - - - - Microsoft.Extensions.Http - 8.0.0.0 - - - - Microsoft.Extensions.Http.Logging.IHttpClientLogger - - - - - [System.Runtime.CompilerServices.NullableContext(1)] - [<System.Runtime.CompilerServices.NullableContext(1)>] - - - - An abstraction for asynchronous custom HTTP request logging for named instances returned by . - + + + + + + + + + Microsoft.Extensions.Http + 8.0.0.0 + + + + Microsoft.Extensions.Http.Logging.IHttpClientLogger + + + + + [System.Runtime.CompilerServices.NullableContext(1)] + [<System.Runtime.CompilerServices.NullableContext(1)>] + + + + An abstraction for asynchronous custom HTTP request logging for named instances returned by . + Asynchronous methods (such as ) are called from async code paths (such as ). Their synchronous counterparts inherited from (such as ) are called from the corresponding sync code paths. - + It is up to the user implementing the interface to decide where (to , or anything else) and what exactly to log. However, the implementation should be mindful about potential adverse side effects of accessing some of the or properties, such as reading from a content stream. If possible, such behavior should be avoided. - + The logging implementation shouldn't throw any exceptions, as an unhandled exception in logging would fail the request. - - - - - - - - - - - Method - - Microsoft.Extensions.Http - 8.0.0.0 - - - System.Threading.Tasks.ValueTask - - - - - - [System.Runtime.CompilerServices.Nullable(2)] - [<System.Runtime.CompilerServices.Nullable(2)>] - - - - - - - - [System.Runtime.CompilerServices.Nullable(2)] - [<System.Runtime.CompilerServices.Nullable(2)>] - - - - - - - - - The context object that was previously returned by . - The HTTP request message that was sent. - If available, the HTTP response message that was received, and otherwise. - Exception that happened during processing the HTTP request. - Time elapsed since calling . - The cancellation token to cancel operation. - Logs the exception that occurred while sending an HTTP request. - The task object representing the asynchronous operation. - To be added. - - - - - - - - - Method - - Microsoft.Extensions.Http - 8.0.0.0 - - - System.Threading.Tasks.ValueTask<System.Object> - - - [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 2 })] - [<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 2 })>] - - - - - - - - - The HTTP request message that will be sent. - The cancellation token to cancel operation. - Logs before sending an HTTP request. - The task object representing the asynchronous operation. The result of the operation is a context object that will be passed to a corresponding or . Can be if no context object is needed by the implementation. - To be added. - - - - - - - - - Method - - Microsoft.Extensions.Http - 8.0.0.0 - - - System.Threading.Tasks.ValueTask - - - - - - [System.Runtime.CompilerServices.Nullable(2)] - [<System.Runtime.CompilerServices.Nullable(2)>] - - - - - - - - - - The context object that was previously returned by . - The HTTP request message that was sent. - The HTTP response message that was received. - Time elapsed since calling . - The cancellation token to cancel operation. - Logs after receiving an HTTP response. - The task object representing the asynchronous operation. - To be added. - - - - + + + + + + + + + + + Method + + Microsoft.Extensions.Http + 8.0.0.0 + + + System.Threading.Tasks.ValueTask + + + + + + [System.Runtime.CompilerServices.Nullable(2)] + [<System.Runtime.CompilerServices.Nullable(2)>] + + + + + + + + [System.Runtime.CompilerServices.Nullable(2)] + [<System.Runtime.CompilerServices.Nullable(2)>] + + + + + + + + + The context object that was previously returned by . + The HTTP request message that was sent. + If available, the HTTP response message that was received, and otherwise. + Exception that happened during processing the HTTP request. + Time elapsed since calling . + The cancellation token to cancel operation. + Logs the exception that occurred while sending an HTTP request. + The task object representing the asynchronous operation. + To be added. + The cancellation token was canceled. This exception is stored into the returned task. + + + + + + + + + Method + + Microsoft.Extensions.Http + 8.0.0.0 + + + System.Threading.Tasks.ValueTask<System.Object> + + + [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 2 })] + [<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 2 })>] + + + + + + + + + The HTTP request message that will be sent. + The cancellation token to cancel operation. + Logs before sending an HTTP request. + The task object representing the asynchronous operation. The result of the operation is a context object that will be passed to a corresponding or . Can be if no context object is needed by the implementation. + To be added. + The cancellation token was canceled. This exception is stored into the returned task. + + + + + + + + + Method + + Microsoft.Extensions.Http + 8.0.0.0 + + + System.Threading.Tasks.ValueTask + + + + + + [System.Runtime.CompilerServices.Nullable(2)] + [<System.Runtime.CompilerServices.Nullable(2)>] + + + + + + + + + + The context object that was previously returned by . + The HTTP request message that was sent. + The HTTP response message that was received. + Time elapsed since calling . + The cancellation token to cancel operation. + Logs after receiving an HTTP response. + The task object representing the asynchronous operation. + To be added. + The cancellation token was canceled. This exception is stored into the returned task. + + + + diff --git a/xml/Microsoft.Extensions.Http.Logging/LoggingHttpMessageHandler.xml b/xml/Microsoft.Extensions.Http.Logging/LoggingHttpMessageHandler.xml index b3304caaf72..ad0201bf381 100644 --- a/xml/Microsoft.Extensions.Http.Logging/LoggingHttpMessageHandler.xml +++ b/xml/Microsoft.Extensions.Http.Logging/LoggingHttpMessageHandler.xml @@ -1,174 +1,176 @@ - - - - - - - - - Microsoft.Extensions.Http - 2.1.0.0 - 2.2.0.0 - 3.0.0.0 - 3.1.0.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - System.Net.Http.DelegatingHandler - - - - - [System.Runtime.CompilerServices.Nullable(0)] - [<System.Runtime.CompilerServices.Nullable(0)>] - - - [System.Runtime.CompilerServices.NullableContext(1)] - [<System.Runtime.CompilerServices.NullableContext(1)>] - - - - Handles logging of the lifecycle for an HTTP request. - To be added. - - - - - - - - - - Constructor - - Microsoft.Extensions.Http - 2.1.0.0 - 2.2.0.0 - 3.0.0.0 - 3.1.0.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - - - - The to log to. - Initializes a new instance of the class with a specified logger. - To be added. - - is . - - - - - - - - - - Constructor - - Microsoft.Extensions.Http - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - - - - - The to log to. - The used to configure the instance. - Initializes a new instance of the class with a specified logger and options. - To be added. - - or is . - - - - - - - - - - Method - - Microsoft.Extensions.Http - 8.0.0.0 - - - System.Net.Http.HttpResponseMessage - - - - - - - To be added. - To be added. - To be added. - To be added. - Logs the request to and response from the sent . - - - - - - - - - - - Method - - Microsoft.Extensions.Http - 2.1.0.0 - 2.2.0.0 - 3.0.0.0 - 3.1.0.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - - [System.Diagnostics.DebuggerStepThrough] - [<System.Diagnostics.DebuggerStepThrough>] - - - - System.Threading.Tasks.Task<System.Net.Http.HttpResponseMessage> - - - - - - - To be added. - To be added. - To be added. - To be added. - + + + + + + + + + Microsoft.Extensions.Http + 2.1.0.0 + 2.2.0.0 + 3.0.0.0 + 3.1.0.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + System.Net.Http.DelegatingHandler + + + + + [System.Runtime.CompilerServices.Nullable(0)] + [<System.Runtime.CompilerServices.Nullable(0)>] + + + [System.Runtime.CompilerServices.NullableContext(1)] + [<System.Runtime.CompilerServices.NullableContext(1)>] + + + + Handles logging of the lifecycle for an HTTP request. + To be added. + + + + + + + + + + Constructor + + Microsoft.Extensions.Http + 2.1.0.0 + 2.2.0.0 + 3.0.0.0 + 3.1.0.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + + + + The to log to. + Initializes a new instance of the class with a specified logger. + To be added. + + is . + + + + + + + + + + Constructor + + Microsoft.Extensions.Http + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + + + + + The to log to. + The used to configure the instance. + Initializes a new instance of the class with a specified logger and options. + To be added. + + or is . + + + + + + + + + + Method + + Microsoft.Extensions.Http + 8.0.0.0 + + + System.Net.Http.HttpResponseMessage + + + + + + + To be added. + To be added. + To be added. + To be added. + Logs the request to and response from the sent . + + The cancellation token was canceled. This exception is stored into the returned task. + + + + + + + + + + Method + + Microsoft.Extensions.Http + 2.1.0.0 + 2.2.0.0 + 3.0.0.0 + 3.1.0.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + + [System.Diagnostics.DebuggerStepThrough] + [<System.Diagnostics.DebuggerStepThrough>] + + + + System.Threading.Tasks.Task<System.Net.Http.HttpResponseMessage> + + + + + + + To be added. + To be added. + To be added. + To be added. + . - ]]> - - - - - - + ]]> + + + The cancellation token was canceled. This exception is stored into the returned task. + + + + diff --git a/xml/Microsoft.Extensions.Http.Logging/LoggingScopeHttpMessageHandler.xml b/xml/Microsoft.Extensions.Http.Logging/LoggingScopeHttpMessageHandler.xml index f2ab5291a3e..8e6316e2fbb 100644 --- a/xml/Microsoft.Extensions.Http.Logging/LoggingScopeHttpMessageHandler.xml +++ b/xml/Microsoft.Extensions.Http.Logging/LoggingScopeHttpMessageHandler.xml @@ -1,174 +1,176 @@ - - - - - - - - - Microsoft.Extensions.Http - 2.1.0.0 - 2.2.0.0 - 3.0.0.0 - 3.1.0.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - System.Net.Http.DelegatingHandler - - - - - [System.Runtime.CompilerServices.Nullable(0)] - [<System.Runtime.CompilerServices.Nullable(0)>] - - - [System.Runtime.CompilerServices.NullableContext(1)] - [<System.Runtime.CompilerServices.NullableContext(1)>] - - - - Handles logging of the lifecycle for an HTTP request within a log scope. - To be added. - - - - - - - - - - Constructor - - Microsoft.Extensions.Http - 2.1.0.0 - 2.2.0.0 - 3.0.0.0 - 3.1.0.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - - - - The to log to. - Initializes a new instance of the class with a specified logger. - To be added. - - is . - - - - - - - - - - Constructor - - Microsoft.Extensions.Http - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - - - - - The to log to. - The used to configure the instance. - Initializes a new instance of the class with a specified logger and options. - To be added. - - or is . - - - - - - - - - - Method - - Microsoft.Extensions.Http - 8.0.0.0 - - - System.Net.Http.HttpResponseMessage - - - - - - - To be added. - To be added. - To be added. - To be added. - Logs the request to and response from the sent . - - - - - - - - - - - Method - - Microsoft.Extensions.Http - 2.1.0.0 - 2.2.0.0 - 3.0.0.0 - 3.1.0.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - - [System.Diagnostics.DebuggerStepThrough] - [<System.Diagnostics.DebuggerStepThrough>] - - - - System.Threading.Tasks.Task<System.Net.Http.HttpResponseMessage> - - - - - - - To be added. - To be added. - To be added. - To be added. - + + + + + + + + + Microsoft.Extensions.Http + 2.1.0.0 + 2.2.0.0 + 3.0.0.0 + 3.1.0.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + System.Net.Http.DelegatingHandler + + + + + [System.Runtime.CompilerServices.Nullable(0)] + [<System.Runtime.CompilerServices.Nullable(0)>] + + + [System.Runtime.CompilerServices.NullableContext(1)] + [<System.Runtime.CompilerServices.NullableContext(1)>] + + + + Handles logging of the lifecycle for an HTTP request within a log scope. + To be added. + + + + + + + + + + Constructor + + Microsoft.Extensions.Http + 2.1.0.0 + 2.2.0.0 + 3.0.0.0 + 3.1.0.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + + + + The to log to. + Initializes a new instance of the class with a specified logger. + To be added. + + is . + + + + + + + + + + Constructor + + Microsoft.Extensions.Http + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + + + + + The to log to. + The used to configure the instance. + Initializes a new instance of the class with a specified logger and options. + To be added. + + or is . + + + + + + + + + + Method + + Microsoft.Extensions.Http + 8.0.0.0 + + + System.Net.Http.HttpResponseMessage + + + + + + + To be added. + To be added. + To be added. + To be added. + Logs the request to and response from the sent . + + The cancellation token was canceled. This exception is stored into the returned task. + + + + + + + + + + Method + + Microsoft.Extensions.Http + 2.1.0.0 + 2.2.0.0 + 3.0.0.0 + 3.1.0.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + + [System.Diagnostics.DebuggerStepThrough] + [<System.Diagnostics.DebuggerStepThrough>] + + + + System.Threading.Tasks.Task<System.Net.Http.HttpResponseMessage> + + + + + + + To be added. + To be added. + To be added. + To be added. + . - ]]> - - - - - - + ]]> + + + The cancellation token was canceled. This exception is stored into the returned task. + + + + diff --git a/xml/Microsoft.Extensions.Http.Telemetry.Metering/HttpMeteringHandler.xml b/xml/Microsoft.Extensions.Http.Telemetry.Metering/HttpMeteringHandler.xml index 1c7e26402b4..6a6a4094352 100644 --- a/xml/Microsoft.Extensions.Http.Telemetry.Metering/HttpMeteringHandler.xml +++ b/xml/Microsoft.Extensions.Http.Telemetry.Metering/HttpMeteringHandler.xml @@ -91,6 +91,7 @@ The task object representing the asynchronous operation. To be added. + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/Microsoft.Extensions.Http/PolicyHttpMessageHandler.xml b/xml/Microsoft.Extensions.Http/PolicyHttpMessageHandler.xml index 36a02583875..6156d15cbcd 100644 --- a/xml/Microsoft.Extensions.Http/PolicyHttpMessageHandler.xml +++ b/xml/Microsoft.Extensions.Http/PolicyHttpMessageHandler.xml @@ -130,6 +130,7 @@ Executes request processing surrounded by a . ]]> + The cancellation token was canceled. This exception is stored into the returned task. @@ -161,6 +162,7 @@ Executes request processing surrounded by a . Called inside the execution of the to perform request processing. Returns a that will yield a response when completed. To be added. + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/Microsoft.Extensions.Logging.AzureAppServices.Internal/BatchingLoggerProvider.xml b/xml/Microsoft.Extensions.Logging.AzureAppServices.Internal/BatchingLoggerProvider.xml index c59425a5b9b..0f21aaa0ec6 100644 --- a/xml/Microsoft.Extensions.Logging.AzureAppServices.Internal/BatchingLoggerProvider.xml +++ b/xml/Microsoft.Extensions.Logging.AzureAppServices.Internal/BatchingLoggerProvider.xml @@ -133,6 +133,7 @@ To be added. To be added. To be added. + The cancellation token was canceled. This exception is stored into the returned task. @@ -185,6 +186,7 @@ To be added. To be added. To be added. + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/Microsoft.Extensions.Logging.AzureAppServices.Internal/BlobAppendReferenceWrapper.xml b/xml/Microsoft.Extensions.Logging.AzureAppServices.Internal/BlobAppendReferenceWrapper.xml index 7503b63a9df..1d67fd1b1ea 100644 --- a/xml/Microsoft.Extensions.Logging.AzureAppServices.Internal/BlobAppendReferenceWrapper.xml +++ b/xml/Microsoft.Extensions.Logging.AzureAppServices.Internal/BlobAppendReferenceWrapper.xml @@ -113,6 +113,7 @@ This API supports the .NET infrastructure and is not intended to be used directl ]]> + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/Microsoft.Extensions.Logging.AzureAppServices.Internal/BlobLoggerProvider.xml b/xml/Microsoft.Extensions.Logging.AzureAppServices.Internal/BlobLoggerProvider.xml index 46aa3276037..e909f07f6ff 100644 --- a/xml/Microsoft.Extensions.Logging.AzureAppServices.Internal/BlobLoggerProvider.xml +++ b/xml/Microsoft.Extensions.Logging.AzureAppServices.Internal/BlobLoggerProvider.xml @@ -44,8 +44,7 @@ - - + Creates a new instance of . To be added. @@ -69,8 +68,7 @@ - - + The container to store logs to. Creates a new instance of . To be added. @@ -103,6 +101,7 @@ To be added. To be added. To be added. + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/Microsoft.Extensions.Logging.AzureAppServices.Internal/FileLoggerProvider.xml b/xml/Microsoft.Extensions.Logging.AzureAppServices.Internal/FileLoggerProvider.xml index 3b249d72d80..a731aa82e03 100644 --- a/xml/Microsoft.Extensions.Logging.AzureAppServices.Internal/FileLoggerProvider.xml +++ b/xml/Microsoft.Extensions.Logging.AzureAppServices.Internal/FileLoggerProvider.xml @@ -209,6 +209,7 @@ This API supports the .NET infrastructure and is not intended to be used directl This API supports the .NET infrastructure and is not intended to be used directly from your code. To be added. To be added. + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/Microsoft.Extensions.Logging.AzureAppServices.Internal/ICloudAppendBlob.xml b/xml/Microsoft.Extensions.Logging.AzureAppServices.Internal/ICloudAppendBlob.xml index ee3c9e476bc..8dc37522da7 100644 --- a/xml/Microsoft.Extensions.Logging.AzureAppServices.Internal/ICloudAppendBlob.xml +++ b/xml/Microsoft.Extensions.Logging.AzureAppServices.Internal/ICloudAppendBlob.xml @@ -61,6 +61,7 @@ This API supports the .NET infrastructure and is not intended to be used directl ]]> + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/Microsoft.Extensions.Logging.AzureAppServices/BatchingLoggerProvider.xml b/xml/Microsoft.Extensions.Logging.AzureAppServices/BatchingLoggerProvider.xml index e01dd65d789..06c39ab4f1d 100644 --- a/xml/Microsoft.Extensions.Logging.AzureAppServices/BatchingLoggerProvider.xml +++ b/xml/Microsoft.Extensions.Logging.AzureAppServices/BatchingLoggerProvider.xml @@ -109,6 +109,7 @@ Wait for the given . A which completes when the has passed or the has been canceled. To be added. + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/Microsoft.Extensions.Options.Contextual/IContextualOptionsFactory`1.xml b/xml/Microsoft.Extensions.Options.Contextual/IContextualOptionsFactory`1.xml index ce848974681..f44d483f9ab 100644 --- a/xml/Microsoft.Extensions.Options.Contextual/IContextualOptionsFactory`1.xml +++ b/xml/Microsoft.Extensions.Options.Contextual/IContextualOptionsFactory`1.xml @@ -87,6 +87,7 @@ A configured instance of . To be added. + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/Microsoft.Extensions.Options.Contextual/IContextualOptions`1.xml b/xml/Microsoft.Extensions.Options.Contextual/IContextualOptions`1.xml index 0dbfaac113d..82fdde5954b 100644 --- a/xml/Microsoft.Extensions.Options.Contextual/IContextualOptions`1.xml +++ b/xml/Microsoft.Extensions.Options.Contextual/IContextualOptions`1.xml @@ -85,6 +85,7 @@ A configured instance of . To be added. + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/Microsoft.Extensions.Options.Contextual/ILoadContextualOptions`1.xml b/xml/Microsoft.Extensions.Options.Contextual/ILoadContextualOptions`1.xml index f951d444f22..91ed3d81cee 100644 --- a/xml/Microsoft.Extensions.Options.Contextual/ILoadContextualOptions`1.xml +++ b/xml/Microsoft.Extensions.Options.Contextual/ILoadContextualOptions`1.xml @@ -87,6 +87,7 @@ An object to configure an instance of . To be added. + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/Microsoft.Extensions.Options.Contextual/INamedContextualOptions`1.xml b/xml/Microsoft.Extensions.Options.Contextual/INamedContextualOptions`1.xml index 5022a8ee694..a2e5a0051cc 100644 --- a/xml/Microsoft.Extensions.Options.Contextual/INamedContextualOptions`1.xml +++ b/xml/Microsoft.Extensions.Options.Contextual/INamedContextualOptions`1.xml @@ -91,6 +91,7 @@ A configured instance of . To be added. + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/Microsoft.Extensions.Telemetry.Latency/ILatencyDataExporter.xml b/xml/Microsoft.Extensions.Telemetry.Latency/ILatencyDataExporter.xml index 45a006279a8..1314eaeb0c3 100644 --- a/xml/Microsoft.Extensions.Telemetry.Latency/ILatencyDataExporter.xml +++ b/xml/Microsoft.Extensions.Telemetry.Latency/ILatencyDataExporter.xml @@ -50,6 +50,7 @@ A that represents the export operation. To be added. + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/Microsoft.Extensions.Telemetry.Testing.Metering/MetricCollector`1.xml b/xml/Microsoft.Extensions.Telemetry.Testing.Metering/MetricCollector`1.xml index c3635d70a97..3abd9e315c0 100644 --- a/xml/Microsoft.Extensions.Telemetry.Testing.Metering/MetricCollector`1.xml +++ b/xml/Microsoft.Extensions.Telemetry.Testing.Metering/MetricCollector`1.xml @@ -408,6 +408,7 @@ A task that completes when the collector has collected the requisite number of measurements. To be added. + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.Cloud.DocumentDb/IDocumentDatabase.xml b/xml/System.Cloud.DocumentDb/IDocumentDatabase.xml index cda8c86762d..9157a92907d 100644 --- a/xml/System.Cloud.DocumentDb/IDocumentDatabase.xml +++ b/xml/System.Cloud.DocumentDb/IDocumentDatabase.xml @@ -54,6 +54,7 @@ A representing the result of the asynchronous operation. To be added. + The cancellation token was canceled. This exception is stored into the returned task. @@ -92,6 +93,7 @@ The request failed but can be retried. This includes throttling and when the server is unavailable. A general failure occurred. + The cancellation token was canceled. This exception is stored into the returned task. @@ -129,6 +131,7 @@ The request failed but can be retried. This includes throttling and when the server is unavailable. A general failure occurred. + The cancellation token was canceled. This exception is stored into the returned task. @@ -170,6 +173,7 @@ The request failed but can be retried. This includes throttling and when the server is unavailable. A general failure occurred. + The cancellation token was canceled. This exception is stored into the returned task. @@ -280,6 +284,7 @@ The request failed but can be retried. This includes throttling and when the server is unavailable. A general failure occurred. + The cancellation token was canceled. This exception is stored into the returned task. @@ -323,6 +328,7 @@ This includes throttling and when the server is unavailable. A general failure occurred. + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.Cloud.DocumentDb/IDocumentReader`1.xml b/xml/System.Cloud.DocumentDb/IDocumentReader`1.xml index 938dafeb872..ab0ed5f443a 100644 --- a/xml/System.Cloud.DocumentDb/IDocumentReader`1.xml +++ b/xml/System.Cloud.DocumentDb/IDocumentReader`1.xml @@ -74,6 +74,7 @@ Thrown when a request failed but can be retried. This includes throttling and server not available cases. A generic exception thrown in all other not covered above cases. + The cancellation token was canceled. This exception is stored into the returned task. @@ -123,6 +124,7 @@ Thrown when a request failed but can be retried. This includes throttling and server not available cases. A generic exception thrown in all other not covered above cases. + The cancellation token was canceled. This exception is stored into the returned task. @@ -161,6 +163,7 @@ Thrown when a request failed but can be retried. This includes throttling and server not available cases. A generic exception thrown in all other not covered above cases. + The cancellation token was canceled. This exception is stored into the returned task. @@ -199,6 +202,7 @@ Thrown when a request failed but can be retried. This includes throttling and server not available cases. A generic exception thrown in all other not covered above cases. + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.Cloud.DocumentDb/IDocumentWriter`1.xml b/xml/System.Cloud.DocumentDb/IDocumentWriter`1.xml index 1e5ce7cd36f..6d1f84d6071 100644 --- a/xml/System.Cloud.DocumentDb/IDocumentWriter`1.xml +++ b/xml/System.Cloud.DocumentDb/IDocumentWriter`1.xml @@ -67,6 +67,7 @@ Thrown when a request failed but can be retried. This includes throttling and server not available cases. A generic exception thrown in all other not covered above cases. + The cancellation token was canceled. This exception is stored into the returned task. @@ -106,6 +107,7 @@ Thrown when a request failed but can be retried. This includes throttling and server not available cases. A generic exception thrown in all other not covered above cases. + The cancellation token was canceled. This exception is stored into the returned task. @@ -156,6 +158,7 @@ Thrown when a request failed but can be retried. This includes throttling and server not available cases. A generic exception thrown in all other not covered above cases. + The cancellation token was canceled. This exception is stored into the returned task. @@ -201,6 +204,7 @@ Thrown when a request failed but can be retried. This includes throttling and server not available cases. A generic exception thrown in all other not covered above cases. + The cancellation token was canceled. This exception is stored into the returned task. @@ -250,6 +254,7 @@ Thrown when a request failed but can be retried. This includes throttling and server not available cases. A generic exception thrown in all other not covered above cases. + The cancellation token was canceled. This exception is stored into the returned task. @@ -292,6 +297,7 @@ Thrown when a request failed but can be retried. This includes throttling and server not available cases. A generic exception thrown in all other not covered above cases. + The cancellation token was canceled. This exception is stored into the returned task. @@ -331,6 +337,7 @@ Thrown when a request failed but can be retried. This includes throttling and server not available cases. A generic exception thrown in all other not covered above cases. + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.Cloud.Messaging/DefaultMessageConsumer.xml b/xml/System.Cloud.Messaging/DefaultMessageConsumer.xml index 5e91b7723f1..f0577040beb 100644 --- a/xml/System.Cloud.Messaging/DefaultMessageConsumer.xml +++ b/xml/System.Cloud.Messaging/DefaultMessageConsumer.xml @@ -115,6 +115,7 @@ . To be added. + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.Cloud.Messaging/IMessagePostponeFeature.xml b/xml/System.Cloud.Messaging/IMessagePostponeFeature.xml index a721f197d7e..4e4e4d6933a 100644 --- a/xml/System.Cloud.Messaging/IMessagePostponeFeature.xml +++ b/xml/System.Cloud.Messaging/IMessagePostponeFeature.xml @@ -45,6 +45,7 @@ . To be added. + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.Cloud.Messaging/IMessageSource.xml b/xml/System.Cloud.Messaging/IMessageSource.xml index 9ab011fbe21..c4ce36a5739 100644 --- a/xml/System.Cloud.Messaging/IMessageSource.xml +++ b/xml/System.Cloud.Messaging/IMessageSource.xml @@ -55,6 +55,7 @@ . To be added. + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.Cloud.Messaging/MessageConsumer.xml b/xml/System.Cloud.Messaging/MessageConsumer.xml index b2410e2cb51..98b0f7b7753 100644 --- a/xml/System.Cloud.Messaging/MessageConsumer.xml +++ b/xml/System.Cloud.Messaging/MessageConsumer.xml @@ -91,6 +91,7 @@ . To be added. + The cancellation token was canceled. This exception is stored into the returned task. @@ -119,6 +120,7 @@ Swallows any exception during retrieving or processing message and returns a non-faulted . To be added. An exception is thrown during . + The cancellation token was canceled. This exception is stored into the returned task. @@ -153,6 +155,7 @@ of nullable . To be added. + The cancellation token was canceled. This exception is stored into the returned task. @@ -311,6 +314,7 @@ Different implementation of the consumer can override this method and execute the in parallel or in any other way using Task Parallel Library (TPL) / DataFlow or any other abstractions. + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.Cloud.Messaging/MessageContext.xml b/xml/System.Cloud.Messaging/MessageContext.xml index 2086226c187..4682a74c542 100644 --- a/xml/System.Cloud.Messaging/MessageContext.xml +++ b/xml/System.Cloud.Messaging/MessageContext.xml @@ -342,6 +342,7 @@ . To be added. + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.Cloud.Messaging/MessagePostponeFeatureExtensions.xml b/xml/System.Cloud.Messaging/MessagePostponeFeatureExtensions.xml index 5b575a7a435..242ade3a052 100644 --- a/xml/System.Cloud.Messaging/MessagePostponeFeatureExtensions.xml +++ b/xml/System.Cloud.Messaging/MessagePostponeFeatureExtensions.xml @@ -64,6 +64,7 @@ Any argument is . There is no added to . + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.CodeDom.Compiler/IndentedTextWriter.xml b/xml/System.CodeDom.Compiler/IndentedTextWriter.xml index 1310678761c..24a89a07f01 100644 --- a/xml/System.CodeDom.Compiler/IndentedTextWriter.xml +++ b/xml/System.CodeDom.Compiler/IndentedTextWriter.xml @@ -504,6 +504,7 @@ Clears all buffers for this asynchronously and causes any buffered data to be written to the underlying device. A representing the asynchronous flush operation. To be added. + The cancellation token was canceled. This exception is stored into the returned task. @@ -1581,6 +1582,7 @@ Asynchronously writes the specified characters to the underlying , inserting tabs at the start of every line. A representing the asynchronous operation. To be added. + The cancellation token was canceled. This exception is stored into the returned task. @@ -1625,6 +1627,7 @@ Asynchronously writes the contents of the specified to the underlying , inserting tabs at the start of every line. A representing the asynchronous operation. To be added. + The cancellation token was canceled. This exception is stored into the returned task. @@ -2639,6 +2642,7 @@ Asynchronously writes the specified characters followed by a line terminator to the underlying , inserting tabs at the start of every line. A representing the asynchronous operation. To be added. + The cancellation token was canceled. This exception is stored into the returned task. @@ -2683,6 +2687,7 @@ Asynchronously writes the contents of the specified followed by a line terminator to the underlying , inserting tabs at the start of every line. A representing the asynchronous operation. To be added. + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.Data.Common/DbBatch.xml b/xml/System.Data.Common/DbBatch.xml index 6d815988318..153fa250912 100644 --- a/xml/System.Data.Common/DbBatch.xml +++ b/xml/System.Data.Common/DbBatch.xml @@ -439,6 +439,7 @@ The precise semantics of batch execution vary across ADO.NET providers, especial ]]> + The cancellation token was canceled. This exception is stored into the returned task. @@ -515,6 +516,7 @@ The precise semantics of batch execution vary across ADO.NET providers, especial An error occurred while executing the batch. ADO.NET Overview + The cancellation token was canceled. This exception is stored into the returned task. @@ -583,6 +585,7 @@ The precise semantics of batch execution vary across ADO.NET providers, especial An error occurred while executing the batch. The value is invalid. + The cancellation token was canceled. This exception is stored into the returned task. @@ -622,6 +625,7 @@ The precise semantics of batch execution vary across ADO.NET providers, especial An error occurred while executing the batch. The value is invalid. + The cancellation token was canceled. This exception is stored into the returned task. @@ -680,6 +684,7 @@ The precise semantics of batch execution vary across ADO.NET providers, especial The first column of the first row in the first result set. 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 . An error occurred while executing the batch. + The cancellation token was canceled. This exception is stored into the returned task. @@ -729,6 +734,7 @@ The precise semantics of batch execution vary across ADO.NET providers, especial Asynchronously creates a prepared (or compiled) version of the batch, or of each of its commands, on the data source. A representing the asynchronous operation. 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 . + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.Data.Common/DbCommand.xml b/xml/System.Data.Common/DbCommand.xml index 634a819f5ba..3accf0f9b20 100644 --- a/xml/System.Data.Common/DbCommand.xml +++ b/xml/System.Data.Common/DbCommand.xml @@ -925,6 +925,7 @@ An error occurred while executing the command. An invalid value. ADO.NET Overview + The cancellation token was canceled. This exception is stored into the returned task. @@ -1111,6 +1112,7 @@ An error occurred while executing the command. ADO.NET Overview + The cancellation token was canceled. This exception is stored into the returned task. @@ -1395,6 +1397,7 @@ An error occurred while executing the command. An invalid value. ADO.NET Overview + The cancellation token was canceled. This exception is stored into the returned task. @@ -1452,6 +1455,7 @@ An error occurred while executing the command. An invalid value. ADO.NET Overview + The cancellation token was canceled. This exception is stored into the returned task. @@ -1644,6 +1648,7 @@ An error occurred while executing the command. ADO.NET Overview + The cancellation token was canceled. This exception is stored into the returned task. @@ -1795,6 +1800,7 @@ ]]> + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.Data.Common/DbConnection.xml b/xml/System.Data.Common/DbConnection.xml index c1eb2ff08e7..a34c8e3b201 100644 --- a/xml/System.Data.Common/DbConnection.xml +++ b/xml/System.Data.Common/DbConnection.xml @@ -228,6 +228,7 @@ ]]> + The cancellation token was canceled. This exception is stored into the returned task. @@ -392,6 +393,7 @@ ]]> + The cancellation token was canceled. This exception is stored into the returned task. @@ -441,6 +443,7 @@ ]]> + The cancellation token was canceled. This exception is stored into the returned task. @@ -582,6 +585,7 @@ This property returns `false` by default; providers that implement + The cancellation token was canceled. This exception is stored into the returned task. @@ -1492,6 +1496,7 @@ This property returns `false` by default; providers that implement will be communicated via the returned Task Exception property. A task representing the asynchronous operation. 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 . + The cancellation token was canceled. This exception is stored into the returned task. @@ -1529,6 +1534,7 @@ This property returns `false` by default; providers that implement will be communicated via the returned Task Exception property. A task representing the asynchronous operation. 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 . + The cancellation token was canceled. This exception is stored into the returned task. @@ -1575,6 +1581,7 @@ This property returns `false` by default; providers that implement will be communicated via the returned Task Exception property. A task representing the asynchronous operation. 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 . + The cancellation token was canceled. This exception is stored into the returned task. @@ -1814,6 +1821,7 @@ This property returns `false` by default; providers that implement ADO.NET Overview + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.Data.Common/DbDataReader.xml b/xml/System.Data.Common/DbDataReader.xml index 0413b5f442b..a7296058dec 100644 --- a/xml/System.Data.Common/DbDataReader.xml +++ b/xml/System.Data.Common/DbDataReader.xml @@ -818,6 +818,7 @@ Exceptions thrown by will be communicated via the returned Task Exception property. A task representing the asynchronous operation. To be added. + The cancellation token was canceled. This exception is stored into the returned task. @@ -1509,6 +1510,7 @@ private static void GetDataTypes(String connectionString) There was an asynchronous operation in progress. This applies to all Get_*_ methods when running in sequential mode, as they could be called while reading a stream. The column index is out of range. The value returned by the database doesn't match or cannot be cast to . + The cancellation token was canceled. This exception is stored into the returned task. @@ -2139,6 +2141,7 @@ Returns if the executed command returned no resultset, o Exceptions thrown by will be communicated via the returned Task Exception property. A task representing the asynchronous operation. 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 . + The cancellation token was canceled. This exception is stored into the returned task. @@ -2737,6 +2740,7 @@ Returns if the executed command returned no resultset, o There was an asynchronous operation in progress. This applies to all Get* methods when running in sequential mode, as they could be called while reading a stream. The column index is out of range. + The cancellation token was canceled. This exception is stored into the returned task. @@ -3028,6 +3032,7 @@ Returns if the executed command returned no resultset, o An error occurred while executing the command text. ADO.NET Overview + The cancellation token was canceled. This exception is stored into the returned task. @@ -3212,6 +3217,7 @@ Returns if the executed command returned no resultset, o An error occurred while executing the command text. ADO.NET Overview + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.Data.Common/DbDataSource.xml b/xml/System.Data.Common/DbDataSource.xml index 27952b0b73d..ae178eae50a 100644 --- a/xml/System.Data.Common/DbDataSource.xml +++ b/xml/System.Data.Common/DbDataSource.xml @@ -476,6 +476,7 @@ ]]> + The cancellation token was canceled. This exception is stored into the returned task. @@ -540,6 +541,7 @@ ]]> + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.Data.Common/DbTransaction.xml b/xml/System.Data.Common/DbTransaction.xml index 1881fbeb856..42d6f77f047 100644 --- a/xml/System.Data.Common/DbTransaction.xml +++ b/xml/System.Data.Common/DbTransaction.xml @@ -214,6 +214,7 @@ ]]> + The cancellation token was canceled. This exception is stored into the returned task. @@ -612,6 +613,7 @@ Destroys a savepoint previously defined in the current transaction. This allows the system to reclaim some resources before the transaction ends. A representing the asynchronous operation. 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 . + The cancellation token was canceled. This exception is stored into the returned task. @@ -734,6 +736,7 @@ ]]> + The cancellation token was canceled. This exception is stored into the returned task. @@ -766,6 +769,7 @@ Rolls back all commands that were executed after the specified savepoint was established. A representing the asynchronous operation. 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 . + The cancellation token was canceled. This exception is stored into the returned task. @@ -828,6 +832,7 @@ Creates a savepoint in the transaction. This allows all commands that are executed after the savepoint was established to be rolled back, restoring the transaction state to what it was at the time of the savepoint. A representing the asynchronous operation. 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 . + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.Data.SqlClient/SqlBulkCopy.xml b/xml/System.Data.SqlClient/SqlBulkCopy.xml index 12312384f8b..f81c7ed31b0 100644 --- a/xml/System.Data.SqlClient/SqlBulkCopy.xml +++ b/xml/System.Data.SqlClient/SqlBulkCopy.xml @@ -1422,6 +1422,7 @@ This method stores in the task it returns all non-usage exceptions that the meth The asynchronous version of , which copies all rows from the supplied array to a destination table specified by the property of the object. Returns . 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 . + The cancellation token was canceled. This exception is stored into the returned task. @@ -1483,6 +1484,7 @@ This method stores in the task it returns all non-usage exceptions that the meth is specified in the connection string. Returned in the task object, any error returned by SQL Server that occurred while opening the connection. + The cancellation token was canceled. This exception is stored into the returned task. @@ -1603,6 +1605,7 @@ This method stores in the task it returns all non-usage exceptions that the meth is specified in the connection string. Returned in the task object, any error returned by SQL Server that occurred while opening the connection. + The cancellation token was canceled. This exception is stored into the returned task. @@ -1668,6 +1671,7 @@ This method stores in the task it returns all non-usage exceptions that the meth is specified in the connection string. Returned in the task object, any error returned by SQL Server that occurred while opening the connection. + The cancellation token was canceled. This exception is stored into the returned task. @@ -1731,6 +1735,7 @@ This method stores in the task it returns all non-usage exceptions that the meth is specified in the connection string. Returned in the task object, any error returned by SQL Server that occurred while opening the connection. + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.Data.SqlClient/SqlCommand.xml b/xml/System.Data.SqlClient/SqlCommand.xml index e30fec51f85..3543902e4b0 100644 --- a/xml/System.Data.SqlClient/SqlCommand.xml +++ b/xml/System.Data.SqlClient/SqlCommand.xml @@ -2558,6 +2558,7 @@ In some situations, can be set to To be added. To be added. 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 . + The cancellation token was canceled. This exception is stored into the returned task. @@ -2724,6 +2725,7 @@ The closed or dropped durin An error occurred in a , or object during a streaming operation. For more information about streaming, see [SqlClient Streaming Support](/dotnet/framework/data/adonet/sqlclient-streaming-support). The , or object was closed during a streaming operation. For more information about streaming, see [SqlClient Streaming Support](/dotnet/framework/data/adonet/sqlclient-streaming-support). ADO.NET Overview + The cancellation token was canceled. This exception is stored into the returned task. @@ -3146,6 +3148,7 @@ A timeout occurred during a streaming operation. For more information about stre An error occurred in a , or object during a streaming operation. For more information about streaming, see [SqlClient Streaming Support](/dotnet/framework/data/adonet/sqlclient-streaming-support). The , or object was closed during a streaming operation. For more information about streaming, see [SqlClient Streaming Support](/dotnet/framework/data/adonet/sqlclient-streaming-support). ADO.NET Overview + The cancellation token was canceled. This exception is stored into the returned task. @@ -3226,6 +3229,7 @@ A timeout occurred during a streaming operation. For more information about stre An error occurred in a , or object during a streaming operation. For more information about streaming, see [SqlClient Streaming Support](/dotnet/framework/data/adonet/sqlclient-streaming-support). The , or object was closed during a streaming operation. For more information about streaming, see [SqlClient Streaming Support](/dotnet/framework/data/adonet/sqlclient-streaming-support). ADO.NET Overview + The cancellation token was canceled. This exception is stored into the returned task. @@ -3389,6 +3393,7 @@ A timeout occurred during a streaming operation. For more information about stre An error occurred in a , or object during a streaming operation. For more information about streaming, see [SqlClient Streaming Support](/dotnet/framework/data/adonet/sqlclient-streaming-support). The , or object was closed during a streaming operation. For more information about streaming, see [SqlClient Streaming Support](/dotnet/framework/data/adonet/sqlclient-streaming-support). ADO.NET Overview + The cancellation token was canceled. This exception is stored into the returned task. @@ -3643,6 +3648,7 @@ A timeout occurred during a streaming operation. For more information about stre An error occurred in a , or object during a streaming operation. For more information about streaming, see [SqlClient Streaming Support](/dotnet/framework/data/adonet/sqlclient-streaming-support). The , or object was closed during a streaming operation. For more information about streaming, see [SqlClient Streaming Support](/dotnet/framework/data/adonet/sqlclient-streaming-support). ADO.NET Overview + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.Data.SqlClient/SqlConnection.xml b/xml/System.Data.SqlClient/SqlConnection.xml index 3d82746b4b3..17de3be24c2 100644 --- a/xml/System.Data.SqlClient/SqlConnection.xml +++ b/xml/System.Data.SqlClient/SqlConnection.xml @@ -2633,6 +2633,7 @@ class Program { A connection was not available from the connection pool before the connection time out elapsed. Any error returned by SQL Server that occurred while opening the connection. ADO.NET Overview + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.Data.SqlClient/SqlDataReader.xml b/xml/System.Data.SqlClient/SqlDataReader.xml index 993b7a7dddd..9692e477ee1 100644 --- a/xml/System.Data.SqlClient/SqlDataReader.xml +++ b/xml/System.Data.SqlClient/SqlDataReader.xml @@ -1289,6 +1289,7 @@ This member is an explicit interface member implementation. It can be used only The value of the column was null ( == ), retrieving a non-SQL type. doesn't match the type returned by SQL Server or cannot be cast. + The cancellation token was canceled. This exception is stored into the returned task. @@ -3743,6 +3744,7 @@ This member is an explicit interface member implementation. It can be used only is specified in the connection string. Trying to read a column that does not exist. + The cancellation token was canceled. This exception is stored into the returned task. @@ -3981,6 +3983,7 @@ This member is an explicit interface member implementation. It can be used only is specified in the connection string. SQL Server returned an error while executing the command text. ADO.NET Overview + The cancellation token was canceled. This exception is stored into the returned task. @@ -4108,6 +4111,7 @@ This member is an explicit interface member implementation. It can be used only is specified in the connection string. SQL Server returned an error while executing the command text. ADO.NET Overview + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.Data/DataReaderExtensions.xml b/xml/System.Data/DataReaderExtensions.xml index ddde36288f2..6201f148a31 100644 --- a/xml/System.Data/DataReaderExtensions.xml +++ b/xml/System.Data/DataReaderExtensions.xml @@ -637,6 +637,7 @@ There was an asynchronous operation in progress. This applies to all Get_*_ methods when running in sequential mode, as they could be called while reading a stream. The name specified is not a valid column name. The value returned by the database doesn't match or cannot be cast to . + The cancellation token was canceled. This exception is stored into the returned task. @@ -1240,6 +1241,7 @@ There was an asynchronous operation in progress. This applies to all Get* methods when running in sequential mode, as they could be called while reading a stream. The name specified is not a valid column name. + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.Diagnostics/Process.xml b/xml/System.Diagnostics/Process.xml index 12e670ed259..bd5bb1d6844 100644 --- a/xml/System.Diagnostics/Process.xml +++ b/xml/System.Diagnostics/Process.xml @@ -6958,6 +6958,7 @@ This method stores in the task it returns all non-usage exceptions that the meth ]]> + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.Formats.Tar/TarEntry.xml b/xml/System.Formats.Tar/TarEntry.xml index d7c6df9225e..7cd08119109 100644 --- a/xml/System.Formats.Tar/TarEntry.xml +++ b/xml/System.Formats.Tar/TarEntry.xml @@ -220,6 +220,7 @@ A directory exists with the same name as An I/O problem occurred. The entry type is unsupported. Permissions are insufficient. + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.Formats.Tar/TarFile.xml b/xml/System.Formats.Tar/TarFile.xml index d3f11a7e4df..4379848cc78 100644 --- a/xml/System.Formats.Tar/TarFile.xml +++ b/xml/System.Formats.Tar/TarFile.xml @@ -145,6 +145,7 @@ does not support writing. The directory path is not found. An I/O exception occurred. + The cancellation token was canceled. This exception is stored into the returned task. @@ -183,6 +184,7 @@ or is empty. The directory path is not found. An I/O exception occurred. + The cancellation token was canceled. This exception is stored into the returned task. @@ -327,6 +329,7 @@ Extracting one of the tar entries would have resulted in a file outside the spec does not support reading. An I/O exception occurred. + The cancellation token was canceled. This exception is stored into the returned task. @@ -375,6 +378,7 @@ Extracting one of the tar entries would have resulted in a file outside the spec or is empty. An I/O exception occurred. + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.Formats.Tar/TarReader.xml b/xml/System.Formats.Tar/TarReader.xml index bbeaf68b741..491528cb157 100644 --- a/xml/System.Formats.Tar/TarReader.xml +++ b/xml/System.Formats.Tar/TarReader.xml @@ -209,6 +209,7 @@ More than one Global Extended Attributes Entry was found in the current archive. An I/O problem occurred. + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.Formats.Tar/TarWriter.xml b/xml/System.Formats.Tar/TarWriter.xml index 5ab23c322ec..38bec890d04 100644 --- a/xml/System.Formats.Tar/TarWriter.xml +++ b/xml/System.Formats.Tar/TarWriter.xml @@ -349,6 +349,7 @@ This method stores in the task it returns all non-usage exceptions that the meth is . An I/O problem occurred. + The cancellation token was canceled. This exception is stored into the returned task. @@ -389,6 +390,7 @@ This method stores in the task it returns all non-usage exceptions that the meth or is or empty. An I/O problem occurred. + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.IO.Compression/BrotliStream.xml b/xml/System.IO.Compression/BrotliStream.xml index f8b19f714de..d2e13898ec0 100644 --- a/xml/System.IO.Compression/BrotliStream.xml +++ b/xml/System.IO.Compression/BrotliStream.xml @@ -633,6 +633,7 @@ Asynchronously clears all buffers for this Brotli stream, causes any buffered data to be written to the underlying device, and monitors cancellation requests. A task that represents the asynchronous flush operation. If the operation is canceled before it completes, the returned task contains the value for the property.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 . + The cancellation token was canceled. This exception is stored into the returned task. @@ -830,6 +831,7 @@ Use the property to determine whether the current instance supports reading. If the operation is canceled before it completes, the returned task contains the value for the property. + The cancellation token was canceled. This exception is stored into the returned task. @@ -875,6 +877,7 @@ If the operation is canceled before it completes, the returned task contains the value for the property. 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 . + The cancellation token was canceled. This exception is stored into the returned task. @@ -1102,6 +1105,7 @@ Use the property to determine whether the current instance supports writing. If the operation is canceled before it completes, the returned task contains the value for the property. + The cancellation token was canceled. This exception is stored into the returned task. @@ -1147,6 +1151,7 @@ If the operation is canceled before it completes, the returned task contains the value for the property. 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 . + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.IO.Compression/DeflateStream.xml b/xml/System.IO.Compression/DeflateStream.xml index b8a0cee5268..180952b8482 100644 --- a/xml/System.IO.Compression/DeflateStream.xml +++ b/xml/System.IO.Compression/DeflateStream.xml @@ -775,6 +775,7 @@ This method stores in the task it returns all non-usage exceptions that the meth ]]> + The cancellation token was canceled. This exception is stored into the returned task. @@ -1118,6 +1119,7 @@ This method stores in the task it returns all non-usage exceptions that the meth ]]> + The cancellation token was canceled. This exception is stored into the returned task. @@ -1392,6 +1394,7 @@ If the operation is canceled before it completes, the returned task contains the ]]> + The cancellation token was canceled. This exception is stored into the returned task. @@ -1458,6 +1461,7 @@ This method stores in the task it returns all non-usage exceptions that the meth ]]> + The cancellation token was canceled. This exception is stored into the returned task. @@ -1764,6 +1768,7 @@ If the operation is canceled before it completes, the returned task contains the ]]> + The cancellation token was canceled. This exception is stored into the returned task. @@ -1830,6 +1835,7 @@ This method stores in the task it returns all non-usage exceptions that the meth ]]> + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.IO.Compression/GZipStream.xml b/xml/System.IO.Compression/GZipStream.xml index cd62dd8a75e..7b72a9f37b1 100644 --- a/xml/System.IO.Compression/GZipStream.xml +++ b/xml/System.IO.Compression/GZipStream.xml @@ -811,6 +811,7 @@ This method stores in the task it returns all non-usage exceptions that the meth ]]> + The cancellation token was canceled. This exception is stored into the returned task. @@ -1139,6 +1140,7 @@ This method stores in the task it returns all non-usage exceptions that the meth ]]> + The cancellation token was canceled. This exception is stored into the returned task. @@ -1418,6 +1420,7 @@ If the operation is canceled before it completes, the returned task contains the ]]> + The cancellation token was canceled. This exception is stored into the returned task. @@ -1484,6 +1487,7 @@ This method stores in the task it returns all non-usage exceptions that the meth ]]> + The cancellation token was canceled. This exception is stored into the returned task. @@ -1796,6 +1800,7 @@ If the operation is canceled before it completes, the returned task contains the ]]> + The cancellation token was canceled. This exception is stored into the returned task. @@ -1862,6 +1867,7 @@ This method stores in the task it returns all non-usage exceptions that the meth ]]> + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.IO.Compression/ZLibStream.xml b/xml/System.IO.Compression/ZLibStream.xml index 544f4245059..ffb70b03fb2 100644 --- a/xml/System.IO.Compression/ZLibStream.xml +++ b/xml/System.IO.Compression/ZLibStream.xml @@ -423,6 +423,7 @@ The stream does not support reading or writing. The stream is closed. Only one asynchronous reader or writer is allowed at a time. + The cancellation token was canceled. This exception is stored into the returned task. @@ -576,6 +577,7 @@ Asynchronously clears all buffers for this stream, causes any buffered data to be written to the underlying device, and monitors cancellation requests. A task that represents the asynchronous flush operation. 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 . + The cancellation token was canceled. This exception is stored into the returned task. @@ -720,6 +722,7 @@ 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 completion of the operation. To be added. + The cancellation token was canceled. This exception is stored into the returned task. @@ -753,6 +756,7 @@ 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 completion of the operation. 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 . + The cancellation token was canceled. This exception is stored into the returned task. @@ -928,6 +932,7 @@ 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 completion of the operation. To be added. + The cancellation token was canceled. This exception is stored into the returned task. @@ -961,6 +966,7 @@ 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 completion of the operation. 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 . + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.IO.Hashing/NonCryptographicHashAlgorithm.xml b/xml/System.IO.Hashing/NonCryptographicHashAlgorithm.xml index a50167ebaae..c25cad62f7e 100644 --- a/xml/System.IO.Hashing/NonCryptographicHashAlgorithm.xml +++ b/xml/System.IO.Hashing/NonCryptographicHashAlgorithm.xml @@ -174,6 +174,7 @@ 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 . is . + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.IO.IsolatedStorage/IsolatedStorageFileStream.xml b/xml/System.IO.IsolatedStorage/IsolatedStorageFileStream.xml index 1c9fa7d2c09..0ad22ef570c 100644 --- a/xml/System.IO.IsolatedStorage/IsolatedStorageFileStream.xml +++ b/xml/System.IO.IsolatedStorage/IsolatedStorageFileStream.xml @@ -1417,6 +1417,7 @@ Dim source As New IsolatedStorageFileStream(UserName,FileMode.Open,isoFile) Asynchronously clears buffers for this stream and causes any buffered data to be written to the file. A task that represents the asynchronous flush operation. 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 . + The cancellation token was canceled. This exception is stored into the returned task. @@ -1872,6 +1873,7 @@ The method wi Asynchronously copies bytes from the current buffered object to a byte memory range. A task that represents the asynchronous read operation. It wraps the total number of bytes read into the . This can be less than the number of bytes requested if that many bytes are not currently available, or zero if the end of the stream is reached. To be added. + The cancellation token was canceled. This exception is stored into the returned task. @@ -1929,6 +1931,7 @@ This method stores in the task it returns all non-usage exceptions that the meth ]]> + The cancellation token was canceled. This exception is stored into the returned task. @@ -2348,6 +2351,7 @@ If the write operation is successful, the current position of the Asynchronously writes a block of bytes to the isolated storage file stream object using data read from a buffer consisting of a read-only byte memory range. A task that represents the asynchronous write operation. To be added. + The cancellation token was canceled. This exception is stored into the returned task. @@ -2399,6 +2403,7 @@ This method stores in the task it returns all non-usage exceptions that the meth ]]> + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.IO.Pipelines/PipeReader.xml b/xml/System.IO.Pipelines/PipeReader.xml index 8372af418b4..6f0c01c15ed 100644 --- a/xml/System.IO.Pipelines/PipeReader.xml +++ b/xml/System.IO.Pipelines/PipeReader.xml @@ -342,6 +342,7 @@ The canceled Asynchronously reads the bytes from the and writes them to the specified , using a specified buffer size and cancellation token. A task that represents the asynchronous copy operation. To be added. + The cancellation token was canceled. This exception is stored into the returned task. @@ -379,6 +380,7 @@ The canceled Asynchronously reads the bytes from the and writes them to the specified stream, using a specified cancellation token. A task that represents the asynchronous copy operation. To be added. + The cancellation token was canceled. This exception is stored into the returned task. @@ -550,6 +552,7 @@ The canceled Asynchronously reads a sequence of bytes from the current . A representing the asynchronous read operation. To be added. + The cancellation token was canceled. This exception is stored into the returned task. @@ -586,6 +589,7 @@ The call returns if the has read the `mini ]]> + The cancellation token was canceled. This exception is stored into the returned task. @@ -623,6 +627,7 @@ The call returns if the has read the `mini ]]> + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.IO.Pipelines/PipeWriter.xml b/xml/System.IO.Pipelines/PipeWriter.xml index 88e5bdbdc6b..2bff5c7e1cf 100644 --- a/xml/System.IO.Pipelines/PipeWriter.xml +++ b/xml/System.IO.Pipelines/PipeWriter.xml @@ -290,6 +290,7 @@ The canceled Asynchronously reads the bytes from the specified stream and writes them to the . A task that represents the asynchronous copy operation. To be added. + The cancellation token was canceled. This exception is stored into the returned task. @@ -366,6 +367,7 @@ The canceled Makes bytes written available to and runs continuation. A task that represents and wraps the asynchronous flush operation. To be added. + The cancellation token was canceled. This exception is stored into the returned task. @@ -581,6 +583,7 @@ You must request a new buffer after calling Writes the specified byte memory range to the pipe and makes data accessible to the . A task that represents the asynchronous write operation, and wraps the flush asynchronous operation. To be added. + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.IO.Pipelines/StreamPipeExtensions.xml b/xml/System.IO.Pipelines/StreamPipeExtensions.xml index 7a2f98255f0..637d8fd218b 100644 --- a/xml/System.IO.Pipelines/StreamPipeExtensions.xml +++ b/xml/System.IO.Pipelines/StreamPipeExtensions.xml @@ -60,6 +60,7 @@ Asynchronously reads the bytes from the and writes them to the specified , using a cancellation token. A task that represents the asynchronous copy operation. To be added. + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.IO.Pipes/NamedPipeClientStream.xml b/xml/System.IO.Pipes/NamedPipeClientStream.xml index 93dd71f6591..a114fef22ca 100644 --- a/xml/System.IO.Pipes/NamedPipeClientStream.xml +++ b/xml/System.IO.Pipes/NamedPipeClientStream.xml @@ -1019,6 +1019,7 @@ Asynchronously connects to a waiting server and monitors cancellation requests. A task that represents the asynchronous connect operation. 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 . + The cancellation token was canceled. This exception is stored into the returned task. @@ -1063,6 +1064,7 @@ Asynchronously connects to a waiting server within the specified timeout period and monitors cancellation requests. A task that represents the asynchronous connect operation. 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 . + The cancellation token was canceled. This exception is stored into the returned task. @@ -1094,6 +1096,7 @@ Asynchronously connects to a waiting server within the specified timeout period and monitors cancellation requests. A task that represents the asynchronous connect operation. 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 . + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.IO.Pipes/NamedPipeServerStream.xml b/xml/System.IO.Pipes/NamedPipeServerStream.xml index faf551ab560..98419b328de 100644 --- a/xml/System.IO.Pipes/NamedPipeServerStream.xml +++ b/xml/System.IO.Pipes/NamedPipeServerStream.xml @@ -1588,6 +1588,7 @@ ]]> + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.IO.Pipes/PipeStream.xml b/xml/System.IO.Pipes/PipeStream.xml index 2a8118fbd32..b47ce2c0283 100644 --- a/xml/System.IO.Pipes/PipeStream.xml +++ b/xml/System.IO.Pipes/PipeStream.xml @@ -934,6 +934,7 @@ When the disposing parameter is `true`, this method releases all resources held Asynchronously clears the buffer for the current stream and causes any buffered data to be written to the underlying device. A task that represent the asynchronous flush operation. 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 . + The cancellation token was canceled. This exception is stored into the returned task. @@ -1691,6 +1692,7 @@ The pipe is in a disconnected state. The pipe handle has not been set. (Did your implementation call ? + The cancellation token was canceled. This exception is stored into the returned task. @@ -1759,6 +1761,7 @@ The pipe is in a disconnected state. The pipe handle has not been set. (Did your implementation call ? + The cancellation token was canceled. This exception is stored into the returned task. @@ -2401,6 +2404,7 @@ The pipe is in a disconnected state. The pipe handle has not been set. (Did your implementation call ? + The cancellation token was canceled. This exception is stored into the returned task. @@ -2480,6 +2484,7 @@ The pipe is in a disconnected state. The pipe handle has not been set. (Did your implementation call ? + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.IO/BufferedStream.xml b/xml/System.IO/BufferedStream.xml index 72bfd45b030..92bab14dd1d 100644 --- a/xml/System.IO/BufferedStream.xml +++ b/xml/System.IO/BufferedStream.xml @@ -862,6 +862,7 @@ This method stores in the task it returns all non-usage exceptions that the meth ]]> + The cancellation token was canceled. This exception is stored into the returned task. @@ -1211,6 +1212,7 @@ Calling `DisposeAsync` allows the resources used by the A task that represents the asynchronous flush operation. 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 . The stream has been disposed. + The cancellation token was canceled. This exception is stored into the returned task. @@ -1545,6 +1547,7 @@ If the operation is canceled before it completes, the returned task contains the ]]> + The cancellation token was canceled. This exception is stored into the returned task. @@ -1616,6 +1619,7 @@ If the operation is canceled before it completes, the returned task contains the The stream does not support reading. The stream has been disposed. The stream is currently in use by a previous read operation. + The cancellation token was canceled. This exception is stored into the returned task. @@ -2057,6 +2061,7 @@ If the operation is canceled before it completes, the returned task contains the ]]> + The cancellation token was canceled. This exception is stored into the returned task. @@ -2128,6 +2133,7 @@ If the operation is canceled before it completes, the returned task contains the The stream does not support writing. The stream has been disposed. The stream is currently in use by a previous write operation. + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.IO/File.xml b/xml/System.IO/File.xml index a91aa46e95b..6c1e3006a6b 100644 --- a/xml/System.IO/File.xml +++ b/xml/System.IO/File.xml @@ -363,6 +363,7 @@ Asynchronously appends lines to a file, and then closes the file. If the specified file does not exist, this method creates a file, writes the specified lines to the file, and then closes the file. A task that represents the asynchronous append operation. 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 . + The cancellation token was canceled. This exception is stored into the returned task. @@ -410,6 +411,7 @@ Asynchronously appends lines to a file by using a specified encoding, and then closes the file. If the specified file does not exist, this method creates a file, writes the specified lines to the file, and then closes the file. A task that represents the asynchronous append operation. 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 . + The cancellation token was canceled. This exception is stored into the returned task. @@ -683,6 +685,7 @@ Asynchronously opens a file or creates a file if it does not already exist, appends the specified string to the file, and then closes the file. A task that represents the asynchronous append operation. 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 . + The cancellation token was canceled. This exception is stored into the returned task. @@ -738,6 +741,7 @@ Asynchronously opens a file or creates the file if it does not already exist, appends the specified string to the file using the specified encoding, and then closes the file. A task that represents the asynchronous append operation. 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 . + The cancellation token was canceled. This exception is stored into the returned task. @@ -4147,6 +4151,7 @@ The following example moves a file. Asynchronously opens a binary file, reads the contents of the file into a byte array, and then closes the file. A task that represents the asynchronous read operation, which wraps the byte array containing the contents of the file. 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 . + The cancellation token was canceled. This exception is stored into the returned task. @@ -4402,6 +4407,7 @@ The following example moves a file. Asynchronously opens a text file, reads all lines of the file, and then closes the file. A task that represents the asynchronous read operation, which wraps the string array containing all lines of the file. 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 . + The cancellation token was canceled. This exception is stored into the returned task. @@ -4447,6 +4453,7 @@ The following example moves a file. Asynchronously opens a text file, reads all lines of the file with the specified encoding, and then closes the file. A task that represents the asynchronous read operation, which wraps the string array containing all lines of the file. 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 . + The cancellation token was canceled. This exception is stored into the returned task. @@ -4710,6 +4717,7 @@ The following example moves a file. Asynchronously opens a text file, reads all the text in the file, and then closes the file. A task that represents the asynchronous read operation, which wraps the string containing all text in the file. 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 . + The cancellation token was canceled. This exception is stored into the returned task. @@ -4755,6 +4763,7 @@ The following example moves a file. Asynchronously opens a text file, reads all text in the file with the specified encoding, and then closes the file. A task that represents the asynchronous read operation, which wraps the string containing all text in the file. 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 . + The cancellation token was canceled. This exception is stored into the returned task. @@ -5003,6 +5012,7 @@ The following example moves a file. Asynchronously reads the lines of a file. The async enumerable that represents all the lines of the file, or the lines that are the result of a query. 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 . + The cancellation token was canceled. This exception is stored into the returned task. @@ -5038,6 +5048,7 @@ The following example moves a file. Asynchronously reads the lines of a file that has a specified encoding. The async enumerable that represents all the lines of the file, or the lines that are the result of a query. 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 . + The cancellation token was canceled. This exception is stored into the returned task. @@ -6544,6 +6555,7 @@ It is not possible to change the compression status of a o Asynchronously creates a new file, writes the specified byte array to the file, and then closes the file. If the target file already exists, it is overwritten. A task that represents the asynchronous write operation. 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 . + The cancellation token was canceled. This exception is stored into the returned task. @@ -6996,6 +7008,7 @@ It is not possible to change the compression status of a o Asynchronously creates a new file, writes the specified lines to the file, and then closes the file. A task that represents the asynchronous write operation. 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 . + The cancellation token was canceled. This exception is stored into the returned task. @@ -7043,6 +7056,7 @@ It is not possible to change the compression status of a o Asynchronously creates a new file, write the specified lines to the file by using the specified encoding, and then closes the file. A task that represents the asynchronous write operation. 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 . + The cancellation token was canceled. This exception is stored into the returned task. @@ -7322,6 +7336,7 @@ It is not possible to change the compression status of a o Asynchronously creates a new file, writes the specified string to the file, and then closes the file. If the target file already exists, it is overwritten. A task that represents the asynchronous write operation. 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 . + The cancellation token was canceled. This exception is stored into the returned task. @@ -7377,6 +7392,7 @@ It is not possible to change the compression status of a o Asynchronously creates a new file, writes the specified string to the file using the specified encoding, and then closes the file. If the target file already exists, it is overwritten. A task that represents the asynchronous write operation. 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 . + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.IO/FileStream.xml b/xml/System.IO/FileStream.xml index 22a42f45bef..35dbcfed5ca 100644 --- a/xml/System.IO/FileStream.xml +++ b/xml/System.IO/FileStream.xml @@ -2268,6 +2268,7 @@ For an example of copying between two streams, see the + The cancellation token was canceled. This exception is stored into the returned task. @@ -2842,6 +2843,7 @@ Calling `DisposeAsync` allows the resources used by the The stream has been disposed. Cancellation + The cancellation token was canceled. This exception is stored into the returned task. @@ -3598,6 +3600,7 @@ The following example shows how to read from a file asynchronously. ]]> + The cancellation token was canceled. This exception is stored into the returned task. @@ -3691,6 +3694,7 @@ The following example shows how to read from a file asynchronously. The stream has been disposed. The stream is currently in use by a previous read operation. Cancellation + The cancellation token was canceled. This exception is stored into the returned task. @@ -4371,6 +4375,7 @@ If the operation is canceled before it completes, the returned task contains the ]]> + The cancellation token was canceled. This exception is stored into the returned task. @@ -4461,6 +4466,7 @@ This method stores in the task it returns all non-usage exceptions that the meth The stream does not support writing. The stream has been disposed. The stream is currently in use by a previous write operation. + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.IO/MemoryStream.xml b/xml/System.IO/MemoryStream.xml index b89ee74d841..608ad492f43 100644 --- a/xml/System.IO/MemoryStream.xml +++ b/xml/System.IO/MemoryStream.xml @@ -1194,6 +1194,7 @@ The stream is unwritable. 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. @@ -1514,6 +1515,7 @@ The pending operation does not support writing. The stream has been disposed. Cancellation + The cancellation token was canceled. This exception is stored into the returned task. @@ -1969,6 +1971,7 @@ The pending operation does not support writing. Asynchronously reads a sequence of bytes from the current memory stream, writes the sequence into , advances the position within the memory stream by the number of bytes read, and monitors cancellation requests. A task that represents the asynchronous read operation. The value of its property contains the total number of bytes read into the . The result value can be less than the number of bytes allocated in if that many bytes are not currently available, or it can be 0 (zero) if the end of the memory stream has been reached. To be added. + The cancellation token was canceled. This exception is stored into the returned task. @@ -2050,6 +2053,7 @@ The pending operation does not support writing. The stream does not support reading. The stream has been disposed. The stream is currently in use by a previous read operation. + The cancellation token was canceled. This exception is stored into the returned task. @@ -2634,6 +2638,7 @@ The underlying buffer will not be exposed if the current `MemoryStream` instance Asynchronously writes the sequence of bytes contained in into the current memory stream, advances the current position within this memory stream by the number of bytes written, and monitors cancellation requests. A task that represents the asynchronous write operation. To be added. + The cancellation token was canceled. This exception is stored into the returned task. @@ -2715,6 +2720,7 @@ The underlying buffer will not be exposed if the current `MemoryStream` instance The stream does not support writing. The stream has been disposed. The stream is currently in use by a previous write operation. + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.IO/RandomAccess.xml b/xml/System.IO/RandomAccess.xml index e80487d2071..4febdc01d76 100644 --- a/xml/System.IO/RandomAccess.xml +++ b/xml/System.IO/RandomAccess.xml @@ -1,273 +1,273 @@ - - - - - - - - - System.Runtime - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - System.Object - - - - Provides offset-based APIs for reading and writing files in a thread-safe manner. + + + + + + + + + System.Runtime + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + System.Object + + + + Provides offset-based APIs for reading and writing files in a thread-safe manner. Only regular disk files are supported. Unseekable files, like pipes, are not supported. - - Synchronization and Overlapped Input and Output - OVERLAPPED structure - - - - - - - - - - Method - - System.Runtime - 8.0.0.0 - - - - [System.Runtime.CompilerServices.NullableContext(1)] - [<System.Runtime.CompilerServices.NullableContext(1)>] - - - - System.Void - - - - - - The file handle. - Flushes the operating system buffers for the given file to disk. - + + Synchronization and Overlapped Input and Output + OVERLAPPED structure + + + + + + + + + + Method + + System.Runtime + 8.0.0.0 + + + + [System.Runtime.CompilerServices.NullableContext(1)] + [<System.Runtime.CompilerServices.NullableContext(1)>] + + + + System.Void + + + + + + The file handle. + Flushes the operating system buffers for the given file to disk. + This method calls platform-dependent APIs such as FlushFileBuffers() on Windows and fsync() on Unix. - + Flushing the buffers causes data to be written to disk, which is a relatively expensive operation. It is recommended that you perform multiple writes to the file and then call this method either when you are done writing to the file or periodically if you expect to continue writing to the file over a long period of time. - - - - is . - - is invalid. - The file is closed. - An I/O error occurred. - - - - - - - - - - Method - - System.Runtime - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - - [System.Runtime.CompilerServices.NullableContext(1)] - [<System.Runtime.CompilerServices.NullableContext(1)>] - - - - System.Int64 - - - - - - The file handle. - Gets the length of the file in bytes. - A long value representing the length of the file in bytes. - To be added. - - is . - - is invalid. - The file is closed. - The file does not support seeking (pipe or socket). - - - - - - - - - - Method - - System.Runtime - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - - [System.Runtime.CompilerServices.NullableContext(1)] - [<System.Runtime.CompilerServices.NullableContext(1)>] - - - - System.Int64 - - - - - - - [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 1, 0 })] - [<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 1, 0 })>] - - - - - - - The file handle. - A list of memory buffers. When this method returns, the contents of the buffers are replaced by the bytes read from the file. - The file position to read from. - Reads a sequence of bytes from given file at given offset. - The total number of bytes read into the buffers. This can be less than the number of bytes allocated in the buffers if that many bytes are not currently available, or zero (0) if the end of the file has been reached. - + + + + is . + + is invalid. + The file is closed. + An I/O error occurred. + + + + + + + + + + Method + + System.Runtime + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + + [System.Runtime.CompilerServices.NullableContext(1)] + [<System.Runtime.CompilerServices.NullableContext(1)>] + + + + System.Int64 + + + + + + The file handle. + Gets the length of the file in bytes. + A long value representing the length of the file in bytes. + To be added. + + is . + + is invalid. + The file is closed. + The file does not support seeking (pipe or socket). + + + + + + + + + + Method + + System.Runtime + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + + [System.Runtime.CompilerServices.NullableContext(1)] + [<System.Runtime.CompilerServices.NullableContext(1)>] + + + + System.Int64 + + + + + + + [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 1, 0 })] + [<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 1, 0 })>] + + + + + + + The file handle. + A list of memory buffers. When this method returns, the contents of the buffers are replaced by the bytes read from the file. + The file position to read from. + Reads a sequence of bytes from given file at given offset. + The total number of bytes read into the buffers. This can be less than the number of bytes allocated in the buffers if that many bytes are not currently available, or zero (0) if the end of the file has been reached. + - - - or is . - - is invalid. - The file is closed. - The file does not support seeking (pipe or socket). - - is negative. - - was not opened for reading. - An I/O error occurred. - - - - - - - - - - Method - - System.Runtime - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - System.Int32 - - - - - - [System.Runtime.CompilerServices.Nullable(1)] - [<System.Runtime.CompilerServices.Nullable(1)>] - - - - - - - - The file handle. - A region of memory. When this method returns, the contents of this region are replaced by the bytes read from the file. - The file position to read from. - Reads a sequence of bytes from given file at given offset. - 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 file has been reached. - + ]]> + + + or is . + + is invalid. + The file is closed. + The file does not support seeking (pipe or socket). + + is negative. + + was not opened for reading. + An I/O error occurred. + + + + + + + + + + Method + + System.Runtime + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + System.Int32 + + + + + + [System.Runtime.CompilerServices.Nullable(1)] + [<System.Runtime.CompilerServices.Nullable(1)>] + + + + + + + + The file handle. + A region of memory. When this method returns, the contents of this region are replaced by the bytes read from the file. + The file position to read from. + Reads a sequence of bytes from given file at given offset. + 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 file has been reached. + - - - is . - - is invalid. - The file is closed. - The file does not support seeking (pipe or socket). - - is negative. - - was not opened for reading. - An I/O error occurred. - - - - - - - - - Method - - System.Runtime - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - System.Threading.Tasks.ValueTask<System.Int64> - - - - - - [System.Runtime.CompilerServices.Nullable(1)] - [<System.Runtime.CompilerServices.Nullable(1)>] - - - - - - - [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 1, 0 })] - [<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 1, 0 })>] - - - - - - - - The file handle. - A list of memory buffers. When this method returns, the contents of these buffers are replaced by the bytes read from the file. - The file position to read from. - The token to monitor for cancellation requests. The default value is . - Reads a sequence of bytes from given file at given offset. - The total number of bytes read into the buffers. This can be less than the number of bytes allocated in the buffers if that many bytes are not currently available, or zero (0) if the end of the file has been reached. - + ]]> + + + is . + + is invalid. + The file is closed. + The file does not support seeking (pipe or socket). + + is negative. + + was not opened for reading. + An I/O error occurred. + + + + + + + + + Method + + System.Runtime + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + System.Threading.Tasks.ValueTask<System.Int64> + + + + + + [System.Runtime.CompilerServices.Nullable(1)] + [<System.Runtime.CompilerServices.Nullable(1)>] + + + + + + + [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 1, 0 })] + [<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 1, 0 })>] + + + + + + + + The file handle. + A list of memory buffers. When this method returns, the contents of these buffers are replaced by the bytes read from the file. + The file position to read from. + The token to monitor for cancellation requests. The default value is . + Reads a sequence of bytes from given file at given offset. + The total number of bytes read into the buffers. This can be less than the number of bytes allocated in the buffers if that many bytes are not currently available, or zero (0) if the end of the file has been reached. + , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . -]]> - - - or is . - - is invalid. - The file is closed. - The file does not support seeking (pipe or socket). - - is negative. - - was not opened for reading. - An I/O error occurred. - - - - - - - - - Method - - System.Runtime - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - System.Threading.Tasks.ValueTask<System.Int32> - - - - - - [System.Runtime.CompilerServices.Nullable(1)] - [<System.Runtime.CompilerServices.Nullable(1)>] - - - - - - - - - The file handle. - A region of memory. When this method returns, the contents of this region are replaced by the bytes read from the file. - The file position to read from. - The token to monitor for cancellation requests. The default value is . - Reads a sequence of bytes from given file at given offset. - 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 file has been reached. - +]]> + + + or is . + + is invalid. + The file is closed. + The file does not support seeking (pipe or socket). + + is negative. + + was not opened for reading. + An I/O error occurred. + The cancellation token was canceled. This exception is stored into the returned task. + + + + + + + + + Method + + System.Runtime + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + System.Threading.Tasks.ValueTask<System.Int32> + + + + + + [System.Runtime.CompilerServices.Nullable(1)] + [<System.Runtime.CompilerServices.Nullable(1)>] + + + + + + + + + The file handle. + A region of memory. When this method returns, the contents of this region are replaced by the bytes read from the file. + The file position to read from. + The token to monitor for cancellation requests. The default value is . + Reads a sequence of bytes from given file at given offset. + 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 file has been reached. + - - - is . - - is invalid. - The file is closed. - The file does not support seeking (pipe or socket). - - is negative. - - was not opened for reading. - An I/O error occurred. - - - - - - - - - - Method - - System.Runtime - 7.0.0.0 - 8.0.0.0 - - - - [System.Runtime.CompilerServices.NullableContext(1)] - [<System.Runtime.CompilerServices.NullableContext(1)>] - - - - System.Void - - - - - - - The file handle. - The length of the file in bytes. - Sets the length of the file to the given value. - To be added. - - is . - - is invalid. - The file is closed. - The file does not support seeking (pipe or socket). - - is negative. - - - - - - - - - - Method - - System.Runtime - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - - [System.Runtime.CompilerServices.NullableContext(1)] - [<System.Runtime.CompilerServices.NullableContext(1)>] - - - - System.Void - - - - - - - [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 1, 0 })] - [<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 1, 0 })>] - - - - - - - The file handle. - A list of memory buffers. This method copies the contents of these buffers to the file. - The file position to write to. - Writes a sequence of bytes from given buffers to given file at given offset. - To be added. - + ]]> + + + is . + + is invalid. + The file is closed. + The file does not support seeking (pipe or socket). + + is negative. + + was not opened for reading. + An I/O error occurred. + The cancellation token was canceled. This exception is stored into the returned task. + + + + + + + + + + Method + + System.Runtime + 7.0.0.0 + 8.0.0.0 + + + + [System.Runtime.CompilerServices.NullableContext(1)] + [<System.Runtime.CompilerServices.NullableContext(1)>] + + + + System.Void + + + + + + + The file handle. + The length of the file in bytes. + Sets the length of the file to the given value. + To be added. + + is . + + is invalid. + The file is closed. + The file does not support seeking (pipe or socket). + + is negative. + + + + + + + + + + Method + + System.Runtime + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + + [System.Runtime.CompilerServices.NullableContext(1)] + [<System.Runtime.CompilerServices.NullableContext(1)>] + + + + System.Void + + + + + + + [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 1, 0 })] + [<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 1, 0 })>] + + + + + + + The file handle. + A list of memory buffers. This method copies the contents of these buffers to the file. + The file position to write to. + Writes a sequence of bytes from given buffers to given file at given offset. + To be added. + - - - or is . - - is invalid. - The file is closed. - The file does not support seeking (pipe or socket). - - is negative. - - was not opened for writing. - An I/O error occurred. - - - - - - - - - - Method - - System.Runtime - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - System.Void - - - - - - [System.Runtime.CompilerServices.Nullable(1)] - [<System.Runtime.CompilerServices.Nullable(1)>] - - - - - - - - The file handle. - A region of memory. This method copies the contents of this region to the file. - The file position to write to. - Writes a sequence of bytes from given buffer to given file at given offset. - To be added. - + ]]> + + + or is . + + is invalid. + The file is closed. + The file does not support seeking (pipe or socket). + + is negative. + + was not opened for writing. + An I/O error occurred. + + + + + + + + + + Method + + System.Runtime + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + System.Void + + + + + + [System.Runtime.CompilerServices.Nullable(1)] + [<System.Runtime.CompilerServices.Nullable(1)>] + + + + + + + + The file handle. + A region of memory. This method copies the contents of this region to the file. + The file position to write to. + Writes a sequence of bytes from given buffer to given file at given offset. + To be added. + - - - is . - - is invalid. - The file is closed. - The file does not support seeking (pipe or socket). - - is negative. - - was not opened for writing. - An I/O error occurred. - - - - - - - - - Method - - System.Runtime - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - - [System.Runtime.CompilerServices.NullableContext(1)] - [<System.Runtime.CompilerServices.NullableContext(1)>] - - - - System.Threading.Tasks.ValueTask - - - - - - - [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 1, 0 })] - [<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 1, 0 })>] - - - - - - - - The file handle. - A list of memory buffers. This method copies the contents of these buffers to the file. - The file position to write to. - The token to monitor for cancellation requests. The default value is . - Writes a sequence of bytes from given buffers to given file at given offset. - A task representing the asynchronous completion of the write operation. - + ]]> + + + is . + + is invalid. + The file is closed. + The file does not support seeking (pipe or socket). + + is negative. + + was not opened for writing. + An I/O error occurred. + + + + + + + + + Method + + System.Runtime + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + + [System.Runtime.CompilerServices.NullableContext(1)] + [<System.Runtime.CompilerServices.NullableContext(1)>] + + + + System.Threading.Tasks.ValueTask + + + + + + + [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 1, 0 })] + [<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 1, 0 })>] + + + + + + + + The file handle. + A list of memory buffers. This method copies the contents of these buffers to the file. + The file position to write to. + The token to monitor for cancellation requests. The default value is . + Writes a sequence of bytes from given buffers to given file at given offset. + A task representing the asynchronous completion of the write operation. + , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . -]]> - - - or is . - - is invalid. - The file is closed. - The file does not support seeking (pipe or socket). - - is negative. - - was not opened for writing. - An I/O error occurred. - - - - - - - - - Method - - System.Runtime - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - System.Threading.Tasks.ValueTask - - - - - - [System.Runtime.CompilerServices.Nullable(1)] - [<System.Runtime.CompilerServices.Nullable(1)>] - - - - - - - - - The file handle. - A region of memory. This method copies the contents of this region to the file. - The file position to write to. - The token to monitor for cancellation requests. The default value is . - Writes a sequence of bytes from given buffer to given file at given offset. - A task representing the asynchronous completion of the write operation. - +]]> + + + or is . + + is invalid. + The file is closed. + The file does not support seeking (pipe or socket). + + is negative. + + was not opened for writing. + An I/O error occurred. + The cancellation token was canceled. This exception is stored into the returned task. + + + + + + + + + Method + + System.Runtime + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + System.Threading.Tasks.ValueTask + + + + + + [System.Runtime.CompilerServices.Nullable(1)] + [<System.Runtime.CompilerServices.Nullable(1)>] + + + + + + + + + The file handle. + A region of memory. This method copies the contents of this region to the file. + The file position to write to. + The token to monitor for cancellation requests. The default value is . + Writes a sequence of bytes from given buffer to given file at given offset. + A task representing the asynchronous completion of the write operation. + - - - is . - - is invalid. - The file is closed. - The file does not support seeking (pipe or socket). - - is negative. - - was not opened for writing. - An I/O error occurred. - - - - + ]]> + + + is . + + is invalid. + The file is closed. + The file does not support seeking (pipe or socket). + + is negative. + + was not opened for writing. + An I/O error occurred. + 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 bc6565d1e08..a67d46d3644 100644 --- a/xml/System.IO/Stream.xml +++ b/xml/System.IO/Stream.xml @@ -1060,6 +1060,7 @@ ]]> + The cancellation token was canceled. This exception is stored into the returned task. @@ -1138,6 +1139,7 @@ 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. @@ -1738,6 +1740,7 @@ The stream has been disposed. Cancellation + The cancellation token was canceled. This exception is stored into the returned task. @@ -2161,6 +2164,7 @@ ]]> + The cancellation token was canceled. This exception is stored into the returned task. @@ -2326,6 +2330,7 @@ The stream has been disposed. The stream is currently in use by a previous read operation. Cancellation + The cancellation token was canceled. This exception is stored into the returned task. @@ -2446,6 +2451,7 @@ When `minimumBytes` is 0 (zero), this read operation will be completed without w is and the end of the stream is reached before reading bytes of data. + The cancellation token was canceled. This exception is stored into the returned task. @@ -2675,6 +2681,7 @@ When `buffer` is empty, this read operation will be completed without waiting fo ]]> The end of the stream is reached before filling the . + The cancellation token was canceled. This exception is stored into the returned task. @@ -2739,6 +2746,7 @@ This method stores in the task it returns all non-usage exceptions that the meth The range specified by the combination of and exceeds the length of . The end of the stream is reached before reading number of bytes. + The cancellation token was canceled. This exception is stored into the returned task. @@ -3308,6 +3316,7 @@ This member is an explicit interface member implementation. It can be used only ]]> + The cancellation token was canceled. This exception is stored into the returned task. @@ -3473,6 +3482,7 @@ This member is an explicit interface member implementation. It can be used only The stream has been disposed. The stream is currently in use by a previous write operation. Cancellation + 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 bab41954df2..34424c410a8 100644 --- a/xml/System.IO/StreamReader.xml +++ b/xml/System.IO/StreamReader.xml @@ -2012,6 +2012,7 @@ Following a call to , any operations on th Asynchronously reads the characters from the current stream into a memory block. A value task that represents the asynchronous read operation. The value of the type parameter of the value task contains the number of characters that have been read, or 0 if at the end of the stream and no data was read. The number will be less than or equal to the length, depending on whether the data is available within the stream. To be added. + The cancellation token was canceled. This exception is stored into the returned task. @@ -2268,6 +2269,7 @@ Following a call to , any operations on th Asynchronously reads the characters from the current stream and writes the data to a buffer. A value task that represents the asynchronous read operation. The value of the type parameter of the value task contains the total number of characters read into the buffer. The result value can be less than the number of characters requested if the number of characters currently available is less than the requested number, or it can be 0 (zero) if the end of the stream has been reached. To be added. + The cancellation token was canceled. This exception is stored into the returned task. @@ -2553,6 +2555,7 @@ This method stores in the task it returns all non-usage exceptions that the meth The number of characters in the next line is larger than Int32.MaxValue. The stream reader has been disposed. The reader is currently in use by a previous read operation. + The cancellation token was canceled. This exception is stored into the returned task. @@ -2762,6 +2765,7 @@ This method stores in the task it returns all non-usage exceptions that the meth The number of characters is larger than Int32.MaxValue. The stream reader has been disposed. The reader is currently in use by a previous read operation. + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.IO/StreamWriter.xml b/xml/System.IO/StreamWriter.xml index 819ce1b8bd2..42cbd78a7f1 100644 --- a/xml/System.IO/StreamWriter.xml +++ b/xml/System.IO/StreamWriter.xml @@ -1530,6 +1530,7 @@ For a list of common I/O tasks, see [Common I/O Tasks](/dotnet/standard/io/commo Clears all buffers for this stream asynchronously and causes any buffered data to be written to the underlying device. A that represents the asynchronous flush operation. To be added. + The cancellation token was canceled. This exception is stored into the returned task. @@ -2478,6 +2479,7 @@ This method stores in the task it returns all non-usage exceptions that the meth Asynchronously writes a character memory region to the stream. A task that represents the asynchronous write operation. To be added. + The cancellation token was canceled. This exception is stored into the returned task. @@ -3243,6 +3245,7 @@ The line terminator is defined by the fi ]]> + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.IO/StringReader.xml b/xml/System.IO/StringReader.xml index 651e5b07c1a..98d8741e8d9 100644 --- a/xml/System.IO/StringReader.xml +++ b/xml/System.IO/StringReader.xml @@ -700,6 +700,7 @@ This implementation of `Close` calls the Asynchronously reads all the characters from the input string, starting at the current position, and advances the current position to the end of the input string. A task that represents the asynchronous read operation. The value of the parameter contains the total number of characters read into the buffer. To be added. + The cancellation token was canceled. This exception is stored into the returned task. @@ -898,6 +899,7 @@ This implementation of `Close` calls the + The cancellation token was canceled. This exception is stored into the returned task. @@ -1184,6 +1186,7 @@ This method stores in the task it returns all non-usage exceptions that the meth The number of characters in the next line is larger than Int32.MaxValue. The string reader has been disposed. The reader is currently in use by a previous read operation. + The cancellation token was canceled. This exception is stored into the returned task. @@ -1382,6 +1385,7 @@ This method stores in the task it returns all non-usage exceptions that the meth The number of characters is larger than Int32.MaxValue. The string reader has been disposed. The reader is currently in use by a previous read operation. + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.IO/StringWriter.xml b/xml/System.IO/StringWriter.xml index bb98b3aceed..6cc42b7ae30 100644 --- a/xml/System.IO/StringWriter.xml +++ b/xml/System.IO/StringWriter.xml @@ -1524,6 +1524,7 @@ This method stores in the task it returns all non-usage exceptions that the meth Asynchronously writes a memory region of characters to the string. A task that represents the asynchronous write operation. To be added. + The cancellation token was canceled. This exception is stored into the returned task. @@ -1574,6 +1575,7 @@ This method stores in the task it returns all non-usage exceptions that the meth Asynchronously writes the text representation of a string builder to the string. A task that represents the asynchronous write operation. 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 . + The cancellation token was canceled. This exception is stored into the returned task. @@ -1964,6 +1966,7 @@ The following example shows how to write a string by using the Asynchronously writes the string representation of the memory region of characters to the current string, followed by a line terminator. A task that represents the asynchronous write operation. To be added. + The cancellation token was canceled. This exception is stored into the returned task. @@ -2014,6 +2017,7 @@ The following example shows how to write a string by using the Asynchronously writes the string representation of the string builder to the current string, followed by a line terminator. A task that represents the asynchronous write operation. 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 . + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.IO/TextReader.xml b/xml/System.IO/TextReader.xml index b1613641db4..88d1b5ab1ff 100644 --- a/xml/System.IO/TextReader.xml +++ b/xml/System.IO/TextReader.xml @@ -764,6 +764,7 @@ Asynchronously reads the characters from the current stream into a memory block. A value task that represents the asynchronous read operation. The value of the type parameter contains the number of characters that have been read, or 0 if at the end of the stream and no data was read. The number will be less than or equal to the length, depending on whether the data is available within the stream. To be added. + The cancellation token was canceled. This exception is stored into the returned task. @@ -1027,6 +1028,7 @@ Asynchronously reads the characters from the current stream and writes the data to a buffer. A value task that represents the asynchronous read operation. The value of the type parameter contains the total number of characters read into the buffer. The result value can be less than the number of characters requested if the number of characters currently available is less than the requested number, or it can be 0 (zero) if the end of the stream has been reached. To be added. + The cancellation token was canceled. This exception is stored into the returned task. @@ -1316,6 +1318,7 @@ This method stores in the task it returns all non-usage exceptions that the meth The number of characters in the next line is larger than Int32.MaxValue. The text reader has been disposed. The reader is currently in use by a previous read operation. + The cancellation token was canceled. This exception is stored into the returned task. @@ -1512,6 +1515,7 @@ This method stores in the task it returns all non-usage exceptions that the meth The number of characters is larger than Int32.MaxValue. The text reader has been disposed. The reader is currently in use by a previous read operation. + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.IO/TextWriter.xml b/xml/System.IO/TextWriter.xml index 8309d1d61c3..535efb5a82b 100644 --- a/xml/System.IO/TextWriter.xml +++ b/xml/System.IO/TextWriter.xml @@ -795,6 +795,7 @@ To be added. The text writer is disposed. The writer is currently in use by a previous write operation. + The cancellation token was canceled. This exception is stored into the returned task. @@ -2941,6 +2942,7 @@ This method is equivalent to `Write(stringBuilder.ToString())`, but it uses the Asynchronously writes a character memory region to the text stream. A task that represents the asynchronous write operation. To be added. + The cancellation token was canceled. This exception is stored into the returned task. @@ -3001,6 +3003,7 @@ This method stores in the task it returns all non-usage exceptions that the meth ]]> + The cancellation token was canceled. This exception is stored into the returned task. @@ -5112,6 +5115,7 @@ The line terminator is defined by the fi ]]> + The cancellation token was canceled. This exception is stored into the returned task. @@ -5172,6 +5176,7 @@ This method stores in the task it returns all non-usage exceptions that the meth ]]> + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.IO/UnmanagedMemoryStream.xml b/xml/System.IO/UnmanagedMemoryStream.xml index d9f43e53fe3..8b0ce0c5ac8 100644 --- a/xml/System.IO/UnmanagedMemoryStream.xml +++ b/xml/System.IO/UnmanagedMemoryStream.xml @@ -865,6 +865,7 @@ ]]> + The cancellation token was canceled. This exception is stored into the returned task. @@ -1413,6 +1414,7 @@ This method is equivalent to the Asynchronously reads the unmanaged memory stream bytes into the memory region. A task that represents the asynchronous read operation, and wraps the total number of bytes read into the buffer. To be added. + The cancellation token was canceled. This exception is stored into the returned task. @@ -1487,6 +1489,7 @@ This method is equivalent to the + The cancellation token was canceled. This exception is stored into the returned task. @@ -1896,6 +1899,7 @@ If an exception occurs during the write operation, it will be set as the + The cancellation token was canceled. This exception is stored into the returned task. @@ -1970,6 +1974,7 @@ If an exception occurs during the write operation, it will be set as the + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.Net.Http.Json/HttpClientJsonExtensions.xml b/xml/System.Net.Http.Json/HttpClientJsonExtensions.xml index d69252714d4..8c147891b55 100644 --- a/xml/System.Net.Http.Json/HttpClientJsonExtensions.xml +++ b/xml/System.Net.Http.Json/HttpClientJsonExtensions.xml @@ -82,6 +82,7 @@ The task object representing the asynchronous operation. To be added. The is . + The cancellation token was canceled. This exception is stored into the returned task. @@ -131,6 +132,7 @@ The task object representing the asynchronous operation. To be added. The is . + The cancellation token was canceled. This exception is stored into the returned task. @@ -193,6 +195,7 @@ The task object representing the asynchronous operation. To be added. The is . + The cancellation token was canceled. This exception is stored into the returned task. @@ -238,6 +241,7 @@ The task object representing the asynchronous operation. To be added. The is . + The cancellation token was canceled. This exception is stored into the returned task. @@ -296,6 +300,7 @@ The task object representing the asynchronous operation. To be added. The is . + The cancellation token was canceled. This exception is stored into the returned task. @@ -337,6 +342,7 @@ The task object representing the asynchronous operation. To be added. The is . + The cancellation token was canceled. This exception is stored into the returned task. @@ -399,6 +405,7 @@ The task object representing the asynchronous operation. To be added. The is . + The cancellation token was canceled. This exception is stored into the returned task. @@ -454,6 +461,7 @@ The task object representing the asynchronous operation. To be added. The is . + The cancellation token was canceled. This exception is stored into the returned task. @@ -518,6 +526,7 @@ The task object representing the asynchronous operation. To be added. The is . + The cancellation token was canceled. This exception is stored into the returned task. @@ -572,6 +581,7 @@ The task object representing the asynchronous operation. To be added. The is . + The cancellation token was canceled. This exception is stored into the returned task. @@ -629,6 +639,7 @@ The task object representing the asynchronous operation. To be added. The is . + The cancellation token was canceled. This exception is stored into the returned task. @@ -679,6 +690,7 @@ The task object representing the asynchronous operation. To be added. The is . + The cancellation token was canceled. This exception is stored into the returned task. @@ -746,6 +758,7 @@ An that represents the deserialized response body. To be added. The is . + The cancellation token was canceled. This exception is stored into the returned task. @@ -806,6 +819,7 @@ An that represents the deserialized response body. To be added. The is . + The cancellation token was canceled. This exception is stored into the returned task. @@ -875,6 +889,7 @@ An that represents the deserialized response body. To be added. The is . + The cancellation token was canceled. This exception is stored into the returned task. @@ -934,6 +949,7 @@ An that represents the deserialized response body. To be added. The is . + The cancellation token was canceled. This exception is stored into the returned task. @@ -996,6 +1012,7 @@ An that represents the deserialized response body. To be added. The is . + The cancellation token was canceled. This exception is stored into the returned task. @@ -1051,6 +1068,7 @@ An that represents the deserialized response body. To be added. The is . + The cancellation token was canceled. This exception is stored into the returned task. @@ -1113,6 +1131,7 @@ This method uses + The cancellation token was canceled. This exception is stored into the returned task. @@ -1171,6 +1190,7 @@ This method uses + The cancellation token was canceled. This exception is stored into the returned task. @@ -1234,6 +1254,7 @@ This method uses Sends a GET request to the specified Uri and returns the value that results from deserializing the response body as JSON in an asynchronous operation. The task object representing the asynchronous operation. To be added. + The cancellation token was canceled. This exception is stored into the returned task. @@ -1279,6 +1300,7 @@ This method uses Sends a GET request to the specified Uri and returns the value that results from deserializing the response body as JSON in an asynchronous operation. The task object representing the asynchronous operation. To be added. + The cancellation token was canceled. This exception is stored into the returned task. @@ -1338,6 +1360,7 @@ This method uses Sends a GET request to the specified Uri and returns the value that results from deserializing the response body as JSON in an asynchronous operation. The task object representing the asynchronous operation. To be added. + The cancellation token was canceled. This exception is stored into the returned task. @@ -1379,6 +1402,7 @@ This method uses Sends a GET request to the specified Uri and returns the value that results from deserializing the response body as JSON in an asynchronous operation. The task object representing the asynchronous operation. To be added. + The cancellation token was canceled. This exception is stored into the returned task. @@ -1450,6 +1474,7 @@ This method uses + The cancellation token was canceled. This exception is stored into the returned task. @@ -1514,6 +1539,7 @@ This method uses + The cancellation token was canceled. This exception is stored into the returned task. @@ -1579,6 +1605,7 @@ This method uses Sends a GET request to the specified Uri and returns the value that results from deserializing the response body as JSON in an asynchronous operation. The task object representing the asynchronous operation. To be added. + The cancellation token was canceled. This exception is stored into the returned task. @@ -1633,6 +1660,7 @@ This method uses Sends a GET request to the specified Uri and returns the value that results from deserializing the response body as JSON in an asynchronous operation. The task object representing the asynchronous operation. To be added. + The cancellation token was canceled. This exception is stored into the returned task. @@ -1691,6 +1719,7 @@ This method uses Sends a GET request to the specified Uri and returns the value that results from deserializing the response body as JSON in an asynchronous operation. The task object representing the asynchronous operation. To be added. + The cancellation token was canceled. This exception is stored into the returned task. @@ -1741,6 +1770,7 @@ This method uses Sends a GET request to the specified Uri and returns the value that results from deserializing the response body as JSON in an asynchronous operation. The task object representing the asynchronous operation. To be added. + The cancellation token was canceled. This exception is stored into the returned task. @@ -1806,6 +1836,7 @@ This method uses The task object representing the asynchronous operation. To be added. The is . + The cancellation token was canceled. This exception is stored into the returned task. @@ -1867,6 +1898,7 @@ This method uses The task object representing the asynchronous operation. To be added. The is . + The cancellation token was canceled. This exception is stored into the returned task. @@ -1940,6 +1972,7 @@ This method uses The task object representing the asynchronous operation. To be added. The is . + The cancellation token was canceled. This exception is stored into the returned task. @@ -1996,6 +2029,7 @@ This method uses The task object representing the asynchronous operation. To be added. The is . + The cancellation token was canceled. This exception is stored into the returned task. @@ -2065,6 +2099,7 @@ This method uses The task object representing the asynchronous operation. To be added. The is . + The cancellation token was canceled. This exception is stored into the returned task. @@ -2117,6 +2152,7 @@ This method uses The task object representing the asynchronous operation. To be added. The is . + The cancellation token was canceled. This exception is stored into the returned task. @@ -2191,6 +2227,7 @@ This method uses + The cancellation token was canceled. This exception is stored into the returned task. @@ -2261,6 +2298,7 @@ This method uses + The cancellation token was canceled. This exception is stored into the returned task. @@ -2335,6 +2373,7 @@ This method uses Sends a POST request to the specified Uri containing the serialized as JSON in the request body. The task object representing the asynchronous operation. To be added. + The cancellation token was canceled. This exception is stored into the returned task. @@ -2391,6 +2430,7 @@ This method uses Sends a POST request to the specified Uri containing the serialized as JSON in the request body. The task object representing the asynchronous operation. To be added. + The cancellation token was canceled. This exception is stored into the returned task. @@ -2461,6 +2501,7 @@ This method uses Sends a POST request to the specified Uri containing the serialized as JSON in the request body. The task object representing the asynchronous operation. To be added. + The cancellation token was canceled. This exception is stored into the returned task. @@ -2513,6 +2554,7 @@ This method uses Sends a POST request to the specified Uri containing the serialized as JSON in the request body. The task object representing the asynchronous operation. To be added. + The cancellation token was canceled. This exception is stored into the returned task. @@ -2587,6 +2629,7 @@ This method uses + The cancellation token was canceled. This exception is stored into the returned task. @@ -2657,6 +2700,7 @@ This method uses + The cancellation token was canceled. This exception is stored into the returned task. @@ -2731,6 +2775,7 @@ This method uses Send a PUT request to the specified Uri containing the serialized as JSON in the request body. The task object representing the asynchronous operation. To be added. + The cancellation token was canceled. This exception is stored into the returned task. @@ -2787,6 +2832,7 @@ This method uses Send a PUT request to the specified Uri containing the serialized as JSON in the request body. The task object representing the asynchronous operation. To be added. + The cancellation token was canceled. This exception is stored into the returned task. @@ -2857,6 +2903,7 @@ This method uses Send a PUT request to the specified Uri containing the serialized as JSON in the request body. The task object representing the asynchronous operation. To be added. + The cancellation token was canceled. This exception is stored into the returned task. @@ -2909,6 +2956,7 @@ This method uses Send a PUT request to the specified Uri containing the serialized as JSON in the request body. The task object representing the asynchronous operation. To be added. + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.Net.Http.Json/HttpContentJsonExtensions.xml b/xml/System.Net.Http.Json/HttpContentJsonExtensions.xml index 7c640fe2c4d..9834561aedf 100644 --- a/xml/System.Net.Http.Json/HttpContentJsonExtensions.xml +++ b/xml/System.Net.Http.Json/HttpContentJsonExtensions.xml @@ -83,6 +83,7 @@ An that represents the deserialized response body. To be added. The is . + The cancellation token was canceled. This exception is stored into the returned task. @@ -144,6 +145,7 @@ An that represents the deserialized response body. To be added. The is . + The cancellation token was canceled. This exception is stored into the returned task. @@ -190,6 +192,7 @@ An that represents the deserialized response body. To be added. The is . + The cancellation token was canceled. This exception is stored into the returned task. @@ -234,6 +237,7 @@ Reads the HTTP content and returns the value that results from deserializing the content as JSON in an asynchronous operation. The task object representing the asynchronous operation. To be added. + The cancellation token was canceled. This exception is stored into the returned task. @@ -286,6 +290,7 @@ Reads the HTTP content and returns the value that results from deserializing the content as JSON in an asynchronous operation. The task object representing the asynchronous operation. To be added. + The cancellation token was canceled. This exception is stored into the returned task. @@ -318,6 +323,7 @@ Reads the HTTP content and returns the value that results from deserializing the content as JSON in an asynchronous operation. The task object representing the asynchronous operation. To be added. + The cancellation token was canceled. This exception is stored into the returned task. @@ -371,6 +377,7 @@ Reads the HTTP content and returns the value that results from deserializing the content as JSON in an asynchronous operation. The task object representing the asynchronous operation. To be added. + The cancellation token was canceled. This exception is stored into the returned task. @@ -429,6 +436,7 @@ Reads the HTTP content and returns the value that results from deserializing the content as JSON in an asynchronous operation. The task object representing the asynchronous operation. To be added. + The cancellation token was canceled. This exception is stored into the returned task. @@ -470,6 +478,7 @@ Reads the HTTP content and returns the value that results from deserializing the content as JSON in an asynchronous operation. The task object representing the asynchronous operation. To be added. + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.Net.Http.Json/JsonContent.xml b/xml/System.Net.Http.Json/JsonContent.xml index df186a73385..4c0e08e5be1 100644 --- a/xml/System.Net.Http.Json/JsonContent.xml +++ b/xml/System.Net.Http.Json/JsonContent.xml @@ -294,6 +294,7 @@ To be added. To be added. To be added. + The cancellation token was canceled. This exception is stored into the returned task. @@ -370,6 +371,7 @@ To be added. To be added. To be added. + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.Net.Http/ByteArrayContent.xml b/xml/System.Net.Http/ByteArrayContent.xml index d1d589243af..9fe0599f43f 100644 --- a/xml/System.Net.Http/ByteArrayContent.xml +++ b/xml/System.Net.Http/ByteArrayContent.xml @@ -194,6 +194,7 @@ The class does not internally copy the p Creates an HTTP content stream for reading. It uses the memory from the as a backing store. The HTTP content stream. To be added. + The cancellation token was canceled. This exception is stored into the returned task. @@ -278,6 +279,7 @@ The class does not internally copy the p The cancellation token to cancel the operation. Serializes and writes the byte array provided in the constructor to an HTTP content stream. To be added. + The cancellation token was canceled. This exception is stored into the returned task. @@ -387,6 +389,7 @@ The class does not internally copy the p ]]> + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.Net.Http/CFNetworkHandler.xml b/xml/System.Net.Http/CFNetworkHandler.xml index a703e3e89b8..40ff44a34b5 100644 --- a/xml/System.Net.Http/CFNetworkHandler.xml +++ b/xml/System.Net.Http/CFNetworkHandler.xml @@ -132,6 +132,7 @@ To be added. To be added. To be added. + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.Net.Http/DelegatingHandler.xml b/xml/System.Net.Http/DelegatingHandler.xml index b9905ad4599..b5a82f176e4 100644 --- a/xml/System.Net.Http/DelegatingHandler.xml +++ b/xml/System.Net.Http/DelegatingHandler.xml @@ -279,6 +279,7 @@ ]]> + The cancellation token was canceled. This exception is stored into the returned task. @@ -330,6 +331,7 @@ ]]> The was . + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.Net.Http/FormUrlEncodedContent.xml b/xml/System.Net.Http/FormUrlEncodedContent.xml index 91ea6a03ea5..fc15c46db1c 100644 --- a/xml/System.Net.Http/FormUrlEncodedContent.xml +++ b/xml/System.Net.Http/FormUrlEncodedContent.xml @@ -134,6 +134,7 @@ ]]> + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.Net.Http/HttpClient.xml b/xml/System.Net.Http/HttpClient.xml index 3a3414065aa..060ffee389b 100644 --- a/xml/System.Net.Http/HttpClient.xml +++ b/xml/System.Net.Http/HttpClient.xml @@ -867,6 +867,7 @@ The is not an absolute URI. is not set. The request failed due to an underlying issue such as network connectivity, DNS failure, server certificate validation or timeout. .NET Core and .NET 5 and later only: The request failed due to timeout. + The cancellation token was canceled. This exception is stored into the returned task. @@ -939,6 +940,7 @@ The is not an absolute URI. is not set. The request failed due to an underlying issue such as network connectivity, DNS failure, server certificate validation or timeout. .NET Core and .NET 5 and later only: The request failed due to timeout. + The cancellation token was canceled. This exception is stored into the returned task. @@ -1275,6 +1277,7 @@ The is not an absolute URI. The request failed due to an underlying issue such as network connectivity, DNS failure, server certificate validation or timeout. .NET Core and .NET 5 and later only: The request failed due to timeout. The provided request URI is not valid relative or absolute URI. + The cancellation token was canceled. This exception is stored into the returned task. @@ -1403,6 +1406,7 @@ The is not an absolute URI. The must be an absolute URI or must be set. The request failed due to an underlying issue such as network connectivity, DNS failure, server certificate validation or timeout. .NET Core and .NET 5 and later only: The request failed due to timeout. + The cancellation token was canceled. This exception is stored into the returned task. @@ -1474,6 +1478,7 @@ The is not an absolute URI. The request failed due to an underlying issue such as network connectivity, DNS failure, server certificate validation or timeout. .NET Core and .NET 5 and later only: The request failed due to timeout. The provided request URI is not valid relative or absolute URI. + The cancellation token was canceled. This exception is stored into the returned task. @@ -1540,6 +1545,7 @@ The is not an absolute URI. The must be an absolute URI or must be set. The request failed due to an underlying issue such as network connectivity, DNS failure, server certificate validation or timeout. .NET Core and .NET 5 and later only: The request failed due to timeout. + The cancellation token was canceled. This exception is stored into the returned task. @@ -1761,6 +1767,7 @@ The is not an absolute URI. The request failed due to an underlying issue such as network connectivity, DNS failure, server certificate validation (or timeout for .NET Framework only). .NET Core and .NET 5 and later only: The request failed due to timeout. The provided request URI is not valid relative or absolute URI. + The cancellation token was canceled. This exception is stored into the returned task. @@ -1816,6 +1823,7 @@ The is not an absolute URI. The request failed due to an underlying issue such as network connectivity, DNS failure, server certificate validation (or timeout for .NET Framework only). .NET Core and .NET 5 and later only: The request failed due to timeout. + The cancellation token was canceled. This exception is stored into the returned task. @@ -2032,6 +2040,7 @@ The is not an absolute URI. > - .NET 5 and later versions throw a that nests a . ]]> + The cancellation token was canceled. This exception is stored into the returned task. The is . The request failed due to an underlying issue such as network connectivity, DNS failure, server certificate validation (or timeout for .NET Framework only). @@ -2091,6 +2100,7 @@ The is not an absolute URI. The is . The request failed due to an underlying issue such as network connectivity, DNS failure, server certificate validation (or timeout for .NET Framework only). .NET Core and .NET 5 and later only: The request failed due to timeout. + The cancellation token was canceled. This exception is stored into the returned task. @@ -2311,6 +2321,7 @@ The is not an absolute URI. The request failed due to an underlying issue such as network connectivity, DNS failure, server certificate validation (or timeout for .NET Framework only). .NET Core and .NET 5 and later only: The request failed due to timeout. The provided request URI is not valid relative or absolute URI. + The cancellation token was canceled. This exception is stored into the returned task. @@ -2366,6 +2377,7 @@ The is not an absolute URI. The is . The request failed due to an underlying issue such as network connectivity, DNS failure, server certificate validation (or timeout for .NET Framework only). .NET Core and .NET 5 and later only: The request failed due to timeout. + The cancellation token was canceled. This exception is stored into the returned task. @@ -2582,6 +2594,7 @@ The is not an absolute URI. ]]> The provided request URI is not valid relative or absolute URI. + The cancellation token was canceled. This exception is stored into the returned task. @@ -2635,6 +2648,7 @@ The is not an absolute URI. ]]> + The cancellation token was canceled. This exception is stored into the returned task. @@ -2864,6 +2878,7 @@ The is not an absolute URI. The request failed due to an underlying issue such as network connectivity, DNS failure, server certificate validation or timeout. .NET Core and .NET 5 and later only: The request failed due to timeout. The provided request URI is not valid relative or absolute URI. + The cancellation token was canceled. This exception is stored into the returned task. @@ -2930,6 +2945,7 @@ The is not an absolute URI. The must be an absolute URI or must be set. The request failed due to an underlying issue such as network connectivity, DNS failure, server certificate validation or timeout. .NET Core and .NET 5 and later only: The request failed due to timeout. + The cancellation token was canceled. This exception is stored into the returned task. @@ -3159,6 +3175,7 @@ The is not an absolute URI. The request failed due to an underlying issue such as network connectivity, DNS failure, server certificate validation or timeout. .NET Core and .NET 5 and later only: The request failed due to timeout. The provided request URI is not valid relative or absolute URI. + The cancellation token was canceled. This exception is stored into the returned task. @@ -3225,6 +3242,7 @@ The is not an absolute URI. The must be an absolute URI or must be set. The request failed due to an underlying issue such as network connectivity, DNS failure, server certificate validation or timeout. .NET Core and .NET 5 and later only: The request failed due to timeout. + The cancellation token was canceled. This exception is stored into the returned task. @@ -3386,6 +3404,7 @@ The custom does not override If the exception nests the : The request failed due to timeout. + The cancellation token was canceled. This exception is stored into the returned task. @@ -3445,6 +3464,7 @@ The custom does not override If the exception nests the : The request failed due to timeout. + The cancellation token was canceled. This exception is stored into the returned task. @@ -3642,6 +3662,7 @@ This method stores in the task it returns all non-usage exceptions that the meth The request message was already sent by the instance. The request failed due to an underlying issue such as network connectivity, DNS failure, server certificate validation or timeout. .NET Core and .NET 5 and later only: The request failed due to timeout. + The cancellation token was canceled. This exception is stored into the returned task. @@ -3704,6 +3725,7 @@ This method stores in the task it returns all non-usage exceptions that the meth The request message was already sent by the instance. The request failed due to an underlying issue such as network connectivity, DNS failure, server certificate validation or timeout. .NET Core and .NET 5 and later only: The request failed due to timeout. + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.Net.Http/HttpClientHandler.xml b/xml/System.Net.Http/HttpClientHandler.xml index 1fd43061b15..f121fbf9901 100644 --- a/xml/System.Net.Http/HttpClientHandler.xml +++ b/xml/System.Net.Http/HttpClientHandler.xml @@ -1084,6 +1084,7 @@ handler.ServerCertificateCustomValidationCallback = HttpClientHandler.DangerousA If the exception nests the : The request failed due to timeout. + The cancellation token was canceled. This exception is stored into the returned task. @@ -1143,6 +1144,7 @@ handler.ServerCertificateCustomValidationCallback = HttpClientHandler.DangerousA ]]> The was . + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.Net.Http/HttpContent.xml b/xml/System.Net.Http/HttpContent.xml index ade7c1dd05e..9cbf3da95f0 100644 --- a/xml/System.Net.Http/HttpContent.xml +++ b/xml/System.Net.Http/HttpContent.xml @@ -157,6 +157,7 @@ If the content has been previously buffered, for example, by calling The was . + The cancellation token was canceled. This exception is stored into the returned task. @@ -322,6 +323,7 @@ If the content has been previously buffered, for example, by calling + The cancellation token was canceled. This exception is stored into the returned task. @@ -371,6 +373,7 @@ If the content has been previously buffered, for example, by calling + The cancellation token was canceled. This exception is stored into the returned task. @@ -413,6 +416,7 @@ Once the operation completes, the returned memory stream represents the HTTP con ]]> + The cancellation token was canceled. This exception is stored into the returned task. @@ -508,6 +512,7 @@ Once the operation completes, the returned memory stream represents the HTTP con ]]> + The cancellation token was canceled. This exception is stored into the returned task. @@ -856,6 +861,7 @@ When the `disposing` parameter is `true`, this method releases all resources hel ]]> + The cancellation token was canceled. This exception is stored into the returned task. @@ -935,6 +941,7 @@ When the `disposing` parameter is `true`, this method releases all resources hel Serializes the HTTP content and returns a stream that represents the content. The stream that represents the HTTP content. To be added. + The cancellation token was canceled. This exception is stored into the returned task. @@ -1050,6 +1057,7 @@ When the `disposing` parameter is `true`, this method releases all resources hel ]]> + The cancellation token was canceled. This exception is stored into the returned task. @@ -1145,6 +1153,7 @@ When the `disposing` parameter is `true`, this method releases all resources hel ]]> + The cancellation token was canceled. This exception is stored into the returned task. @@ -1187,6 +1196,7 @@ When the `disposing` parameter is `true`, this method releases all resources hel When overridden in a derived class, serializes the HTTP content to a stream. Otherwise, throws a . To be added. The method is not overridden in the derived class. + The cancellation token was canceled. This exception is stored into the returned task. @@ -1296,6 +1306,7 @@ When the `disposing` parameter is `true`, this method releases all resources hel ]]> + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.Net.Http/HttpMessageHandler.xml b/xml/System.Net.Http/HttpMessageHandler.xml index 572546dbbc3..5b027b303f5 100644 --- a/xml/System.Net.Http/HttpMessageHandler.xml +++ b/xml/System.Net.Http/HttpMessageHandler.xml @@ -228,6 +228,7 @@ When the `disposing` parameter is `true`, this method releases all resources hel The HTTP response message. To be added. The method is not overridden in the derived class. + The cancellation token was canceled. This exception is stored into the returned task. @@ -285,6 +286,7 @@ When the `disposing` parameter is `true`, this method releases all resources hel ]]> The was . + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.Net.Http/HttpMessageInvoker.xml b/xml/System.Net.Http/HttpMessageInvoker.xml index 1ef8aa25414..fbdf7cc209a 100644 --- a/xml/System.Net.Http/HttpMessageInvoker.xml +++ b/xml/System.Net.Http/HttpMessageInvoker.xml @@ -282,6 +282,7 @@ -or- If using custom not overriding method. + The cancellation token was canceled. This exception is stored into the returned task. @@ -333,6 +334,7 @@ ]]> The was . + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.Net.Http/MessageProcessingHandler.xml b/xml/System.Net.Http/MessageProcessingHandler.xml index 9f6d528f376..67ec07d563d 100644 --- a/xml/System.Net.Http/MessageProcessingHandler.xml +++ b/xml/System.Net.Http/MessageProcessingHandler.xml @@ -181,6 +181,7 @@ ]]> + The cancellation token was canceled. This exception is stored into the returned task. @@ -229,6 +230,7 @@ ]]> + The cancellation token was canceled. This exception is stored into the returned task. @@ -262,6 +264,7 @@ Sends an HTTP request to the inner handler to send to the server. The HTTP response message. To be added. + The cancellation token was canceled. This exception is stored into the returned task. @@ -317,6 +320,7 @@ ]]> The was . + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.Net.Http/MultipartContent.xml b/xml/System.Net.Http/MultipartContent.xml index 23e16ebca3c..9f93821f14a 100644 --- a/xml/System.Net.Http/MultipartContent.xml +++ b/xml/System.Net.Http/MultipartContent.xml @@ -254,6 +254,7 @@ This method overrides + The cancellation token was canceled. This exception is stored into the returned task. @@ -338,6 +339,7 @@ This method overrides + The cancellation token was canceled. This exception is stored into the returned task. @@ -510,6 +512,7 @@ When the `disposing` parameter is `true`, this method releases all resources hel The cancellation token to cancel the operation. Serializes the multipart HTTP content to a stream. To be added. + The cancellation token was canceled. This exception is stored into the returned task. @@ -625,6 +628,7 @@ When the `disposing` parameter is `true`, this method releases all resources hel ]]> + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.Net.Http/MultipartFormDataContent.xml b/xml/System.Net.Http/MultipartFormDataContent.xml index addd6e145dc..df37f1b3704 100644 --- a/xml/System.Net.Http/MultipartFormDataContent.xml +++ b/xml/System.Net.Http/MultipartFormDataContent.xml @@ -327,6 +327,7 @@ ]]> + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.Net.Http/NSUrlSessionHandler.xml b/xml/System.Net.Http/NSUrlSessionHandler.xml index 96b3fc26767..0d9d04f243b 100644 --- a/xml/System.Net.Http/NSUrlSessionHandler.xml +++ b/xml/System.Net.Http/NSUrlSessionHandler.xml @@ -160,6 +160,7 @@ Sends an HTTP request as an asynchronous operation. The task object representing the asynchronous operation. This operation is does not block. It returns an instance of  to represent the asynchronous operation. When the operation completes, contains the response message. + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.Net.Http/ReadOnlyMemoryContent.xml b/xml/System.Net.Http/ReadOnlyMemoryContent.xml index 62ef8127572..ec53abc86bb 100644 --- a/xml/System.Net.Http/ReadOnlyMemoryContent.xml +++ b/xml/System.Net.Http/ReadOnlyMemoryContent.xml @@ -108,6 +108,7 @@ To be added. To be added. To be added. + The cancellation token was canceled. This exception is stored into the returned task. @@ -180,6 +181,7 @@ The cancellation token to cancel the operation. Serializes the multipart HTTP content to a stream. To be added. + The cancellation token was canceled. This exception is stored into the returned task. @@ -266,6 +268,7 @@ To be added. To be added. To be added. + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.Net.Http/SocketsHttpHandler.xml b/xml/System.Net.Http/SocketsHttpHandler.xml index 424bcb96c20..39187399c7d 100644 --- a/xml/System.Net.Http/SocketsHttpHandler.xml +++ b/xml/System.Net.Http/SocketsHttpHandler.xml @@ -1086,6 +1086,7 @@ Draining occurs when a request is cancelled or a response is disposed prior to f -or- If using custom not overriding method. + The cancellation token was canceled. This exception is stored into the returned task. @@ -1124,6 +1125,7 @@ Draining occurs when a request is cancelled or a response is disposed prior to f Sends an HTTP request as an asynchronous operation. The task object representing the asynchronous operation. To be added. + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.Net.Http/StreamContent.xml b/xml/System.Net.Http/StreamContent.xml index 7c8fbb7368b..e2fd70444cd 100644 --- a/xml/System.Net.Http/StreamContent.xml +++ b/xml/System.Net.Http/StreamContent.xml @@ -178,6 +178,7 @@ The object calls Returns the HTTP stream as a read-only stream. The HTTP content stream. To be added. + The cancellation token was canceled. This exception is stored into the returned task. @@ -303,6 +304,7 @@ When the `disposing` parameter is `true`, this method releases all resources hel The cancellation token to cancel the operation. Serializes the multipart HTTP content to a stream. To be added. + The cancellation token was canceled. This exception is stored into the returned task. @@ -412,6 +414,7 @@ When the `disposing` parameter is `true`, this method releases all resources hel ]]> + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.Net.Http/StringContent.xml b/xml/System.Net.Http/StringContent.xml index adbca8e9549..26827fae604 100644 --- a/xml/System.Net.Http/StringContent.xml +++ b/xml/System.Net.Http/StringContent.xml @@ -312,6 +312,7 @@ ]]> + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.Net.Http/WinHttpHandler.xml b/xml/System.Net.Http/WinHttpHandler.xml index e37699792d1..6cf77b7b272 100644 --- a/xml/System.Net.Http/WinHttpHandler.xml +++ b/xml/System.Net.Http/WinHttpHandler.xml @@ -854,6 +854,7 @@ When this property is set to `true`, all HTTP redirect responses from the server Sends an HTTP request as an asynchronous operation. The task object representing the asynchronous operation. To be added. + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.Net.Mail/SmtpClient.xml b/xml/System.Net.Mail/SmtpClient.xml index 228b76e3c2c..e804aed2910 100644 --- a/xml/System.Net.Mail/SmtpClient.xml +++ b/xml/System.Net.Mail/SmtpClient.xml @@ -1902,6 +1902,7 @@ The classes shown in the following table are used to construct email messages th The could not be delivered to one or more of the recipients in , , or . The could not be delivered to one of the recipients in , , or . The could not be delivered to two or more of the recipients in , , or . + The cancellation token was canceled. This exception is stored into the returned task. @@ -2145,6 +2146,7 @@ The classes shown in the following table are used to construct email messages th The could not be delivered to one or more of the recipients in , , or . The could not be delivered to one of the recipients in , , or . The could not be delivered to two or more of the recipients in , , or . + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.Net.NetworkInformation/Ping.xml b/xml/System.Net.NetworkInformation/Ping.xml index 37ebfd2f0d4..c8267871f97 100644 --- a/xml/System.Net.NetworkInformation/Ping.xml +++ b/xml/System.Net.NetworkInformation/Ping.xml @@ -2499,6 +2499,7 @@ The IP address returned by any of the Sends an Internet Control Message Protocol (ICMP) echo message with the specified data buffer to the computer that has the specified , and receives a corresponding ICMP echo reply message from that computer as an asynchronous operation. This overload allows you to specify a time-out value for the operation, a buffer to use for send and receive, control fragmentation and Time-to-Live values, and a for the ICMP echo message packet. The task object representing the asynchronous operation. To be added. + The cancellation token was canceled. This exception is stored into the returned task. @@ -2548,6 +2549,7 @@ The IP address returned by any of the Sends an Internet Control Message Protocol (ICMP) echo message with the specified data buffer to the specified computer, and receives a corresponding ICMP echo reply message from that computer as an asynchronous operation. This overload allows you to specify a time-out value for the operation, a buffer to use for send and receive, control fragmentation and Time-to-Live values, and a for the ICMP echo message packet. The task object representing the asynchronous operation. To be added. + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.Net.Quic/QuicConnection.xml b/xml/System.Net.Quic/QuicConnection.xml index 3fa470e93a1..cc019ce7028 100644 --- a/xml/System.Net.Quic/QuicConnection.xml +++ b/xml/System.Net.Quic/QuicConnection.xml @@ -69,6 +69,7 @@ For QUIC prerequisites and supported operating systems, see [Platform dependenci Accepts an inbound . An asynchronous task that completes with the accepted . To be added. + The cancellation token was canceled. This exception is stored into the returned task. @@ -107,6 +108,7 @@ If RFC 9000: Connection Termination + The cancellation token was canceled. This exception is stored into the returned task. @@ -134,6 +136,7 @@ If Creates a new and connects it to the peer. An asynchronous task that completes with the connected connection. To be added. + The cancellation token was canceled. This exception is stored into the returned task. @@ -254,6 +257,7 @@ If Creates an outbound unidirectional or bidirectional . An asynchronous task that completes with the opened . If the connection doesn't have any available stream capacity, that is, the peer limits the concurrent stream count, the operation pends until the peer increases the stream limit. + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.Net.Quic/QuicListener.xml b/xml/System.Net.Quic/QuicListener.xml index 59da7075055..7daa0f69f5c 100644 --- a/xml/System.Net.Quic/QuicListener.xml +++ b/xml/System.Net.Quic/QuicListener.xml @@ -77,6 +77,7 @@ This method propagates exceptions from + The cancellation token was canceled. This exception is stored into the returned task. @@ -153,6 +154,7 @@ This method propagates exceptions from Creates a new and starts listening for new connections. An asynchronous task that completes with the started listener. To be added. + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.Net.Quic/QuicStream.xml b/xml/System.Net.Quic/QuicStream.xml index 9f0cd4c6bc1..ddbfc1f494c 100644 --- a/xml/System.Net.Quic/QuicStream.xml +++ b/xml/System.Net.Quic/QuicStream.xml @@ -1,289 +1,289 @@ - - - - - - - - - System.Net.Quic - 7.0.0.0 - 8.0.0.0 - - - System.IO.Stream - - - - - [System.Runtime.CompilerServices.Nullable(0)] - [<System.Runtime.CompilerServices.Nullable(0)>] - - - [System.Runtime.CompilerServices.NullableContext(1)] - [<System.Runtime.CompilerServices.NullableContext(1)>] - - - - Represents a QUIC stream. can be unidirectional, that is, write-only for the opening side, or bidirectional, which allows both sides to write. - + + + + + + + + + System.Net.Quic + 7.0.0.0 + 8.0.0.0 + + + System.IO.Stream + + + + + [System.Runtime.CompilerServices.Nullable(0)] + [<System.Runtime.CompilerServices.Nullable(0)>] + + + [System.Runtime.CompilerServices.NullableContext(1)] + [<System.Runtime.CompilerServices.NullableContext(1)>] + + + + Represents a QUIC stream. can be unidirectional, that is, write-only for the opening side, or bidirectional, which allows both sides to write. + can be used in a same way as any other . Apart from a stream API, also exposes QUIC-specific features: -Closes the writing side of the stream as a single operation with the write itself.Closes the writing side of the stream.Aborts either the writing or the reading side of the stream.Returns a that will complete when the stream writing side has been closed (gracefully or abortively).Returns a that will complete when the stream reading side has been closed (gracefully or abortively). - RFC 9000: Streams - - - - - - - - - - Method - - System.Net.Quic - 7.0.0.0 - 8.0.0.0 - - - System.Void - - - - - - - The direction of the stream to abort. - The error code with which to abort the stream. This value is application-protocol (which is the layer above QUIC) dependent. - Aborts either the reading, writing, or both sides of the stream. - +Closes the writing side of the stream as a single operation with the write itself.Closes the writing side of the stream.Aborts either the writing or the reading side of the stream.Returns a that will complete when the stream writing side has been closed (gracefully or abortively).Returns a that will complete when the stream reading side has been closed (gracefully or abortively). + RFC 9000: Streams + + + + + + + + + + Method + + System.Net.Quic + 7.0.0.0 + 8.0.0.0 + + + System.Void + + + + + + + The direction of the stream to abort. + The error code with which to abort the stream. This value is application-protocol (which is the layer above QUIC) dependent. + Aborts either the reading, writing, or both sides of the stream. + - - - - - - - - - - - Method - - System.Net.Quic - 7.0.0.0 - 8.0.0.0 - - - System.IAsyncResult - - - - - - - - - [System.Runtime.CompilerServices.Nullable(2)] - [<System.Runtime.CompilerServices.Nullable(2)>] - - - - - - - [System.Runtime.CompilerServices.Nullable(2)] - [<System.Runtime.CompilerServices.Nullable(2)>] - - - - - - The buffer to read the data into. - The byte offset in at which to begin writing data read from the stream. - The maximum number of bytes to read. - An optional asynchronous callback, to be called when the read is complete. - A user-provided object that distinguishes this particular asynchronous read request from other requests. - Begins an asynchronous read operation. (Consider using instead.) - An that represents the asynchronous read, which could still be pending. - To be added. - - - - - - - - - - - Method - - System.Net.Quic - 7.0.0.0 - 8.0.0.0 - - - System.IAsyncResult - - - - - - - - - [System.Runtime.CompilerServices.Nullable(2)] - [<System.Runtime.CompilerServices.Nullable(2)>] - - - - - - - [System.Runtime.CompilerServices.Nullable(2)] - [<System.Runtime.CompilerServices.Nullable(2)>] - - - - - - The buffer to write data from. - The byte offset in from which to begin writing. - The maximum number of bytes to write. - An optional asynchronous callback, to be called when the write is complete. - A user-provided object that distinguishes this particular asynchronous write request from other requests. - Begins an asynchronous write operation. (Consider using instead.) - An that represents the asynchronous write, which could still be pending. - To be added. - - - - - - - - - - - Property - - System.Net.Quic - 7.0.0.0 - 8.0.0.0 - - - System.Boolean - - - Gets a value indicating whether the supports reading. - - if the stream supports reading; otherwise, . - To be added. - - - - - - - - - - - Property - - System.Net.Quic - 7.0.0.0 - 8.0.0.0 - - - System.Boolean - - - Gets a value indicating whether the supports seeking. - - if the stream supports seeking; otherwise, . - To be added. - - - - - - - - - - - Property - - System.Net.Quic - 7.0.0.0 - 8.0.0.0 - - - System.Boolean - - - Gets a value that indicates whether the can timeout. - - if the current stream can time out; otherwise, . - To be added. - - - - - - - - - - - Property - - System.Net.Quic - 7.0.0.0 - 8.0.0.0 - - - System.Boolean - - - Gets a value indicating whether the supports writing. - - if the stream supports writing; otherwise, . - To be added. - - - - - - - - - - - Method - - System.Net.Quic - 7.0.0.0 - 8.0.0.0 - - - System.Void - - - - Gracefully completes the writing side of the stream. - + ]]> + + + + + + + + + + + Method + + System.Net.Quic + 7.0.0.0 + 8.0.0.0 + + + System.IAsyncResult + + + + + + + + + [System.Runtime.CompilerServices.Nullable(2)] + [<System.Runtime.CompilerServices.Nullable(2)>] + + + + + + + [System.Runtime.CompilerServices.Nullable(2)] + [<System.Runtime.CompilerServices.Nullable(2)>] + + + + + + The buffer to read the data into. + The byte offset in at which to begin writing data read from the stream. + The maximum number of bytes to read. + An optional asynchronous callback, to be called when the read is complete. + A user-provided object that distinguishes this particular asynchronous read request from other requests. + Begins an asynchronous read operation. (Consider using instead.) + An that represents the asynchronous read, which could still be pending. + To be added. + + + + + + + + + + + Method + + System.Net.Quic + 7.0.0.0 + 8.0.0.0 + + + System.IAsyncResult + + + + + + + + + [System.Runtime.CompilerServices.Nullable(2)] + [<System.Runtime.CompilerServices.Nullable(2)>] + + + + + + + [System.Runtime.CompilerServices.Nullable(2)] + [<System.Runtime.CompilerServices.Nullable(2)>] + + + + + + The buffer to write data from. + The byte offset in from which to begin writing. + The maximum number of bytes to write. + An optional asynchronous callback, to be called when the write is complete. + A user-provided object that distinguishes this particular asynchronous write request from other requests. + Begins an asynchronous write operation. (Consider using instead.) + An that represents the asynchronous write, which could still be pending. + To be added. + + + + + + + + + + + Property + + System.Net.Quic + 7.0.0.0 + 8.0.0.0 + + + System.Boolean + + + Gets a value indicating whether the supports reading. + + if the stream supports reading; otherwise, . + To be added. + + + + + + + + + + + Property + + System.Net.Quic + 7.0.0.0 + 8.0.0.0 + + + System.Boolean + + + Gets a value indicating whether the supports seeking. + + if the stream supports seeking; otherwise, . + To be added. + + + + + + + + + + + Property + + System.Net.Quic + 7.0.0.0 + 8.0.0.0 + + + System.Boolean + + + Gets a value that indicates whether the can timeout. + + if the current stream can time out; otherwise, . + To be added. + + + + + + + + + + + Property + + System.Net.Quic + 7.0.0.0 + 8.0.0.0 + + + System.Boolean + + + Gets a value indicating whether the supports writing. + + if the stream supports writing; otherwise, . + To be added. + + + + + + + + + + + Method + + System.Net.Quic + 7.0.0.0 + 8.0.0.0 + + + System.Void + + + + Gracefully completes the writing side of the stream. + with `completeWrites: true`. - ]]> - - - - - - - - - - - Method - - System.Net.Quic - 7.0.0.0 - 8.0.0.0 - - - System.Void - - - - - - To be added. - To be added. - To be added. - - - - - - - - - - - Method - - System.Net.Quic - 7.0.0.0 - 8.0.0.0 - - - System.Threading.Tasks.ValueTask - - - - If the read side is not fully consumed, that is, is not completed or hasn't returned 0, aborts the read side with provided . If the write side hasn't been closed, closes it gracefully as if was called. Finally, all resources associated with the stream will be released. - A task that represents the asynchronous dispose operation. - To be added. - - - - - - - - - - Method - - System.Net.Quic - 7.0.0.0 - 8.0.0.0 - - - System.Int32 - - - - - - The reference to the pending asynchronous request to finish. - Waits for the pending asynchronous read to complete. (Consider using instead.) - The number of bytes read from the stream, between zero (0) and the number of bytes requested. - - ReadAsync returns zero (0) only if zero bytes were requested or if no more bytes will be available because it's at the end of the stream; otherwise, read operations do not complete until at least one byte is available. If zero bytes are requested, read operations may complete immediately or may not complete until at least one byte is available (but without consuming any data). - - - - - - - - - - - Method - - System.Net.Quic - 7.0.0.0 - 8.0.0.0 - - - System.Void - - - - - - A reference to the outstanding asynchronous I/O request. - Ends an asynchronous write operation. (Consider using instead.) - To be added. - - - - - - - - - - - Method - - System.Net.Quic - 7.0.0.0 - 8.0.0.0 - - - System.Void - - - - When overridden in a derived class, clears all buffers for this stream and causes any buffered data to be written to the underlying device. - To be added. - - - - - - - - - - Method - - System.Net.Quic - 7.0.0.0 - 8.0.0.0 - - - System.Threading.Tasks.Task - - - - - - The token to monitor for cancellation requests. The default value is . - Asynchronously clears all buffers for this stream, causes any buffered data to be written to the underlying device, and monitors cancellation requests. - A task that represents the asynchronous flush operation. - To be added. - - - - - - - - - - - Property - - System.Net.Quic - 7.0.0.0 - 8.0.0.0 - - - System.Int64 - - - Gets the stream ID. - To be added. - To be added. - - - - - - - - - - - Property - - System.Net.Quic - 7.0.0.0 - 8.0.0.0 - - - System.Int64 - - - Gets the length of the data available on the stream. This property is not currently supported and always throws a . - A long value representing the length of the stream in bytes. - To be added. - - In all cases. - - - - - - - - - - Property - - System.Net.Quic - 7.0.0.0 - 8.0.0.0 - - - System.Int64 - - - Gets or sets the position within the current stream. This property is not currently supported and always throws a . - The current position within the stream. - To be added. - - In all cases. - - - - - - - - - - Method - - System.Net.Quic - 7.0.0.0 - 8.0.0.0 - - - - [System.Runtime.CompilerServices.NullableContext(0)] - [<System.Runtime.CompilerServices.NullableContext(0)>] - - - - System.Int32 - - - - - - A region of memory. When this method returns, the contents of this region are replaced by the bytes read from the current source. - When overridden in a derived class, reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read. - The total number of bytes read into the buffer. This can be less than the size of the buffer if that many bytes are not currently available, or zero (0) if the buffer's length is zero or the end of the stream has been reached. - To be added. - - - - - - - - - - - Method - - System.Net.Quic - 7.0.0.0 - 8.0.0.0 - - - System.Int32 - - - - - - - - An array of bytes. When this method returns, the buffer contains the specified byte array with the values between and ( + - 1) replaced by the bytes read from the current source. - The zero-based byte offset in at which to begin storing the data read from the current stream. - The maximum number of bytes to be read from the current stream. - When overridden in a derived class, reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read. - The total number of bytes read into the buffer. This can be less than the number of bytes requested if that many bytes are not currently available, or zero (0) if is 0 or the end of the stream has been reached. - To be added. - - - - - - - - - - Method - - System.Net.Quic - 7.0.0.0 - 8.0.0.0 - - - - [System.Runtime.CompilerServices.NullableContext(0)] - [<System.Runtime.CompilerServices.NullableContext(0)>] - - - - System.Threading.Tasks.ValueTask<System.Int32> - - - - - - - The region of memory to write the data into. - The token to monitor for cancellation requests. The default value is . - 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 its property contains the total number of bytes read into the buffer. The result value can be less than the length of the buffer if that many bytes are not currently available, or it can be 0 (zero) if the length of the buffer is 0 or if the end of the stream has been reached. - - - - - - - - - - Method - - System.Net.Quic - 7.0.0.0 - 8.0.0.0 - - - System.Threading.Tasks.Task<System.Int32> - - - - - - - - - The buffer to write the data into. - The byte offset in at which to begin writing data from the stream. - The maximum number of bytes to read. - The token to monitor for cancellation requests. The default value is . - 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 property 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 is 0 or if the end of the stream has been reached. - - - - - - - - - - - Method - - System.Net.Quic - 7.0.0.0 - 8.0.0.0 - - - System.Int32 - - - - Reads a byte from the stream and advances the position within the stream by one byte, or returns -1 if at the end of the stream. - The unsigned byte cast to an , or -1 if at the end of the stream. - To be added. - - - - - - - - - - - Property - - System.Net.Quic - 7.0.0.0 - 8.0.0.0 - - - System.Threading.Tasks.Task - - - Gets a that will complete once the reading side has been closed. - To be added. - The reading side can be closed when it has reached the end of the stream ( will return 0), or when is called for , or when the peer called for . - - - - - - - - - - Property - - System.Net.Quic - 7.0.0.0 - 8.0.0.0 - - - System.Int32 - - - Gets or sets a value, in milliseconds, that determines how long the stream will attempt to read before timing out. - A value, in milliseconds, that determines how long the stream will attempt to read before timing out. - To be added. - - - - - - - - - - - Method - - System.Net.Quic - 7.0.0.0 - 8.0.0.0 - - - System.Int64 - - - - - - - A byte offset relative to the parameter. - A value of type indicating the reference point used to obtain the new position. - Sets the current position of the stream to the given value. This method is not currently supported and always throws a . - The new position within the current stream. - To be added. - - In all cases. - - - - - - - - - - Method - - System.Net.Quic - 7.0.0.0 - 8.0.0.0 - - - System.Void - - - - - - The desired length of the current stream in bytes. - Sets the length of the stream. This method is not currently supported and always throws a . - To be added. - - In all cases. - - - - - - - - - - Method - - System.Net.Quic - 8.0.0.0 - - - System.String - - - - Returns a string that represents the current object. - A string that represents the current object. - To be added. - - - - - - - - - - - Property - - System.Net.Quic - 7.0.0.0 - 8.0.0.0 - - - System.Net.Quic.QuicStreamType - - - Gets the stream type. - To be added. - To be added. - - - - - - - - - - - Method - - System.Net.Quic - 7.0.0.0 - 8.0.0.0 - - - - [System.Runtime.CompilerServices.NullableContext(0)] - [<System.Runtime.CompilerServices.NullableContext(0)>] - - - - System.Void - - - - - - A region of memory. This method copies the contents of this region to the current stream. - When overridden in a derived class, writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written. - To be added. - - - - - - - - - - - Method - - System.Net.Quic - 7.0.0.0 - 8.0.0.0 - - - System.Void - - - - - - - - An array of bytes. This method copies bytes from to the current stream. - The zero-based byte offset in at which to begin copying bytes to the current stream. - The number of bytes to be written to the current stream. - When overridden in a derived class, writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written. - To be added. - - - - - - - - - - Method - - System.Net.Quic - 7.0.0.0 - 8.0.0.0 - - - - [System.Runtime.CompilerServices.NullableContext(0)] - [<System.Runtime.CompilerServices.NullableContext(0)>] - - - - System.Threading.Tasks.ValueTask - - - - - - - The region of memory to write data from. - The token to monitor for cancellation requests. The default value is . - 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. - To be added. - - - - - - - - - - Method - - System.Net.Quic - 7.0.0.0 - 8.0.0.0 - - - - [System.Runtime.CompilerServices.NullableContext(0)] - [<System.Runtime.CompilerServices.NullableContext(0)>] - - - - System.Threading.Tasks.ValueTask - - - - - - - - The region of memory to write data from. - - to notify the peer about gracefully closing the write side, that is, to send the FIN flag with the data; otherwise, . - The token to monitor for cancellation requests. The default value is . - 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. - To be added. - - - - - - - - - - Method - - System.Net.Quic - 7.0.0.0 - 8.0.0.0 - - - System.Threading.Tasks.Task - - - - - - - - - The buffer to write data from. - The zero-based byte offset in from which to begin copying bytes to the stream. - The maximum number of bytes to write. - The token to monitor for cancellation requests. The default value is . - 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. - To be added. - - - - - - - - - - - Method - - System.Net.Quic - 7.0.0.0 - 8.0.0.0 - - - System.Void - - - - - - The byte to write to the stream. - Writes a byte to the current position in the stream and advances the position within the stream by one byte. - To be added. - - - - - - - - - - - Property - - System.Net.Quic - 7.0.0.0 - 8.0.0.0 - - - System.Threading.Tasks.Task - - - Gets a that will complete when the writing side has been closed. - To be added. - The writing side can be closed by calling or with completeWrites: true and getting acknowledgement from the peer, or when is called for , or when the peer called for . - - - - - - - - - - Property - - System.Net.Quic - 7.0.0.0 - 8.0.0.0 - - - System.Int32 - - - Gets or sets a value, in milliseconds, that determines how long the stream will attempt to write before timing out. - The number of milliseconds that the stream will spend attempting to write before timing out. - To be added. - - - - - + ]]> + + + + + + + + + + + Method + + System.Net.Quic + 7.0.0.0 + 8.0.0.0 + + + System.Void + + + + + + To be added. + To be added. + To be added. + + + + + + + + + + + Method + + System.Net.Quic + 7.0.0.0 + 8.0.0.0 + + + System.Threading.Tasks.ValueTask + + + + If the read side is not fully consumed, that is, is not completed or hasn't returned 0, aborts the read side with provided . If the write side hasn't been closed, closes it gracefully as if was called. Finally, all resources associated with the stream will be released. + A task that represents the asynchronous dispose operation. + To be added. + + + + + + + + + + Method + + System.Net.Quic + 7.0.0.0 + 8.0.0.0 + + + System.Int32 + + + + + + The reference to the pending asynchronous request to finish. + Waits for the pending asynchronous read to complete. (Consider using instead.) + The number of bytes read from the stream, between zero (0) and the number of bytes requested. + + ReadAsync returns zero (0) only if zero bytes were requested or if no more bytes will be available because it's at the end of the stream; otherwise, read operations do not complete until at least one byte is available. If zero bytes are requested, read operations may complete immediately or may not complete until at least one byte is available (but without consuming any data). + + + + + + + + + + + Method + + System.Net.Quic + 7.0.0.0 + 8.0.0.0 + + + System.Void + + + + + + A reference to the outstanding asynchronous I/O request. + Ends an asynchronous write operation. (Consider using instead.) + To be added. + + + + + + + + + + + Method + + System.Net.Quic + 7.0.0.0 + 8.0.0.0 + + + System.Void + + + + When overridden in a derived class, clears all buffers for this stream and causes any buffered data to be written to the underlying device. + To be added. + + + + + + + + + + Method + + System.Net.Quic + 7.0.0.0 + 8.0.0.0 + + + System.Threading.Tasks.Task + + + + + + The token to monitor for cancellation requests. The default value is . + Asynchronously clears all buffers for this stream, causes any buffered data to be written to the underlying device, and monitors cancellation requests. + A task that represents the asynchronous flush operation. + To be added. + + The cancellation token was canceled. This exception is stored into the returned task. + + + + + + + + + + Property + + System.Net.Quic + 7.0.0.0 + 8.0.0.0 + + + System.Int64 + + + Gets the stream ID. + To be added. + To be added. + + + + + + + + + + + Property + + System.Net.Quic + 7.0.0.0 + 8.0.0.0 + + + System.Int64 + + + Gets the length of the data available on the stream. This property is not currently supported and always throws a . + A long value representing the length of the stream in bytes. + To be added. + + In all cases. + + + + + + + + + + Property + + System.Net.Quic + 7.0.0.0 + 8.0.0.0 + + + System.Int64 + + + Gets or sets the position within the current stream. This property is not currently supported and always throws a . + The current position within the stream. + To be added. + + In all cases. + + + + + + + + + + Method + + System.Net.Quic + 7.0.0.0 + 8.0.0.0 + + + + [System.Runtime.CompilerServices.NullableContext(0)] + [<System.Runtime.CompilerServices.NullableContext(0)>] + + + + System.Int32 + + + + + + A region of memory. When this method returns, the contents of this region are replaced by the bytes read from the current source. + When overridden in a derived class, reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read. + The total number of bytes read into the buffer. This can be less than the size of the buffer if that many bytes are not currently available, or zero (0) if the buffer's length is zero or the end of the stream has been reached. + To be added. + + + + + + + + + + + Method + + System.Net.Quic + 7.0.0.0 + 8.0.0.0 + + + System.Int32 + + + + + + + + An array of bytes. When this method returns, the buffer contains the specified byte array with the values between and ( + - 1) replaced by the bytes read from the current source. + The zero-based byte offset in at which to begin storing the data read from the current stream. + The maximum number of bytes to be read from the current stream. + When overridden in a derived class, reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read. + The total number of bytes read into the buffer. This can be less than the number of bytes requested if that many bytes are not currently available, or zero (0) if is 0 or the end of the stream has been reached. + To be added. + + + + + + + + + + Method + + System.Net.Quic + 7.0.0.0 + 8.0.0.0 + + + + [System.Runtime.CompilerServices.NullableContext(0)] + [<System.Runtime.CompilerServices.NullableContext(0)>] + + + + System.Threading.Tasks.ValueTask<System.Int32> + + + + + + + The region of memory to write the data into. + The token to monitor for cancellation requests. The default value is . + 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 its property contains the total number of bytes read into the buffer. The result value can be less than the length of the buffer if that many bytes are not currently available, or it can be 0 (zero) if the length of the buffer is 0 or if the end of the stream has been reached. + + The cancellation token was canceled. This exception is stored into the returned task. + + + + + + + + + Method + + System.Net.Quic + 7.0.0.0 + 8.0.0.0 + + + System.Threading.Tasks.Task<System.Int32> + + + + + + + + + The buffer to write the data into. + The byte offset in at which to begin writing data from the stream. + The maximum number of bytes to read. + The token to monitor for cancellation requests. The default value is . + 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 property 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 is 0 or if the end of the stream has been reached. + + The cancellation token was canceled. This exception is stored into the returned task. + + + + + + + + + + Method + + System.Net.Quic + 7.0.0.0 + 8.0.0.0 + + + System.Int32 + + + + Reads a byte from the stream and advances the position within the stream by one byte, or returns -1 if at the end of the stream. + The unsigned byte cast to an , or -1 if at the end of the stream. + To be added. + + + + + + + + + + + Property + + System.Net.Quic + 7.0.0.0 + 8.0.0.0 + + + System.Threading.Tasks.Task + + + Gets a that will complete once the reading side has been closed. + To be added. + The reading side can be closed when it has reached the end of the stream ( will return 0), or when is called for , or when the peer called for . + + + + + + + + + + Property + + System.Net.Quic + 7.0.0.0 + 8.0.0.0 + + + System.Int32 + + + Gets or sets a value, in milliseconds, that determines how long the stream will attempt to read before timing out. + A value, in milliseconds, that determines how long the stream will attempt to read before timing out. + To be added. + + + + + + + + + + + Method + + System.Net.Quic + 7.0.0.0 + 8.0.0.0 + + + System.Int64 + + + + + + + A byte offset relative to the parameter. + A value of type indicating the reference point used to obtain the new position. + Sets the current position of the stream to the given value. This method is not currently supported and always throws a . + The new position within the current stream. + To be added. + + In all cases. + + + + + + + + + + Method + + System.Net.Quic + 7.0.0.0 + 8.0.0.0 + + + System.Void + + + + + + The desired length of the current stream in bytes. + Sets the length of the stream. This method is not currently supported and always throws a . + To be added. + + In all cases. + + + + + + + + + + Method + + System.Net.Quic + 8.0.0.0 + + + System.String + + + + Returns a string that represents the current object. + A string that represents the current object. + To be added. + + + + + + + + + + + Property + + System.Net.Quic + 7.0.0.0 + 8.0.0.0 + + + System.Net.Quic.QuicStreamType + + + Gets the stream type. + To be added. + To be added. + + + + + + + + + + + Method + + System.Net.Quic + 7.0.0.0 + 8.0.0.0 + + + + [System.Runtime.CompilerServices.NullableContext(0)] + [<System.Runtime.CompilerServices.NullableContext(0)>] + + + + System.Void + + + + + + A region of memory. This method copies the contents of this region to the current stream. + When overridden in a derived class, writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written. + To be added. + + + + + + + + + + + Method + + System.Net.Quic + 7.0.0.0 + 8.0.0.0 + + + System.Void + + + + + + + + An array of bytes. This method copies bytes from to the current stream. + The zero-based byte offset in at which to begin copying bytes to the current stream. + The number of bytes to be written to the current stream. + When overridden in a derived class, writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written. + To be added. + + + + + + + + + + Method + + System.Net.Quic + 7.0.0.0 + 8.0.0.0 + + + + [System.Runtime.CompilerServices.NullableContext(0)] + [<System.Runtime.CompilerServices.NullableContext(0)>] + + + + System.Threading.Tasks.ValueTask + + + + + + + The region of memory to write data from. + The token to monitor for cancellation requests. The default value is . + 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. + To be added. + + The cancellation token was canceled. This exception is stored into the returned task. + + + + + + + + + Method + + System.Net.Quic + 7.0.0.0 + 8.0.0.0 + + + + [System.Runtime.CompilerServices.NullableContext(0)] + [<System.Runtime.CompilerServices.NullableContext(0)>] + + + + System.Threading.Tasks.ValueTask + + + + + + + + The region of memory to write data from. + + to notify the peer about gracefully closing the write side, that is, to send the FIN flag with the data; otherwise, . + The token to monitor for cancellation requests. The default value is . + 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. + To be added. + + The cancellation token was canceled. This exception is stored into the returned task. + + + + + + + + + Method + + System.Net.Quic + 7.0.0.0 + 8.0.0.0 + + + System.Threading.Tasks.Task + + + + + + + + + The buffer to write data from. + The zero-based byte offset in from which to begin copying bytes to the stream. + The maximum number of bytes to write. + The token to monitor for cancellation requests. The default value is . + 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. + To be added. + + The cancellation token was canceled. This exception is stored into the returned task. + + + + + + + + + + Method + + System.Net.Quic + 7.0.0.0 + 8.0.0.0 + + + System.Void + + + + + + The byte to write to the stream. + Writes a byte to the current position in the stream and advances the position within the stream by one byte. + To be added. + + + + + + + + + + + Property + + System.Net.Quic + 7.0.0.0 + 8.0.0.0 + + + System.Threading.Tasks.Task + + + Gets a that will complete when the writing side has been closed. + To be added. + The writing side can be closed by calling or with completeWrites: true and getting acknowledgement from the peer, or when is called for , or when the peer called for . + + + + + + + + + + Property + + System.Net.Quic + 7.0.0.0 + 8.0.0.0 + + + System.Int32 + + + Gets or sets a value, in milliseconds, that determines how long the stream will attempt to write before timing out. + The number of milliseconds that the stream will spend attempting to write before timing out. + To be added. + + + + + diff --git a/xml/System.Net.Security/NegotiateStream.xml b/xml/System.Net.Security/NegotiateStream.xml index 29e89a73a42..fd9d837a1da 100644 --- a/xml/System.Net.Security/NegotiateStream.xml +++ b/xml/System.Net.Security/NegotiateStream.xml @@ -3346,6 +3346,7 @@ Authentication has not occurred. ]]> + The cancellation token was canceled. This exception is stored into the returned task. @@ -3905,6 +3906,7 @@ This method reads asynchronously as much data as is available into `buffer` and The read operation failed. Authentication has not occurred. + The cancellation token was canceled. This exception is stored into the returned task. @@ -3956,6 +3958,7 @@ This method reads asynchronously as much data as is available into `buffer` and The read operation failed. Authentication has not occurred. A operation is already in progress. + The cancellation token was canceled. This exception is stored into the returned task. @@ -4298,6 +4301,7 @@ This method reads asynchronously as much data as is available into `buffer` and This object has been closed. Authentication has not occurred. + The cancellation token was canceled. This exception is stored into the returned task. @@ -4346,6 +4350,7 @@ This method reads asynchronously as much data as is available into `buffer` and ]]> + The cancellation token was canceled. This exception is stored into the returned task. is . diff --git a/xml/System.Net.Security/SslStream.xml b/xml/System.Net.Security/SslStream.xml index 8f171fbcb79..50f7c5d4774 100644 --- a/xml/System.Net.Security/SslStream.xml +++ b/xml/System.Net.Security/SslStream.xml @@ -969,6 +969,7 @@ Authentication is already in progress. This object has been closed. + The cancellation token was canceled. This exception is stored into the returned task. @@ -1550,6 +1551,7 @@ Authentication is already in progress. This object has been closed. + The cancellation token was canceled. This exception is stored into the returned task. @@ -1612,6 +1614,7 @@ Authentication is already in progress. This object has been closed. + The cancellation token was canceled. This exception is stored into the returned task. @@ -3472,6 +3475,7 @@ Authentication has not occurred. ]]> + The cancellation token was canceled. This exception is stored into the returned task. @@ -4141,6 +4145,7 @@ Authentication has not occurred. Negotiates the client certificate on the authenticated connection. The task object representing the asynchronous operation. You can negotiate the client certificate once authentication is successfully processed via one of the AuthenticateAs... methods. + The cancellation token was canceled. This exception is stored into the returned task. @@ -4405,6 +4410,7 @@ This property gets the cipher suite that is going to be used in the communicatio The read operation failed. Check the inner exception, if it is present, to determine the cause of the failure. There is already a read operation in progress. This object has been closed. + The cancellation token was canceled. This exception is stored into the returned task. @@ -4474,6 +4480,7 @@ This property gets the cipher suite that is going to be used in the communicatio The read operation failed. Check the inner exception, if it is present, to determine the cause of the failure. There is already a read operation in progress. This object has been closed. + The cancellation token was canceled. This exception is stored into the returned task. @@ -5107,6 +5114,7 @@ The class does not support multiple simulta The write operation failed. There is already a write operation in progress. This object has been closed. + The cancellation token was canceled. This exception is stored into the returned task. @@ -5174,6 +5182,7 @@ The class does not support multiple simulta The write operation failed. There is already a write operation in progress. This object has been closed. + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.Net.Sockets/NetworkStream.xml b/xml/System.Net.Sockets/NetworkStream.xml index cb363f63f7a..84bb5569faf 100644 --- a/xml/System.Net.Sockets/NetworkStream.xml +++ b/xml/System.Net.Sockets/NetworkStream.xml @@ -1335,6 +1335,7 @@ The Close method frees both unmanaged and managed resources associated with the ]]> + The cancellation token was canceled. This exception is stored into the returned task. @@ -1711,6 +1712,7 @@ This method reads as much data as is available into `buffer` and returns the num There is a failure reading from the network. The is closed. + The cancellation token was canceled. This exception is stored into the returned task. @@ -1782,6 +1784,7 @@ There is a failure reading from the network. There is a failure reading from the network. The is closed. + The cancellation token was canceled. This exception is stored into the returned task. @@ -2374,6 +2377,7 @@ This method sends all bytes in `buffer` to the network. There was a failure while writing to the network. The is closed. + The cancellation token was canceled. This exception is stored into the returned task. @@ -2458,6 +2462,7 @@ This method stores in the task it returns all non-usage exceptions that the meth An error occurred when accessing the socket. The is closed. + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.Net.Sockets/Socket.xml b/xml/System.Net.Sockets/Socket.xml index 02a9f54bceb..a6d07280d31 100644 --- a/xml/System.Net.Sockets/Socket.xml +++ b/xml/System.Net.Sockets/Socket.xml @@ -668,6 +668,7 @@ This method populates the instance with data ga This exception also occurs if the socket is already connected or a socket operation was already in progress using the specified parameter. An error occurred when attempting to access the socket. The has been closed. + The cancellation token was canceled. This exception is stored into the returned task. @@ -719,6 +720,7 @@ This method populates the instance with data ga This exception also occurs if the socket is already connected or a socket operation was already in progress using the specified parameter. An error occurred when attempting to access the socket. The has been closed. + The cancellation token was canceled. This exception is stored into the returned task. @@ -4236,6 +4238,7 @@ This method populates the instance with data ga The local endpoint and the parameter are not the same address family. The has been closed. A caller higher in the call stack does not have permission for the requested operation. + The cancellation token was canceled. This exception is stored into the returned task. @@ -4438,6 +4441,7 @@ This method populates the instance with data ga An error occurred when attempting to access the socket. The has been closed. A caller higher in the call stack does not have permission for the requested operation. + The cancellation token was canceled. This exception is stored into the returned task. @@ -4491,6 +4495,7 @@ This method populates the instance with data ga An error occurred when attempting to access the socket. The has been closed. A caller higher in the call stack does not have permission for the requested operation. + The cancellation token was canceled. This exception is stored into the returned task. @@ -4637,6 +4642,7 @@ This method populates the instance with data ga An error occurred when attempting to access the socket. The has been closed. A caller higher in the call stack does not have permission for the requested operation. + The cancellation token was canceled. This exception is stored into the returned task. @@ -4875,6 +4881,7 @@ This method populates the instance with data ga 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 . The object has been closed. An error occurred when attempting to access the socket. + The cancellation token was canceled. This exception is stored into the returned task. @@ -9210,6 +9217,7 @@ If you're using a connectionless , To be added. The has been closed. An error occurred when attempting to access the socket. + The cancellation token was canceled. This exception is stored into the returned task. @@ -9257,6 +9265,7 @@ If you're using a connectionless , To be added. The has been closed. An error occurred when attempting to access the socket. + The cancellation token was canceled. This exception is stored into the returned task. @@ -10196,6 +10205,7 @@ If you're using a connectionless , An error occurred when attempting to access the socket. The has been closed. A caller in the call stack does not have the required permissions. + The cancellation token was canceled. This exception is stored into the returned task. @@ -10255,6 +10265,7 @@ If you're using a connectionless , An error occurred when attempting to access the socket. The has been closed. A caller in the call stack does not have the required permissions. + The cancellation token was canceled. This exception is stored into the returned task. @@ -10311,6 +10322,7 @@ If you're using a connectionless , is . An error occurred when attempting to access the socket. The has been closed. + The cancellation token was canceled. This exception is stored into the returned task. @@ -10734,6 +10746,7 @@ You must call the Bind method before performing this operation. is . You must call the Bind method before performing this operation. + The cancellation token was canceled. This exception is stored into the returned task. @@ -10792,6 +10805,7 @@ You must call the Bind method before performing this operation. is . You must call the Bind method before performing this operation. + The cancellation token was canceled. This exception is stored into the returned task. @@ -12453,6 +12467,7 @@ This member outputs trace information when you enable network tracing in your ap Sends data on a connected socket. An asynchronous task that completes with the number of bytes sent. To be added. + The cancellation token was canceled. This exception is stored into the returned task. @@ -12500,6 +12515,7 @@ This member outputs trace information when you enable network tracing in your ap To be added. An error occurred when attempting to access the socket. The has been closed. + The cancellation token was canceled. This exception is stored into the returned task. @@ -12857,6 +12873,7 @@ This member outputs trace information when you enable network tracing in your ap The object is not connected to a remote host. The file was not found. An error occurred when attempting to access the socket. + The cancellation token was canceled. This exception is stored into the returned task. @@ -12917,6 +12934,7 @@ This member outputs trace information when you enable network tracing in your ap The object is not connected to a remote host. The file was not found. An error occurred when attempting to access the socket. + The cancellation token was canceled. This exception is stored into the returned task. @@ -13893,6 +13911,7 @@ This member outputs trace information when you enable network tracing in your ap is . An error occurred when attempting to access the socket. The has been closed. + The cancellation token was canceled. This exception is stored into the returned task. @@ -13951,6 +13970,7 @@ This member outputs trace information when you enable network tracing in your ap is . An error occurred when attempting to access the socket. The has been closed. + The cancellation token was canceled. This exception is stored into the returned task. @@ -14007,6 +14027,7 @@ This member outputs trace information when you enable network tracing in your ap is . An error occurred when attempting to access the socket. The has been closed. + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.Net.Sockets/SocketTaskExtensions.xml b/xml/System.Net.Sockets/SocketTaskExtensions.xml index c5dae173bdd..831e6ea5623 100644 --- a/xml/System.Net.Sockets/SocketTaskExtensions.xml +++ b/xml/System.Net.Sockets/SocketTaskExtensions.xml @@ -272,6 +272,7 @@ The local endpoint and the parameter are not the same address family. The has been closed. A caller higher in the call stack does not have permission for the requested operation. + The cancellation token was canceled. This exception is stored into the returned task. @@ -516,6 +517,7 @@ An error occurred when attempting to access the socket. The has been closed. A caller higher in the call stack does not have permission for the requested operation. + The cancellation token was canceled. This exception is stored into the returned task. @@ -571,6 +573,7 @@ An error occurred when attempting to access the socket. The has been closed. A caller higher in the call stack does not have permission for the requested operation. + The cancellation token was canceled. This exception is stored into the returned task. @@ -625,6 +628,7 @@ An error occurred when attempting to access the socket. The has been closed. A caller higher in the call stack does not have permission for the requested operation. + The cancellation token was canceled. This exception is stored into the returned task. @@ -806,6 +810,7 @@ To be added. The has been closed. An error occurred when attempting to access the socket. + The cancellation token was canceled. This exception is stored into the returned task. @@ -1122,6 +1127,7 @@ To be added. An error occurred when attempting to access the socket. The has been closed. + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.Net.Sockets/TcpClient.xml b/xml/System.Net.Sockets/TcpClient.xml index 994f0d52e55..2de06cb5ac6 100644 --- a/xml/System.Net.Sockets/TcpClient.xml +++ b/xml/System.Net.Sockets/TcpClient.xml @@ -1414,6 +1414,7 @@ The `Available` property is a way to determine whether data is queued for readin ]]> + The cancellation token was canceled. This exception is stored into the returned task. @@ -1545,6 +1546,7 @@ The `Available` property is a way to determine whether data is queued for readin is closed. + The cancellation token was canceled. This exception is stored into the returned task. @@ -1607,6 +1609,7 @@ The `Available` property is a way to determine whether data is queued for readin A caller higher in the call stack does not have permission for the requested operation. This method is valid for sockets that use the flag or the flag. + The cancellation token was canceled. This exception is stored into the returned task. @@ -1668,6 +1671,7 @@ The `Available` property is a way to determine whether data is queued for readin is closed. + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.Net.Sockets/TcpListener.xml b/xml/System.Net.Sockets/TcpListener.xml index 94f29c68987..d14d7bbd266 100644 --- a/xml/System.Net.Sockets/TcpListener.xml +++ b/xml/System.Net.Sockets/TcpListener.xml @@ -482,6 +482,7 @@ ]]> + The cancellation token was canceled. This exception is stored into the returned task. @@ -652,6 +653,7 @@ ]]> + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.Net.Sockets/UdpClient.xml b/xml/System.Net.Sockets/UdpClient.xml index 0e5fd5b28b0..264481fdc78 100644 --- a/xml/System.Net.Sockets/UdpClient.xml +++ b/xml/System.Net.Sockets/UdpClient.xml @@ -2515,6 +2515,7 @@ To be added. The underlying has been closed. An error occurred when accessing the socket. + The cancellation token was canceled. This exception is stored into the returned task. @@ -3014,6 +3015,7 @@ To be added. The is closed. An error occurred when accessing the socket. + The cancellation token was canceled. This exception is stored into the returned task. @@ -3139,6 +3141,7 @@ has already established a default remote host and is not . The is closed. An error occurred when accessing the socket. + The cancellation token was canceled. This exception is stored into the returned task. @@ -3265,6 +3268,7 @@ The has already established a default remote host. The is closed. An error occurred when accessing the socket. + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.Net.WebSockets/ClientWebSocket.xml b/xml/System.Net.WebSockets/ClientWebSocket.xml index fdb5e201daf..852be524df5 100644 --- a/xml/System.Net.WebSockets/ClientWebSocket.xml +++ b/xml/System.Net.WebSockets/ClientWebSocket.xml @@ -201,6 +201,7 @@ Exactly one send and one receive is supported on each + The cancellation token was canceled. This exception is stored into the returned task. @@ -272,6 +273,7 @@ Exactly one send and one receive is supported on each + The cancellation token was canceled. This exception is stored into the returned task. @@ -438,6 +440,7 @@ Exactly one send and one receive is supported on each + The cancellation token was canceled. This exception is stored into the returned task. @@ -484,6 +487,7 @@ Exactly one send and one receive is supported on each Connects to a WebSocket server as an asynchronous operation. The task object representing the asynchronous operation. To be added. + The cancellation token was canceled. This exception is stored into the returned task. @@ -684,6 +688,7 @@ Exactly one send and one receive is supported on each The is not connected. The has been closed. + The cancellation token was canceled. This exception is stored into the returned task. @@ -731,6 +736,7 @@ Exactly one send and one receive is supported on each The is not connected. The has been closed. + The cancellation token was canceled. This exception is stored into the returned task. @@ -792,6 +798,7 @@ Exactly one send and one receive is supported on each The is not connected. The has been closed. + The cancellation token was canceled. This exception is stored into the returned task. @@ -845,6 +852,7 @@ Exactly one send and one receive is supported on each The is not connected. The has been closed. + The cancellation token was canceled. This exception is stored into the returned task. @@ -889,6 +897,7 @@ Exactly one send and one receive is supported on each + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.Net.WebSockets/WebSocket.xml b/xml/System.Net.WebSockets/WebSocket.xml index fb801f92fd9..9ca1642976f 100644 --- a/xml/System.Net.WebSockets/WebSocket.xml +++ b/xml/System.Net.WebSockets/WebSocket.xml @@ -193,6 +193,7 @@ Exactly one send and one receive is supported on each + The cancellation token was canceled. This exception is stored into the returned task. @@ -260,6 +261,7 @@ Exactly one send and one receive is supported on each + The cancellation token was canceled. This exception is stored into the returned task. @@ -838,6 +840,7 @@ Exactly one send and one receive is supported on each + The cancellation token was canceled. This exception is stored into the returned task. @@ -874,6 +877,7 @@ Exactly one send and one receive is supported on each Receives data from the connection asynchronously. The task object representing the asynchronous operation. The property on the task object returns a object that represents the received data. To be added. + The cancellation token was canceled. This exception is stored into the returned task. @@ -979,6 +983,7 @@ Exactly one send and one receive is supported on each + The cancellation token was canceled. This exception is stored into the returned task. @@ -1020,6 +1025,7 @@ Exactly one send and one receive is supported on each Sends data over the connection asynchronously. The task object representing the asynchronous operation. To be added. + The cancellation token was canceled. This exception is stored into the returned task. @@ -1056,6 +1062,7 @@ Exactly one send and one receive is supported on each Sends data over the connection asynchronously. The task object representing the asynchronous operation. To be added. + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.Net/Dns.xml b/xml/System.Net/Dns.xml index 2695da55ff0..5746c6143b3 100644 --- a/xml/System.Net/Dns.xml +++ b/xml/System.Net/Dns.xml @@ -1028,6 +1028,7 @@ Returns the Internet Protocol (IP) addresses for the specified host as an asynchronous operation. The task object representing the asynchronous operation. The property on the task object returns an array of type that holds the IP addresses for the host that is specified by the 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 . + The cancellation token was canceled. This exception is stored into the returned task. @@ -1061,6 +1062,7 @@ Returns the Internet Protocol (IP) addresses for the specified host as an asynchronous operation. The task object representing the asynchronous operation. The property on the task object returns an array of type that holds the IP addresses for the host that is specified by the 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 . + The cancellation token was canceled. This exception is stored into the returned task. @@ -1708,6 +1710,7 @@ Resolves a host name or IP address to an instance as an asynchronous operation. The task object representing the asynchronous operation. The property on the task object returns an instance that contains the address information about the host specified in . 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 . + The cancellation token was canceled. This exception is stored into the returned task. @@ -1741,6 +1744,7 @@ Resolves a host name or IP address to an instance as an asynchronous operation. The task object representing the asynchronous operation. The property on the task object returns an instance that contains the address information about the host specified in . 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 . + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.Runtime.InteropServices.JavaScript/JSHost.xml b/xml/System.Runtime.InteropServices.JavaScript/JSHost.xml index 5ae0cb629a9..278ac8fdaa2 100644 --- a/xml/System.Runtime.InteropServices.JavaScript/JSHost.xml +++ b/xml/System.Runtime.InteropServices.JavaScript/JSHost.xml @@ -105,6 +105,7 @@ If a module with the provided has previously been instantiated, it will be returned instead. A proxy for the JavaScript object that contains the module's exports. To be added. + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.Security.Cryptography.Cose/CoseMultiSignMessage.xml b/xml/System.Security.Cryptography.Cose/CoseMultiSignMessage.xml index eb401750ca4..3f0abe6b696 100644 --- a/xml/System.Security.Cryptography.Cose/CoseMultiSignMessage.xml +++ b/xml/System.Security.Cryptography.Cose/CoseMultiSignMessage.xml @@ -226,6 +226,7 @@ The header is missing. The content is embedded on this message, use an overload that uses embedded content. + The cancellation token was canceled. This exception is stored into the returned task. @@ -711,6 +712,7 @@ The header is missing. + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.Security.Cryptography.Cose/CoseSign1Message.xml b/xml/System.Security.Cryptography.Cose/CoseSign1Message.xml index f85c87d4136..d5d7a772860 100644 --- a/xml/System.Security.Cryptography.Cose/CoseSign1Message.xml +++ b/xml/System.Security.Cryptography.Cose/CoseSign1Message.xml @@ -272,6 +272,7 @@ The header is missing. + The cancellation token was canceled. This exception is stored into the returned task. @@ -759,6 +760,7 @@ The algorithm protected header was not one of the values supported by this imple The algorithm protected header doesn't match with the algorithms supported by the specified . + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.Security.Cryptography.Cose/CoseSignature.xml b/xml/System.Security.Cryptography.Cose/CoseSignature.xml index f3401317e55..c4d88ad4b85 100644 --- a/xml/System.Security.Cryptography.Cose/CoseSignature.xml +++ b/xml/System.Security.Cryptography.Cose/CoseSignature.xml @@ -380,6 +380,7 @@ The algorithm protected header was not one of the values supported by this imple The algorithm protected header doesn't match with the algorithms supported by the specified . + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.Security.Cryptography/CryptoStream.xml b/xml/System.Security.Cryptography/CryptoStream.xml index 6f49cbd2bbb..16450793ea8 100644 --- a/xml/System.Security.Cryptography/CryptoStream.xml +++ b/xml/System.Security.Cryptography/CryptoStream.xml @@ -1,69 +1,69 @@ - - - - - - - - - System.Security.Cryptography.Primitives - 4.0.0.0 - 4.1.0.0 - 4.1.1.0 - 4.1.2.0 - 5.0.0.0 - 6.0.0.0 - - - mscorlib - 1.0.5000.0 - 2.0.0.0 - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Security.Cryptography - 7.0.0.0 - 8.0.0.0 - - - - - - - - - - - System.IO.Stream - - - - System.IDisposable - - - - - [System.Runtime.CompilerServices.Nullable(0)] - [<System.Runtime.CompilerServices.Nullable(0)>] - - - [System.Runtime.CompilerServices.NullableContext(1)] - [<System.Runtime.CompilerServices.NullableContext(1)>] - - - [System.Runtime.InteropServices.ComVisible(true)] - [<System.Runtime.InteropServices.ComVisible(true)>] - - - - Defines a stream that links data streams to cryptographic transformations. - + + + + + + + + + System.Security.Cryptography.Primitives + 4.0.0.0 + 4.1.0.0 + 4.1.1.0 + 4.1.2.0 + 5.0.0.0 + 6.0.0.0 + + + mscorlib + 1.0.5000.0 + 2.0.0.0 + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Security.Cryptography + 7.0.0.0 + 8.0.0.0 + + + + + + + + + + + System.IO.Stream + + + + System.IDisposable + + + + + [System.Runtime.CompilerServices.Nullable(0)] + [<System.Runtime.CompilerServices.Nullable(0)>] + + + [System.Runtime.CompilerServices.NullableContext(1)] + [<System.Runtime.CompilerServices.NullableContext(1)>] + + + [System.Runtime.InteropServices.ComVisible(true)] + [<System.Runtime.InteropServices.ComVisible(true)>] + + + + Defines a stream that links data streams to cryptographic transformations. + - - Cryptographic Services - Partial and zero-byte reads in DeflateStream, GZipStream, and CryptoStream - - - - - - - - - - Constructor - - System.Security.Cryptography.Primitives - 4.0.0.0 - 4.1.0.0 - 4.1.1.0 - 4.1.2.0 - 5.0.0.0 - 6.0.0.0 - - - mscorlib - 1.0.5000.0 - 2.0.0.0 - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Security.Cryptography - 7.0.0.0 - 8.0.0.0 - - - - - - - - The stream on which to perform the cryptographic transformation. - The cryptographic transformation that is to be performed on the stream. - One of the values. - Initializes a new instance of the class with a target data stream, the transformation to use, and the mode of the stream. - + ]]> + + Cryptographic Services + Partial and zero-byte reads in DeflateStream, GZipStream, and CryptoStream + + + + + + + + + + Constructor + + System.Security.Cryptography.Primitives + 4.0.0.0 + 4.1.0.0 + 4.1.1.0 + 4.1.2.0 + 5.0.0.0 + 6.0.0.0 + + + mscorlib + 1.0.5000.0 + 2.0.0.0 + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Security.Cryptography + 7.0.0.0 + 8.0.0.0 + + + + + + + + The stream on which to perform the cryptographic transformation. + The cryptographic transformation that is to be performed on the stream. + One of the values. + Initializes a new instance of the class with a target data stream, the transformation to use, and the mode of the stream. + can be passed into the `stream` parameter. Any object that implements (such as ) can be passed into the `transform` parameter. - ]]> - - - is invalid. - Cryptographic Services - - - - - - - - - - Constructor - - System.Security.Cryptography.Primitives - 4.1.0.0 - 4.1.1.0 - 4.1.2.0 - 5.0.0.0 - 6.0.0.0 - - - mscorlib - 4.0.0.0 - - - netstandard - 2.1.0.0 - - - System.Security.Cryptography - 7.0.0.0 - 8.0.0.0 - - - - - - - - - The stream on which to perform the cryptographic transformation. - The cryptographic transformation that is to be performed on the stream. - The mode of the stream. - - to not close the underlying stream when the object is disposed; otherwise, . - Initializes a new instance of the class. - To be added. - - is invalid. - - - - - - - - - - - Method - - System.Security.Cryptography.Primitives - 4.1.1.0 - 4.1.2.0 - 5.0.0.0 - 6.0.0.0 - - - netstandard - 2.1.0.0 - - - System.Security.Cryptography - 7.0.0.0 - 8.0.0.0 - - - System.IAsyncResult - - - - - - - - - [System.Runtime.CompilerServices.Nullable(2)] - [<System.Runtime.CompilerServices.Nullable(2)>] - - - - - - - [System.Runtime.CompilerServices.Nullable(2)] - [<System.Runtime.CompilerServices.Nullable(2)>] - - - - - - The buffer to read the data into. - The byte offset in at which to begin writing data read from the stream. - The maximum number of bytes to read. - An optional asynchronous callback, to be called when the read is complete. - A user-provided object that distinguishes this particular asynchronous read request from other requests. - Begins an asynchronous read operation. (Consider using instead.) - An that represents the asynchronous read, which could still be pending. - + ]]> + + + is invalid. + Cryptographic Services + + + + + + + + + + Constructor + + System.Security.Cryptography.Primitives + 4.1.0.0 + 4.1.1.0 + 4.1.2.0 + 5.0.0.0 + 6.0.0.0 + + + mscorlib + 4.0.0.0 + + + netstandard + 2.1.0.0 + + + System.Security.Cryptography + 7.0.0.0 + 8.0.0.0 + + + + + + + + + The stream on which to perform the cryptographic transformation. + The cryptographic transformation that is to be performed on the stream. + The mode of the stream. + + to not close the underlying stream when the object is disposed; otherwise, . + Initializes a new instance of the class. + To be added. + + is invalid. + + + + + + + + + + + Method + + System.Security.Cryptography.Primitives + 4.1.1.0 + 4.1.2.0 + 5.0.0.0 + 6.0.0.0 + + + netstandard + 2.1.0.0 + + + System.Security.Cryptography + 7.0.0.0 + 8.0.0.0 + + + System.IAsyncResult + + + + + + + + + [System.Runtime.CompilerServices.Nullable(2)] + [<System.Runtime.CompilerServices.Nullable(2)>] + + + + + + + [System.Runtime.CompilerServices.Nullable(2)] + [<System.Runtime.CompilerServices.Nullable(2)>] + + + + + + The buffer to read the data into. + The byte offset in at which to begin writing data read from the stream. + The maximum number of bytes to read. + An optional asynchronous callback, to be called when the read is complete. + A user-provided object that distinguishes this particular asynchronous read request from other requests. + Begins an asynchronous read operation. (Consider using instead.) + An that represents the asynchronous read, which could still be pending. + - - Attempted an asynchronous read past the end of the stream, or a disk error occurred. - One or more of the arguments is invalid. - Methods were called after the stream was closed. - The current implementation does not support the read operation. - - - - - - - - - - - Method - - System.Security.Cryptography.Primitives - 4.1.1.0 - 4.1.2.0 - 5.0.0.0 - 6.0.0.0 - - - netstandard - 2.1.0.0 - - - System.Security.Cryptography - 7.0.0.0 - 8.0.0.0 - - - System.IAsyncResult - - - - - - - - - [System.Runtime.CompilerServices.Nullable(2)] - [<System.Runtime.CompilerServices.Nullable(2)>] - - - - - - - [System.Runtime.CompilerServices.Nullable(2)] - [<System.Runtime.CompilerServices.Nullable(2)>] - - - - - - The buffer to write data from. - The byte offset in from which to begin writing. - The maximum number of bytes to write. - An optional asynchronous callback, to be called when the write is complete. - A user-provided object that distinguishes this particular asynchronous write request from other requests. - Begins an asynchronous write operation. (Consider using instead.) - An that represents the asynchronous write, which could still be pending. - + ]]> + + Attempted an asynchronous read past the end of the stream, or a disk error occurred. + One or more of the arguments is invalid. + Methods were called after the stream was closed. + The current implementation does not support the read operation. + + + + + + + + + + + Method + + System.Security.Cryptography.Primitives + 4.1.1.0 + 4.1.2.0 + 5.0.0.0 + 6.0.0.0 + + + netstandard + 2.1.0.0 + + + System.Security.Cryptography + 7.0.0.0 + 8.0.0.0 + + + System.IAsyncResult + + + + + + + + + [System.Runtime.CompilerServices.Nullable(2)] + [<System.Runtime.CompilerServices.Nullable(2)>] + + + + + + + [System.Runtime.CompilerServices.Nullable(2)] + [<System.Runtime.CompilerServices.Nullable(2)>] + + + + + + The buffer to write data from. + The byte offset in from which to begin writing. + The maximum number of bytes to write. + An optional asynchronous callback, to be called when the write is complete. + A user-provided object that distinguishes this particular asynchronous write request from other requests. + Begins an asynchronous write operation. (Consider using instead.) + An that represents the asynchronous write, which could still be pending. + - - Attempted an asynchronous write past the end of the stream, or a disk error occurred. - One or more of the arguments is invalid. - Methods were called after the stream was closed. - The current implementation does not support the write operation. - - - - - - - - - - Property - - System.Security.Cryptography.Primitives - 4.0.0.0 - 4.1.0.0 - 4.1.1.0 - 4.1.2.0 - 5.0.0.0 - 6.0.0.0 - - - mscorlib - 1.0.5000.0 - 2.0.0.0 - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Security.Cryptography - 7.0.0.0 - 8.0.0.0 - - - System.Boolean - - - Gets a value indicating whether the current is readable. - - if the current stream is readable; otherwise, . - To be added. - Cryptographic Services - - - - - - - - - - Property - - System.Security.Cryptography.Primitives - 4.0.0.0 - 4.1.0.0 - 4.1.1.0 - 4.1.2.0 - 5.0.0.0 - 6.0.0.0 - - - mscorlib - 1.0.5000.0 - 2.0.0.0 - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Security.Cryptography - 7.0.0.0 - 8.0.0.0 - - - System.Boolean - - - Gets a value indicating whether you can seek within the current . - Always . - + ]]> + + Attempted an asynchronous write past the end of the stream, or a disk error occurred. + One or more of the arguments is invalid. + Methods were called after the stream was closed. + The current implementation does not support the write operation. + + + + + + + + + + Property + + System.Security.Cryptography.Primitives + 4.0.0.0 + 4.1.0.0 + 4.1.1.0 + 4.1.2.0 + 5.0.0.0 + 6.0.0.0 + + + mscorlib + 1.0.5000.0 + 2.0.0.0 + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Security.Cryptography + 7.0.0.0 + 8.0.0.0 + + + System.Boolean + + + Gets a value indicating whether the current is readable. + + if the current stream is readable; otherwise, . + To be added. + Cryptographic Services + + + + + + + + + + Property + + System.Security.Cryptography.Primitives + 4.0.0.0 + 4.1.0.0 + 4.1.1.0 + 4.1.2.0 + 5.0.0.0 + 6.0.0.0 + + + mscorlib + 1.0.5000.0 + 2.0.0.0 + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Security.Cryptography + 7.0.0.0 + 8.0.0.0 + + + System.Boolean + + + Gets a value indicating whether you can seek within the current . + Always . + , so this method always returns `false`. - ]]> - - Cryptographic Services - - - - - - - - - - Property - - System.Security.Cryptography.Primitives - 4.0.0.0 - 4.1.0.0 - 4.1.1.0 - 4.1.2.0 - 5.0.0.0 - 6.0.0.0 - - - mscorlib - 1.0.5000.0 - 2.0.0.0 - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Security.Cryptography - 7.0.0.0 - 8.0.0.0 - - - System.Boolean - - - Gets a value indicating whether the current is writable. - - if the current stream is writable; otherwise, . - To be added. - Cryptographic Services - - - - - - - - - - Method - - mscorlib - 1.0.5000.0 - 2.0.0.0 - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Security.Cryptography.Primitives - 4.1.0.0 - 4.1.1.0 - 4.1.2.0 - 5.0.0.0 - 6.0.0.0 - - - System.Security.Cryptography - 7.0.0.0 - 8.0.0.0 - - - System.Void - - - - Releases all resources used by the . - + ]]> + + Cryptographic Services + + + + + + + + + + Property + + System.Security.Cryptography.Primitives + 4.0.0.0 + 4.1.0.0 + 4.1.1.0 + 4.1.2.0 + 5.0.0.0 + 6.0.0.0 + + + mscorlib + 1.0.5000.0 + 2.0.0.0 + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Security.Cryptography + 7.0.0.0 + 8.0.0.0 + + + System.Boolean + + + Gets a value indicating whether the current is writable. + + if the current stream is writable; otherwise, . + To be added. + Cryptographic Services + + + + + + + + + + Method + + mscorlib + 1.0.5000.0 + 2.0.0.0 + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Security.Cryptography.Primitives + 4.1.0.0 + 4.1.1.0 + 4.1.2.0 + 5.0.0.0 + 6.0.0.0 + + + System.Security.Cryptography + 7.0.0.0 + 8.0.0.0 + + + System.Void + + + + Releases all resources used by the . + to be reallocated for other purposes. For more information about `Dispose`, see [Cleaning Up Unmanaged Resources](/dotnet/standard/garbage-collection/unmanaged) - ]]> - - Cryptographic Services - - - - - - - - - - Method - - mscorlib - 1.0.5000.0 - - - System.Security.Cryptography.Primitives - - - netstandard - - - System.Security.Cryptography - - - System.Void - - - - Closes the current stream and releases any resources (such as sockets and file handles) associated with the current stream. - To be added. - - - - - - - - - - Method - - System.Security.Cryptography.Primitives - 6.0.0.0 - - - mscorlib - - - netstandard - - - System.Security.Cryptography - 7.0.0.0 - 8.0.0.0 - - - System.Void - - - - - - - The stream to which the contents of the current stream will be copied. - The size, in bytes, of the buffer to use for reading from the underlying stream. This value must be greater than zero. The default size is 81920 bytes. - Reads the bytes from the underlying stream, applies the relevant cryptographic transforms, and writes the result to the destination stream. - + ]]> + + Cryptographic Services + + + + + + + + + + Method + + mscorlib + 1.0.5000.0 + + + System.Security.Cryptography.Primitives + + + netstandard + + + System.Security.Cryptography + + + System.Void + + + + Closes the current stream and releases any resources (such as sockets and file handles) associated with the current stream. + To be added. + + + + + + + + + + Method + + System.Security.Cryptography.Primitives + 6.0.0.0 + + + mscorlib + + + netstandard + + + System.Security.Cryptography + 7.0.0.0 + 8.0.0.0 + + + System.Void + + + + + + + The stream to which the contents of the current stream will be copied. + The size, in bytes, of the buffer to use for reading from the underlying stream. This value must be greater than zero. The default size is 81920 bytes. + Reads the bytes from the underlying stream, applies the relevant cryptographic transforms, and writes the result to the destination stream. + - - - is . - - is negative or zero. + ]]> + + + is . + + is negative or zero. The current stream does not support reading. -or- - does not support writing. - Either the current stream or were closed before the method was called. - An I/O error occurred. - An error occurred during a cryptographic operation. - - - - - - - - - - - Method - - System.Security.Cryptography.Primitives - 6.0.0.0 - - - mscorlib - - - netstandard - - - System.Security.Cryptography - 7.0.0.0 - 8.0.0.0 - - - System.Threading.Tasks.Task - - - - - - - - The stream to which the contents of the current stream will be copied. - The size, in bytes, of the buffer. This value must be greater than zero. The default size is 81920. - The token to monitor for cancellation requests. The default value is . - Asynchronously reads the bytes from the underlying stream, applies the relevant cryptographic transforms, and writes the result to the destination stream. - A task that represents the asynchronous copy operation. - + does not support writing. + Either the current stream or were closed before the method was called. + An I/O error occurred. + An error occurred during a cryptographic operation. + + + + + + + + + + + Method + + System.Security.Cryptography.Primitives + 6.0.0.0 + + + mscorlib + + + netstandard + + + System.Security.Cryptography + 7.0.0.0 + 8.0.0.0 + + + System.Threading.Tasks.Task + + + + + + + + The stream to which the contents of the current stream will be copied. + The size, in bytes, of the buffer. This value must be greater than zero. The default size is 81920. + The token to monitor for cancellation requests. The default value is . + Asynchronously reads the bytes from the underlying stream, applies the relevant cryptographic transforms, and writes the result to the destination stream. + A task that represents the asynchronous copy operation. + , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . -]]> - - - is . - - 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. - An error occurred during a cryptographic operation. - - - - - - - - - - - - - - - - Method - - System.Security.Cryptography.Primitives - 4.0.0.0 - 4.1.0.0 - 4.1.1.0 - 4.1.2.0 - 5.0.0.0 - 6.0.0.0 - - - mscorlib - 1.0.5000.0 - 2.0.0.0 - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Security.Cryptography - 7.0.0.0 - 8.0.0.0 - - - System.Void - - - - - - - to release both managed and unmanaged resources; to release only unmanaged resources. - Releases the unmanaged resources used by the and optionally releases the managed resources. - +]]> + + + is . + + 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. + An error occurred during a cryptographic operation. + + The cancellation token was canceled. This exception is stored into the returned task. + + + + + + + + + + + + + + + Method + + System.Security.Cryptography.Primitives + 4.0.0.0 + 4.1.0.0 + 4.1.1.0 + 4.1.2.0 + 5.0.0.0 + 6.0.0.0 + + + mscorlib + 1.0.5000.0 + 2.0.0.0 + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Security.Cryptography + 7.0.0.0 + 8.0.0.0 + + + System.Void + + + + + + + to release both managed and unmanaged resources; to release only unmanaged resources. + Releases the unmanaged resources used by the and optionally releases the managed resources. + references. This method invokes the `Dispose()` method of each referenced object. - ]]> - - - + ]]> + + + can be called multiple times by other objects. When overriding , be careful not to reference objects that have been previously disposed in an earlier call to . For more information about how to implement , see [Implementing a Dispose Method](/dotnet/standard/garbage-collection/implementing-dispose). - For more information about and , see [Cleaning Up Unmanaged Resources](/dotnet/standard/garbage-collection/unmanaged). - - Cryptographic Services - - - - - - - - - - Method - - System.Security.Cryptography.Primitives - 4.1.1.0 - 4.1.2.0 - 5.0.0.0 - 6.0.0.0 - - - netstandard - 2.1.0.0 - - - System.Security.Cryptography - 7.0.0.0 - 8.0.0.0 - - - System.Threading.Tasks.ValueTask - - - - Asynchronously releases the unmanaged resources used by the . - A task that represents the asynchronous dispose operation. - + For more information about and , see [Cleaning Up Unmanaged Resources](/dotnet/standard/garbage-collection/unmanaged). + + Cryptographic Services + + + + + + + + + + Method + + System.Security.Cryptography.Primitives + 4.1.1.0 + 4.1.2.0 + 5.0.0.0 + 6.0.0.0 + + + netstandard + 2.1.0.0 + + + System.Security.Cryptography + 7.0.0.0 + 8.0.0.0 + + + System.Threading.Tasks.ValueTask + + + + Asynchronously releases the unmanaged resources used by the . + A task that represents the asynchronous dispose operation. + to be reallocated for other purposes. For more information, see [Cleaning Up Unmanaged Resources](/dotnet/standard/garbage-collection/unmanaged). - ]]> - - - - - - - - - - - Method - - System.Security.Cryptography.Primitives - 4.1.1.0 - 4.1.2.0 - 5.0.0.0 - 6.0.0.0 - - - netstandard - 2.1.0.0 - - - System.Security.Cryptography - 7.0.0.0 - 8.0.0.0 - - - System.Int32 - - - - - - The reference to the pending asynchronous request to finish. - Waits for the pending asynchronous read to complete. (Consider using instead.) - The number of bytes read from the stream, between zero (0) and the number of bytes you requested. Streams return zero (0) only at the end of the stream, otherwise, they should block until at least one byte is available. - + ]]> + + + + + + + + + + + Method + + System.Security.Cryptography.Primitives + 4.1.1.0 + 4.1.2.0 + 5.0.0.0 + 6.0.0.0 + + + netstandard + 2.1.0.0 + + + System.Security.Cryptography + 7.0.0.0 + 8.0.0.0 + + + System.Int32 + + + + + + The reference to the pending asynchronous request to finish. + Waits for the pending asynchronous read to complete. (Consider using instead.) + The number of bytes read from the stream, between zero (0) and the number of bytes you requested. Streams return zero (0) only at the end of the stream, otherwise, they should block until at least one byte is available. + - - - is . + ]]> + + + is . A handle to the pending read operation is not available. -or- - The pending operation does not support reading. - - did not originate from a method on the current stream. - The stream is closed or an internal error has occurred. - - - - - - - - - - Method - - System.Security.Cryptography.Primitives - 4.1.1.0 - 4.1.2.0 - 5.0.0.0 - 6.0.0.0 - - - netstandard - 2.1.0.0 - - - System.Security.Cryptography - 7.0.0.0 - 8.0.0.0 - - - System.Void - - - - - - A reference to the outstanding asynchronous I/O request. - Ends an asynchronous write operation. (Consider using instead.) - + The pending operation does not support reading. + + did not originate from a method on the current stream. + The stream is closed or an internal error has occurred. + + + + + + + + + + Method + + System.Security.Cryptography.Primitives + 4.1.1.0 + 4.1.2.0 + 5.0.0.0 + 6.0.0.0 + + + netstandard + 2.1.0.0 + + + System.Security.Cryptography + 7.0.0.0 + 8.0.0.0 + + + System.Void + + + + + + A reference to the outstanding asynchronous I/O request. + Ends an asynchronous write operation. (Consider using instead.) + - - - is . + ]]> + + + is . A handle to the pending write operation is not available. -or- - The pending operation does not support writing. - - did not originate from a method on the current stream. - The stream is closed or an internal error has occurred. - - - - - - - - - - Method - - mscorlib - 1.0.5000.0 - - - System.Security.Cryptography.Primitives - - - netstandard - - - System.Security.Cryptography - - - System.Void - - - - Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. - To be added. - - - - - - - - - - Method - - System.Security.Cryptography.Primitives - 4.0.0.0 - 4.1.0.0 - 4.1.1.0 - 4.1.2.0 - 5.0.0.0 - 6.0.0.0 - - - mscorlib - 1.0.5000.0 - 2.0.0.0 - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Security.Cryptography - 7.0.0.0 - 8.0.0.0 - - - System.Void - - - - Clears all buffers for the current stream and causes any buffered data to be written to the underlying device. - + The pending operation does not support writing. + + did not originate from a method on the current stream. + The stream is closed or an internal error has occurred. + + + + + + + + + + Method + + mscorlib + 1.0.5000.0 + + + System.Security.Cryptography.Primitives + + + netstandard + + + System.Security.Cryptography + + + System.Void + + + + Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. + To be added. + + + + + + + + + + Method + + System.Security.Cryptography.Primitives + 4.0.0.0 + 4.1.0.0 + 4.1.1.0 + 4.1.2.0 + 5.0.0.0 + 6.0.0.0 + + + mscorlib + 1.0.5000.0 + 2.0.0.0 + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Security.Cryptography + 7.0.0.0 + 8.0.0.0 + + + System.Void + + + + Clears all buffers for the current stream and causes any buffered data to be written to the underlying device. + [!NOTE] > You should call either the method or the method to complete flushing the buffer. - ]]> - - Cryptographic Services - - - - - - - - - - Method - - System.Security.Cryptography.Primitives - 4.0.0.0 - 4.1.0.0 - 4.1.1.0 - 4.1.2.0 - 5.0.0.0 - 6.0.0.0 - - - mscorlib - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Security.Cryptography - 7.0.0.0 - 8.0.0.0 - - - System.Threading.Tasks.Task - - - - - - The token to monitor for cancellation requests. The default value is . - Clears all buffers for the current stream asynchronously, causes any buffered data to be written to the underlying device, and monitors cancellation requests. - A task that represents the asynchronous flush operation. - + ]]> + + Cryptographic Services + + + + + + + + + + Method + + System.Security.Cryptography.Primitives + 4.0.0.0 + 4.1.0.0 + 4.1.1.0 + 4.1.2.0 + 5.0.0.0 + 6.0.0.0 + + + mscorlib + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Security.Cryptography + 7.0.0.0 + 8.0.0.0 + + + System.Threading.Tasks.Task + + + + + + The token to monitor for cancellation requests. The default value is . + Clears all buffers for the current stream asynchronously, causes any buffered data to be written to the underlying device, and monitors cancellation requests. + A task that represents the asynchronous flush operation. + , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . -]]> - - The stream has been disposed. - - - - - - - - - - Method - - System.Security.Cryptography.Primitives - 4.0.0.0 - 4.1.0.0 - 4.1.1.0 - 4.1.2.0 - 5.0.0.0 - 6.0.0.0 - - - mscorlib - 1.0.5000.0 - 2.0.0.0 - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Security.Cryptography - 7.0.0.0 - 8.0.0.0 - - - System.Void - - - - Updates the underlying data source or repository with the current state of the buffer, then clears the buffer. - +]]> + + The stream has been disposed. + The cancellation token was canceled. This exception is stored into the returned task. + + + + + + + + + + Method + + System.Security.Cryptography.Primitives + 4.0.0.0 + 4.1.0.0 + 4.1.1.0 + 4.1.2.0 + 5.0.0.0 + 6.0.0.0 + + + mscorlib + 1.0.5000.0 + 2.0.0.0 + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Security.Cryptography + 7.0.0.0 + 8.0.0.0 + + + System.Void + + + + Updates the underlying data source or repository with the current state of the buffer, then clears the buffer. + method will call . If you do not call , call to complete flushing the buffer. Call only when all stream activity is complete. - ]]> - - The key is corrupt which can cause invalid padding to the stream. + ]]> + + The key is corrupt which can cause invalid padding to the stream. The current stream is not writable. -or- - The final block has already been transformed. - Cryptographic Services - - - - - - - - - Method - - System.Security.Cryptography.Primitives - 5.0.0.0 - 6.0.0.0 - - - System.Security.Cryptography - 7.0.0.0 - 8.0.0.0 - - - netstandard - - - System.Threading.Tasks.ValueTask - - - - - - The token to monitor for cancellation requests. The default value is . - Asynchronously updates the underlying data source or repository with the current state of the buffer, then clears the buffer. - A task that represents the asynchronous flush operation. - 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 . - - - - - - - - - - Property - - System.Security.Cryptography.Primitives - 4.0.0.0 - 4.1.0.0 - 4.1.1.0 - 4.1.2.0 - 5.0.0.0 - 6.0.0.0 - - - mscorlib - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Security.Cryptography - 7.0.0.0 - 8.0.0.0 - - - System.Boolean - - - Gets a value indicating whether the final buffer block has been written to the underlying stream. - - if the final block has been flushed; otherwise, . - + The final block has already been transformed. + Cryptographic Services + + + + + + + + + Method + + System.Security.Cryptography.Primitives + 5.0.0.0 + 6.0.0.0 + + + System.Security.Cryptography + 7.0.0.0 + 8.0.0.0 + + + netstandard + + + System.Threading.Tasks.ValueTask + + + + + + The token to monitor for cancellation requests. The default value is . + Asynchronously updates the underlying data source or repository with the current state of the buffer, then clears the buffer. + A task that represents the asynchronous flush operation. + 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 . + The cancellation token was canceled. This exception is stored into the returned task. + + + + + + + + + + Property + + System.Security.Cryptography.Primitives + 4.0.0.0 + 4.1.0.0 + 4.1.1.0 + 4.1.2.0 + 5.0.0.0 + 6.0.0.0 + + + mscorlib + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Security.Cryptography + 7.0.0.0 + 8.0.0.0 + + + System.Boolean + + + Gets a value indicating whether the final buffer block has been written to the underlying stream. + + if the final block has been flushed; otherwise, . + method is called. - ]]> - - - - - - - - - - - Property - - System.Security.Cryptography.Primitives - 4.0.0.0 - 4.1.0.0 - 4.1.1.0 - 4.1.2.0 - 5.0.0.0 - 6.0.0.0 - - - mscorlib - 1.0.5000.0 - 2.0.0.0 - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Security.Cryptography - 7.0.0.0 - 8.0.0.0 - - - System.Int64 - - - Gets the length in bytes of the stream. - This property is not supported. - + ]]> + + + + + + + + + + + Property + + System.Security.Cryptography.Primitives + 4.0.0.0 + 4.1.0.0 + 4.1.1.0 + 4.1.2.0 + 5.0.0.0 + 6.0.0.0 + + + mscorlib + 1.0.5000.0 + 2.0.0.0 + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Security.Cryptography + 7.0.0.0 + 8.0.0.0 + + + System.Int64 + + + Gets the length in bytes of the stream. + This property is not supported. + , and cannot be used. - ]]> - - This property is not supported. - Cryptographic Services - - - - - - - - - - Property - - System.Security.Cryptography.Primitives - 4.0.0.0 - 4.1.0.0 - 4.1.1.0 - 4.1.2.0 - 5.0.0.0 - 6.0.0.0 - - - mscorlib - 1.0.5000.0 - 2.0.0.0 - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Security.Cryptography - 7.0.0.0 - 8.0.0.0 - - - System.Int64 - - - Gets or sets the position within the current stream. - This property is not supported. - + ]]> + + This property is not supported. + Cryptographic Services + + + + + + + + + + Property + + System.Security.Cryptography.Primitives + 4.0.0.0 + 4.1.0.0 + 4.1.1.0 + 4.1.2.0 + 5.0.0.0 + 6.0.0.0 + + + mscorlib + 1.0.5000.0 + 2.0.0.0 + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Security.Cryptography + 7.0.0.0 + 8.0.0.0 + + + System.Int64 + + + Gets or sets the position within the current stream. + This property is not supported. + , and cannot be used. - ]]> - - This property is not supported. - Cryptographic Services - - - - - - - - - - - Method - - System.Security.Cryptography.Primitives - 4.0.0.0 - 4.1.0.0 - 4.1.1.0 - 4.1.2.0 - 5.0.0.0 - 6.0.0.0 - - - mscorlib - 1.0.5000.0 - 2.0.0.0 - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Security.Cryptography - 7.0.0.0 - 8.0.0.0 - - - - [System.Security.SecuritySafeCritical] - [<System.Security.SecuritySafeCritical>] - - - - System.Int32 - - - - - - - - An array of bytes. A maximum of bytes are read from the current stream and stored in . - The byte offset in at which to begin storing the data read from the current stream. - The maximum number of bytes to be read from the current stream. - Reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read. - The total number of bytes read into the buffer. This can be less than the number of bytes requested if that many bytes are not currently available, or zero if the end of the stream has been reached. - To be added. - The associated with current object does not match the underlying stream. For example, this exception is thrown when using with an underlying stream that is write only. + ]]> + + This property is not supported. + Cryptographic Services + + + + + + + + + + + Method + + System.Security.Cryptography.Primitives + 4.0.0.0 + 4.1.0.0 + 4.1.1.0 + 4.1.2.0 + 5.0.0.0 + 6.0.0.0 + + + mscorlib + 1.0.5000.0 + 2.0.0.0 + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Security.Cryptography + 7.0.0.0 + 8.0.0.0 + + + + [System.Security.SecuritySafeCritical] + [<System.Security.SecuritySafeCritical>] + + + + System.Int32 + + + + + + + + An array of bytes. A maximum of bytes are read from the current stream and stored in . + The byte offset in at which to begin storing the data read from the current stream. + The maximum number of bytes to be read from the current stream. + Reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read. + The total number of bytes read into the buffer. This can be less than the number of bytes requested if that many bytes are not currently available, or zero if the end of the stream has been reached. + To be added. + The associated with current object does not match the underlying stream. For example, this exception is thrown when using with an underlying stream that is write only. The parameter is less than zero. -or- - The parameter is less than zero. - The sum of the and parameters is longer than the length of the buffer. - Cryptographic Services - - - - - - - - - Method - - System.Security.Cryptography.Primitives - 6.0.0.0 - - - mscorlib - - - netstandard - - - System.Security.Cryptography - 7.0.0.0 - 8.0.0.0 - - - - [System.Runtime.CompilerServices.NullableContext(0)] - [<System.Runtime.CompilerServices.NullableContext(0)>] - - - - System.Threading.Tasks.ValueTask<System.Int32> - - - - - - - The region of memory to write the data into. - The token to monitor for cancellation requests. The default value is . - 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 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. - To be added. - The associated with current object does not match the underlying stream. For example, this exception is thrown when using with an underlying stream that is write only. - - - - - - - - - - - Method - - System.Security.Cryptography.Primitives - 4.0.0.0 - 4.1.0.0 - 4.1.1.0 - 4.1.2.0 - 5.0.0.0 - 6.0.0.0 - - - mscorlib - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Security.Cryptography - 7.0.0.0 - 8.0.0.0 - - - System.Threading.Tasks.Task<System.Int32> - - - - - - - - - The buffer to write the data into. - The byte offset in at which to begin writing data from the stream. - The maximum number of bytes to read. - The token to monitor for cancellation requests. The default value is . - Reads a sequence of bytes from the current stream asynchronously, 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 task object's parameter contains the total number of bytes read into the buffer. The result 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. - + The parameter is less than zero. + The sum of the and parameters is longer than the length of the buffer. + Cryptographic Services + + + + + + + + + Method + + System.Security.Cryptography.Primitives + 6.0.0.0 + + + mscorlib + + + netstandard + + + System.Security.Cryptography + 7.0.0.0 + 8.0.0.0 + + + + [System.Runtime.CompilerServices.NullableContext(0)] + [<System.Runtime.CompilerServices.NullableContext(0)>] + + + + System.Threading.Tasks.ValueTask<System.Int32> + + + + + + + The region of memory to write the data into. + The token to monitor for cancellation requests. The default value is . + 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 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. + To be added. + The associated with current object does not match the underlying stream. For example, this exception is thrown when using with an underlying stream that is write only. + + The cancellation token was canceled. This exception is stored into the returned task. + + + + + + + + + + Method + + System.Security.Cryptography.Primitives + 4.0.0.0 + 4.1.0.0 + 4.1.1.0 + 4.1.2.0 + 5.0.0.0 + 6.0.0.0 + + + mscorlib + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Security.Cryptography + 7.0.0.0 + 8.0.0.0 + + + System.Threading.Tasks.Task<System.Int32> + + + + + + + + + The buffer to write the data into. + The byte offset in at which to begin writing data from the stream. + The maximum number of bytes to read. + The token to monitor for cancellation requests. The default value is . + Reads a sequence of bytes from the current stream asynchronously, 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 task object's parameter contains the total number of bytes read into the buffer. The result 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. + , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . -]]> - - - is . - - or is negative. - The sum of and is larger than the buffer length. - The stream does not support reading. - The stream has been disposed. - The stream is currently in use by a previous read operation. - Cancellation - - - - - - - - - - Method - - System.Security.Cryptography.Primitives - 4.1.0.0 - 4.1.1.0 - 4.1.2.0 - 5.0.0.0 - 6.0.0.0 - - - netstandard - 2.1.0.0 - - - System.Security.Cryptography - 7.0.0.0 - 8.0.0.0 - - - System.Int32 - - - - Reads a byte from the stream and advances the position within the stream by one byte, or returns -1 if at the end of the stream. - The unsigned byte cast to an , or -1 if at the end of the stream. - +]]> + + + is . + + or is negative. + The sum of and is larger than the buffer length. + The stream does not support reading. + The stream has been disposed. + The stream is currently in use by a previous read operation. + Cancellation + The cancellation token was canceled. This exception is stored into the returned task. + + + + + + + + + + Method + + System.Security.Cryptography.Primitives + 4.1.0.0 + 4.1.1.0 + 4.1.2.0 + 5.0.0.0 + 6.0.0.0 + + + netstandard + 2.1.0.0 + + + System.Security.Cryptography + 7.0.0.0 + 8.0.0.0 + + + System.Int32 + + + + Reads a byte from the stream and advances the position within the stream by one byte, or returns -1 if at the end of the stream. + The unsigned byte cast to an , or -1 if at the end of the stream. + . - ]]> - - The stream does not support reading. - Methods were called after the stream was closed. - - - - - - - - - - Method - - System.Security.Cryptography.Primitives - 4.0.0.0 - 4.1.0.0 - 4.1.1.0 - 4.1.2.0 - 5.0.0.0 - 6.0.0.0 - - - mscorlib - 1.0.5000.0 - 2.0.0.0 - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Security.Cryptography - 7.0.0.0 - 8.0.0.0 - - - System.Int64 - - - - - - - A byte offset relative to the parameter. - A object indicating the reference point used to obtain the new position. - Sets the position within the current stream. - This method is not supported. - + ]]> + + The stream does not support reading. + Methods were called after the stream was closed. + + + + + + + + + + Method + + System.Security.Cryptography.Primitives + 4.0.0.0 + 4.1.0.0 + 4.1.1.0 + 4.1.2.0 + 5.0.0.0 + 6.0.0.0 + + + mscorlib + 1.0.5000.0 + 2.0.0.0 + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Security.Cryptography + 7.0.0.0 + 8.0.0.0 + + + System.Int64 + + + + + + + A byte offset relative to the parameter. + A object indicating the reference point used to obtain the new position. + Sets the position within the current stream. + This method is not supported. + , and cannot be used. - ]]> - - This method is not supported. - Cryptographic Services - - - - - - - - - - Method - - System.Security.Cryptography.Primitives - 4.0.0.0 - 4.1.0.0 - 4.1.1.0 - 4.1.2.0 - 5.0.0.0 - 6.0.0.0 - - - mscorlib - 1.0.5000.0 - 2.0.0.0 - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Security.Cryptography - 7.0.0.0 - 8.0.0.0 - - - System.Void - - - - - - The desired length of the current stream in bytes. - Sets the length of the current stream. - + ]]> + + This method is not supported. + Cryptographic Services + + + + + + + + + + Method + + System.Security.Cryptography.Primitives + 4.0.0.0 + 4.1.0.0 + 4.1.1.0 + 4.1.2.0 + 5.0.0.0 + 6.0.0.0 + + + mscorlib + 1.0.5000.0 + 2.0.0.0 + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Security.Cryptography + 7.0.0.0 + 8.0.0.0 + + + System.Void + + + + + + The desired length of the current stream in bytes. + Sets the length of the current stream. + , and cannot be used. - ]]> - - This property exists only to support inheritance from , and cannot be used. - Cryptographic Services - - - - - - - - - - Method - - M:System.IDisposable.Dispose - - - mscorlib - 1.0.5000.0 - - - System.Security.Cryptography.Primitives - - - netstandard - - - System.Security.Cryptography - - - System.Void - - - - Releases the resources used by the current instance of the class. - + ]]> + + This property exists only to support inheritance from , and cannot be used. + Cryptographic Services + + + + + + + + + + Method + + M:System.IDisposable.Dispose + + + mscorlib + 1.0.5000.0 + + + System.Security.Cryptography.Primitives + + + netstandard + + + System.Security.Cryptography + + + System.Void + + + + Releases the resources used by the current instance of the class. + instance is cast to an interface. - ]]> - - - - - - - - - - - - Method - - System.Security.Cryptography.Primitives - 4.0.0.0 - 4.1.0.0 - 4.1.1.0 - 4.1.2.0 - 5.0.0.0 - 6.0.0.0 - - - mscorlib - 1.0.5000.0 - 2.0.0.0 - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Security.Cryptography - 7.0.0.0 - 8.0.0.0 - - - - [System.Security.SecuritySafeCritical] - [<System.Security.SecuritySafeCritical>] - - - - System.Void - - - - - - - - An array of bytes. This method copies bytes from to the current stream. - The byte offset in at which to begin copying bytes to the current stream. - The number of bytes to be written to the current stream. - Writes a sequence of bytes to the current and advances the current position within the stream by the number of bytes written. - To be added. - The associated with current object does not match the underlying stream. For example, this exception is thrown when using with an underlying stream that is read only. + ]]> + + + + + + + + + + + + Method + + System.Security.Cryptography.Primitives + 4.0.0.0 + 4.1.0.0 + 4.1.1.0 + 4.1.2.0 + 5.0.0.0 + 6.0.0.0 + + + mscorlib + 1.0.5000.0 + 2.0.0.0 + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Security.Cryptography + 7.0.0.0 + 8.0.0.0 + + + + [System.Security.SecuritySafeCritical] + [<System.Security.SecuritySafeCritical>] + + + + System.Void + + + + + + + + An array of bytes. This method copies bytes from to the current stream. + The byte offset in at which to begin copying bytes to the current stream. + The number of bytes to be written to the current stream. + Writes a sequence of bytes to the current and advances the current position within the stream by the number of bytes written. + To be added. + The associated with current object does not match the underlying stream. For example, this exception is thrown when using with an underlying stream that is read only. The parameter is less than zero. -or- - The parameter is less than zero. - The sum of the and parameters is longer than the length of the buffer. - Cryptographic Services - - - - - - - - - Method - - System.Security.Cryptography.Primitives - 6.0.0.0 - - - mscorlib - - - netstandard - - - System.Security.Cryptography - 7.0.0.0 - 8.0.0.0 - - - - [System.Runtime.CompilerServices.NullableContext(0)] - [<System.Runtime.CompilerServices.NullableContext(0)>] - - - - System.Threading.Tasks.ValueTask - - - - - - - The region of memory to write data from. - The token to monitor for cancellation requests. The default value is . - 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. - To be added. - The associated with current object does not match the underlying stream. For example, this exception is thrown when using with an underlying stream that is read only. - - - - - - - - - - - Method - - System.Security.Cryptography.Primitives - 4.0.0.0 - 4.1.0.0 - 4.1.1.0 - 4.1.2.0 - 5.0.0.0 - 6.0.0.0 - - - mscorlib - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Security.Cryptography - 7.0.0.0 - 8.0.0.0 - - - System.Threading.Tasks.Task - - - - - - - - - The buffer to write data from. - The zero-based byte offset in from which to begin writing bytes to the stream. - The maximum number of bytes to write. - The token to monitor for cancellation requests. The default value is . - Writes a sequence of bytes to the current stream asynchronously, advances the current position within the stream by the number of bytes written, and monitors cancellation requests. - A task that represents the asynchronous write operation. - + The parameter is less than zero. + The sum of the and parameters is longer than the length of the buffer. + Cryptographic Services + + + + + + + + + Method + + System.Security.Cryptography.Primitives + 6.0.0.0 + + + mscorlib + + + netstandard + + + System.Security.Cryptography + 7.0.0.0 + 8.0.0.0 + + + + [System.Runtime.CompilerServices.NullableContext(0)] + [<System.Runtime.CompilerServices.NullableContext(0)>] + + + + System.Threading.Tasks.ValueTask + + + + + + + The region of memory to write data from. + The token to monitor for cancellation requests. The default value is . + 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. + To be added. + The associated with current object does not match the underlying stream. For example, this exception is thrown when using with an underlying stream that is read only. + + The cancellation token was canceled. This exception is stored into the returned task. + + + + + + + + + + Method + + System.Security.Cryptography.Primitives + 4.0.0.0 + 4.1.0.0 + 4.1.1.0 + 4.1.2.0 + 5.0.0.0 + 6.0.0.0 + + + mscorlib + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Security.Cryptography + 7.0.0.0 + 8.0.0.0 + + + System.Threading.Tasks.Task + + + + + + + + + The buffer to write data from. + The zero-based byte offset in from which to begin writing bytes to the stream. + The maximum number of bytes to write. + The token to monitor for cancellation requests. The default value is . + Writes a sequence of bytes to the current stream asynchronously, advances the current position within the stream by the number of bytes written, and monitors cancellation requests. + A task that represents the asynchronous write operation. + , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . -]]> - - - is . - - or is negative. - The sum of and is larger than the buffer length. - The stream does not support writing. - The stream has been disposed. - The stream is currently in use by a previous write operation. - Cancellation - - - - - - - - - - Method - - System.Security.Cryptography.Primitives - 4.1.0.0 - 4.1.1.0 - 4.1.2.0 - 5.0.0.0 - 6.0.0.0 - - - netstandard - 2.1.0.0 - - - System.Security.Cryptography - 7.0.0.0 - 8.0.0.0 - - - System.Void - - - - - - The byte to write to the stream. - Writes a byte to the current position in the stream and advances the position within the stream by one byte. - +]]> + + + is . + + or is negative. + The sum of and is larger than the buffer length. + The stream does not support writing. + The stream has been disposed. + The stream is currently in use by a previous write operation. + Cancellation + The cancellation token was canceled. This exception is stored into the returned task. + + + + + + + + + + Method + + System.Security.Cryptography.Primitives + 4.1.0.0 + 4.1.1.0 + 4.1.2.0 + 5.0.0.0 + 6.0.0.0 + + + netstandard + 2.1.0.0 + + + System.Security.Cryptography + 7.0.0.0 + 8.0.0.0 + + + System.Void + + + + + + The byte to write to the stream. + Writes a byte to the current position in the stream and advances the position within the stream by one byte. + property to determine whether the current instance supports writing. - ]]> - - An I/O error occurs. - The stream does not support writing, or the stream is already closed. - Methods were called after the stream was closed. - - - - + ]]> + + An I/O error occurs. + The stream does not support writing, or the stream is already closed. + Methods were called after the stream was closed. + + + + diff --git a/xml/System.Security.Cryptography/HMACMD5.xml b/xml/System.Security.Cryptography/HMACMD5.xml index c9a2afd8315..c8f2dd6b671 100644 --- a/xml/System.Security.Cryptography/HMACMD5.xml +++ b/xml/System.Security.Cryptography/HMACMD5.xml @@ -693,6 +693,7 @@ or is . does not support reading. + The cancellation token was canceled. This exception is stored into the returned task. @@ -750,6 +751,7 @@ is . does not support reading. + The cancellation token was canceled. This exception is stored into the returned task. @@ -817,6 +819,7 @@ does not support reading. + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.Security.Cryptography/HMACSHA1.xml b/xml/System.Security.Cryptography/HMACSHA1.xml index 063a021a1de..66fa9b2177c 100644 --- a/xml/System.Security.Cryptography/HMACSHA1.xml +++ b/xml/System.Security.Cryptography/HMACSHA1.xml @@ -760,6 +760,7 @@ Releases the unmanaged resources used by the or is . does not support reading. + The cancellation token was canceled. This exception is stored into the returned task. @@ -813,6 +814,7 @@ Releases the unmanaged resources used by the is . does not support reading. + The cancellation token was canceled. This exception is stored into the returned task. @@ -876,6 +878,7 @@ Releases the unmanaged resources used by the does not support reading. + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.Security.Cryptography/HMACSHA256.xml b/xml/System.Security.Cryptography/HMACSHA256.xml index a72d908a91e..92458de99c0 100644 --- a/xml/System.Security.Cryptography/HMACSHA256.xml +++ b/xml/System.Security.Cryptography/HMACSHA256.xml @@ -650,6 +650,7 @@ or is . does not support reading. + The cancellation token was canceled. This exception is stored into the returned task. @@ -703,6 +704,7 @@ is . does not support reading. + The cancellation token was canceled. This exception is stored into the returned task. @@ -766,6 +768,7 @@ does not support reading. + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.Security.Cryptography/HMACSHA384.xml b/xml/System.Security.Cryptography/HMACSHA384.xml index 6612c5252dc..a3b4b69e6e8 100644 --- a/xml/System.Security.Cryptography/HMACSHA384.xml +++ b/xml/System.Security.Cryptography/HMACSHA384.xml @@ -649,6 +649,7 @@ or is . does not support reading. + The cancellation token was canceled. This exception is stored into the returned task. @@ -702,6 +703,7 @@ is . does not support reading. + The cancellation token was canceled. This exception is stored into the returned task. @@ -765,6 +767,7 @@ does not support reading. + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.Security.Cryptography/HMACSHA3_256.xml b/xml/System.Security.Cryptography/HMACSHA3_256.xml index 27454fc1f99..4c549d5a5cd 100644 --- a/xml/System.Security.Cryptography/HMACSHA3_256.xml +++ b/xml/System.Security.Cryptography/HMACSHA3_256.xml @@ -1,344 +1,344 @@ - - - - - - - - - System.Security.Cryptography - 8.0.0.0 - - - System.Security.Cryptography.HMAC - - - - - [System.Runtime.CompilerServices.Nullable(0)] - [<System.Runtime.CompilerServices.Nullable(0)>] - - - [System.Runtime.CompilerServices.NullableContext(1)] - [<System.Runtime.CompilerServices.NullableContext(1)>] - - - - Computes a Hash-based Message Authentication Code (HMAC) by using the SHA3-256 hash function. - To be added. - - - - - - - - - Constructor - - System.Security.Cryptography - 8.0.0.0 - - - - Initializes a new instance of the class with a randomly generated key. - - + + + + + + + + + System.Security.Cryptography + 8.0.0.0 + + + System.Security.Cryptography.HMAC + + + + + [System.Runtime.CompilerServices.Nullable(0)] + [<System.Runtime.CompilerServices.Nullable(0)>] + + + [System.Runtime.CompilerServices.NullableContext(1)] + [<System.Runtime.CompilerServices.NullableContext(1)>] + + + + Computes a Hash-based Message Authentication Code (HMAC) by using the SHA3-256 hash function. + To be added. + + + + + + + + + Constructor + + System.Security.Cryptography + 8.0.0.0 + + + + Initializes a new instance of the class with a randomly generated key. + + is a type of keyed hash algorithm that is constructed from the SHA3-256 hash function and used as a Hash-based Message Authentication Code (HMAC). The HMAC process mixes a secret key with the message data, hashes the result with the hash function, mixes that hash value with the secret key again, and then applies the hash function a second time. The output hash is 256 bits in length. - + This constructor uses a 136-byte, randomly generated key. - - - - - - - - - - - - Constructor - - System.Security.Cryptography - 8.0.0.0 - - - - - - The secret key for . The key can be any length. - Initializes a new instance of the class with the specified key data. - To be added. - - is . - - - - - - - - - - Method - - System.Security.Cryptography - 8.0.0.0 - - - System.Void - - - - - - - to release both managed and unmanaged resources; to release only unmanaged resources. - Releases the unmanaged resources used by the class when a key change is legitimate and optionally releases the managed resources. - To be added. - - - - - - - - - - - Method - - System.Security.Cryptography - 8.0.0.0 - - - - [System.Runtime.CompilerServices.NullableContext(0)] - [<System.Runtime.CompilerServices.NullableContext(0)>] - - - - System.Void - - - - - - The input to compute the HMAC code for. - Routes data written to the object into the HMAC algorithm for computing the HMAC. - To be added. - - - - - - - - - - - Method - - System.Security.Cryptography - 8.0.0.0 - - - System.Void - - - - - - - - The input data. - The offset into the byte array from which to begin using data. - The number of bytes in the array to use as data. - When overridden in a derived class, routes data written to the object into the HMAC algorithm for computing the HMAC value. - To be added. - - - - - - - - - - - Method - - System.Security.Cryptography - 8.0.0.0 - - - System.Byte[] - - - - - - - The HMAC key. - The data to HMAC. - Computes the HMAC of data using the SHA3-256 algorithm. - The HMAC of the data. - To be added. - - or is . - - - - - - - - - - Method - - System.Security.Cryptography - 8.0.0.0 - - - System.Byte[] - - - - - - - The HMAC key. - The stream to HMAC. - Computes the HMAC of a stream using the SHA3-256 algorithm. - The HMAC of the data. - To be added. - - or is . - - does not support reading. - - - - - - - - - - Method - - System.Security.Cryptography - 8.0.0.0 - - - System.Byte[] - - - - - - [System.Runtime.CompilerServices.Nullable(0)] - [<System.Runtime.CompilerServices.Nullable(0)>] - - - - - - - The HMAC key. - The stream to HMAC. - Computes the HMAC of a stream using the SHA3-256 algorithm. - The HMAC of the data. - To be added. - - is . - - does not support reading. - - - - - - - - - - Method - - System.Security.Cryptography - 8.0.0.0 - - - - [System.Runtime.CompilerServices.NullableContext(0)] - [<System.Runtime.CompilerServices.NullableContext(0)>] - - - - System.Byte[] - - - [System.Runtime.CompilerServices.Nullable(1)] - [<System.Runtime.CompilerServices.Nullable(1)>] - - - - - - - - - The HMAC key. - The data to HMAC. - Computes the HMAC of data using the SHA3-256 algorithm. - The HMAC of the data. - To be added. - - - - - - - - - - Method - - System.Security.Cryptography - 8.0.0.0 - - - - [System.Runtime.CompilerServices.NullableContext(0)] - [<System.Runtime.CompilerServices.NullableContext(0)>] - - - - System.Int32 - - - - - - - [System.Runtime.CompilerServices.Nullable(1)] - [<System.Runtime.CompilerServices.Nullable(1)>] - - - - - - - The HMAC key. - The stream to HMAC. - The buffer to receive the HMAC value. - Computes the HMAC of a stream using the SHA3-256 algorithm. - The total number of bytes written to . - To be added. - - is . + + + + + + + + + + + + Constructor + + System.Security.Cryptography + 8.0.0.0 + + + + + + The secret key for . The key can be any length. + Initializes a new instance of the class with the specified key data. + To be added. + + is . + + + + + + + + + + Method + + System.Security.Cryptography + 8.0.0.0 + + + System.Void + + + + + + + to release both managed and unmanaged resources; to release only unmanaged resources. + Releases the unmanaged resources used by the class when a key change is legitimate and optionally releases the managed resources. + To be added. + + + + + + + + + + + Method + + System.Security.Cryptography + 8.0.0.0 + + + + [System.Runtime.CompilerServices.NullableContext(0)] + [<System.Runtime.CompilerServices.NullableContext(0)>] + + + + System.Void + + + + + + The input to compute the HMAC code for. + Routes data written to the object into the HMAC algorithm for computing the HMAC. + To be added. + + + + + + + + + + + Method + + System.Security.Cryptography + 8.0.0.0 + + + System.Void + + + + + + + + The input data. + The offset into the byte array from which to begin using data. + The number of bytes in the array to use as data. + When overridden in a derived class, routes data written to the object into the HMAC algorithm for computing the HMAC value. + To be added. + + + + + + + + + + + Method + + System.Security.Cryptography + 8.0.0.0 + + + System.Byte[] + + + + + + + The HMAC key. + The data to HMAC. + Computes the HMAC of data using the SHA3-256 algorithm. + The HMAC of the data. + To be added. + + or is . + + + + + + + + + + Method + + System.Security.Cryptography + 8.0.0.0 + + + System.Byte[] + + + + + + + The HMAC key. + The stream to HMAC. + Computes the HMAC of a stream using the SHA3-256 algorithm. + The HMAC of the data. + To be added. + + or is . + + does not support reading. + + + + + + + + + + Method + + System.Security.Cryptography + 8.0.0.0 + + + System.Byte[] + + + + + + [System.Runtime.CompilerServices.Nullable(0)] + [<System.Runtime.CompilerServices.Nullable(0)>] + + + + + + + The HMAC key. + The stream to HMAC. + Computes the HMAC of a stream using the SHA3-256 algorithm. + The HMAC of the data. + To be added. + + is . + + does not support reading. + + + + + + + + + + Method + + System.Security.Cryptography + 8.0.0.0 + + + + [System.Runtime.CompilerServices.NullableContext(0)] + [<System.Runtime.CompilerServices.NullableContext(0)>] + + + + System.Byte[] + + + [System.Runtime.CompilerServices.Nullable(1)] + [<System.Runtime.CompilerServices.Nullable(1)>] + + + + + + + + + The HMAC key. + The data to HMAC. + Computes the HMAC of data using the SHA3-256 algorithm. + The HMAC of the data. + To be added. + + + + + + + + + + Method + + System.Security.Cryptography + 8.0.0.0 + + + + [System.Runtime.CompilerServices.NullableContext(0)] + [<System.Runtime.CompilerServices.NullableContext(0)>] + + + + System.Int32 + + + + + + + [System.Runtime.CompilerServices.Nullable(1)] + [<System.Runtime.CompilerServices.Nullable(1)>] + + + + + + + The HMAC key. + The stream to HMAC. + The buffer to receive the HMAC value. + Computes the HMAC of a stream using the SHA3-256 algorithm. + The total number of bytes written to . + To be added. + + is . The buffer in is too small to hold the calculated HMAC @@ -347,181 +347,183 @@ -or- does not support reading. - - - - - - - - - - - Method - - System.Security.Cryptography - 8.0.0.0 - - - - [System.Runtime.CompilerServices.NullableContext(0)] - [<System.Runtime.CompilerServices.NullableContext(0)>] - - - - System.Int32 - - - - - - - - The HMAC key. - The data to HMAC. - The buffer to receive the HMAC value. - Computes the HMAC of data using the SHA3-256 algorithm. - The total number of bytes written to . - To be added. + + + + + + + + + + + Method + + System.Security.Cryptography + 8.0.0.0 + + + + [System.Runtime.CompilerServices.NullableContext(0)] + [<System.Runtime.CompilerServices.NullableContext(0)>] + + + + System.Int32 + + + + + + + + The HMAC key. + The data to HMAC. + The buffer to receive the HMAC value. + Computes the HMAC of data using the SHA3-256 algorithm. + The total number of bytes written to . + To be added. The buffer in is too small to hold the calculated hash - size. The SHA3-256 algorithm always produces a 256-bit HMAC, or 32 bytes. - - - - - - - - - Method - - System.Security.Cryptography - 8.0.0.0 - - - System.Threading.Tasks.ValueTask<System.Byte[]> - - - [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })] - [<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })>] - - - - - - - - - - The HMAC key. - The stream to HMAC. + size. The SHA3-256 algorithm always produces a 256-bit HMAC, or 32 bytes. + + + + + + + + + Method + + System.Security.Cryptography + 8.0.0.0 + + + System.Threading.Tasks.ValueTask<System.Byte[]> + + + [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })] + [<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })>] + + + + + + + + + + The HMAC key. + The stream to HMAC. The token to monitor for cancellation requests. - The default value is . - Asynchronously computes the HMAC of a stream using the SHA3-256 algorithm. - The HMAC of the data. - To be added. - - or is . - - does not support reading. - - - - - - - - - Method - - System.Security.Cryptography - 8.0.0.0 - - - - [System.Runtime.CompilerServices.NullableContext(0)] - [<System.Runtime.CompilerServices.NullableContext(0)>] - - - - System.Threading.Tasks.ValueTask<System.Byte[]> - - - [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })] - [<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })>] - - - - - - - - - [System.Runtime.CompilerServices.Nullable(1)] - [<System.Runtime.CompilerServices.Nullable(1)>] - - - - - - - The HMAC key. - The stream to HMAC. + The default value is . + Asynchronously computes the HMAC of a stream using the SHA3-256 algorithm. + The HMAC of the data. + To be added. + + or is . + + does not support reading. + The cancellation token was canceled. This exception is stored into the returned task. + + + + + + + + + Method + + System.Security.Cryptography + 8.0.0.0 + + + + [System.Runtime.CompilerServices.NullableContext(0)] + [<System.Runtime.CompilerServices.NullableContext(0)>] + + + + System.Threading.Tasks.ValueTask<System.Byte[]> + + + [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })] + [<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })>] + + + + + + + + + [System.Runtime.CompilerServices.Nullable(1)] + [<System.Runtime.CompilerServices.Nullable(1)>] + + + + + + + The HMAC key. + The stream to HMAC. The token to monitor for cancellation requests. - The default value is . - Asynchronously computes the HMAC of a stream using the SHA3-256 algorithm. - The HMAC of the data. - To be added. - - is . - - does not support reading. - - - - - - - - - Method - - System.Security.Cryptography - 8.0.0.0 - - - - [System.Runtime.CompilerServices.NullableContext(0)] - [<System.Runtime.CompilerServices.NullableContext(0)>] - - - - System.Threading.Tasks.ValueTask<System.Int32> - - - - - - - [System.Runtime.CompilerServices.Nullable(1)] - [<System.Runtime.CompilerServices.Nullable(1)>] - - - - - - - - The HMAC key. - The stream to HMAC. - The buffer to receive the HMAC value. + The default value is . + Asynchronously computes the HMAC of a stream using the SHA3-256 algorithm. + The HMAC of the data. + To be added. + + is . + + does not support reading. + The cancellation token was canceled. This exception is stored into the returned task. + + + + + + + + + Method + + System.Security.Cryptography + 8.0.0.0 + + + + [System.Runtime.CompilerServices.NullableContext(0)] + [<System.Runtime.CompilerServices.NullableContext(0)>] + + + + System.Threading.Tasks.ValueTask<System.Int32> + + + + + + + [System.Runtime.CompilerServices.Nullable(1)] + [<System.Runtime.CompilerServices.Nullable(1)>] + + + + + + + + The HMAC key. + The stream to HMAC. + The buffer to receive the HMAC value. The token to monitor for cancellation requests. - The default value is . - Asynchronously computes the HMAC of a stream using the SHA3-256 algorithm. - The total number of bytes written to . - To be added. - - is . + The default value is . + Asynchronously computes the HMAC of a stream using the SHA3-256 algorithm. + The total number of bytes written to . + To be added. + + is . The buffer in is too small to hold the calculated hash @@ -530,212 +532,213 @@ -or- does not support reading. - - - - - - - - - - - Method - - System.Security.Cryptography - 8.0.0.0 - - - System.Byte[] - - - - When overridden in a derived class, finalizes the HMAC computation after the last data is processed by the algorithm. - The computed HMAC value in a byte array. - To be added. - - - - - - - - - - - Field - - System.Security.Cryptography - 8.0.0.0 - - - System.Int32 - - 256 - - The hash size produced by the HMAC SHA3-256 algorithm, in bits. - To be added. - - - - - - - - - - Field - - System.Security.Cryptography - 8.0.0.0 - - - System.Int32 - - 32 - - The hash size produced by the HMAC SHA3-256 algorithm, in bytes. - To be added. - - - - - - - - - - Method - - System.Security.Cryptography - 8.0.0.0 - - - System.Void - - - - Initializes an instance of the default implementation of . - To be added. - - - - - - - - - - - Property - - System.Security.Cryptography - 8.0.0.0 - - - System.Boolean - - - Gets a value that indicates whether the algorithm is supported on the current platform. - - if the algorithm is supported; otherwise, . - To be added. - - - - - - - - - - Property - - System.Security.Cryptography - 8.0.0.0 - - - System.Byte[] - - - Gets or sets the key to use in the HMAC calculation. - The key to use in the HMAC calculation. - To be added. - - - - - - - - - - - Method - - System.Security.Cryptography - 8.0.0.0 - - - - [System.Runtime.CompilerServices.NullableContext(0)] - [<System.Runtime.CompilerServices.NullableContext(0)>] - - - - System.Boolean - - - - - - - - - The HMAC key. - The data to HMAC. - The buffer to receive the HMAC value. - When this method returns, the total number of bytes written into . - Attempts to compute the HMAC of data using the SHA3-256 algorithm. - - if is too small to hold the calculated hash, otherwise. - To be added. - - - - - - - - - - Method - - System.Security.Cryptography - 8.0.0.0 - - - - [System.Runtime.CompilerServices.NullableContext(0)] - [<System.Runtime.CompilerServices.NullableContext(0)>] - - - - System.Boolean - - - - - - - The buffer to receive the HMAC value. - When this method returns, contains the total number of bytes written into . This parameter is treated as uninitialized. - Attempts to finalize the HMAC computation after the last data is processed by the HMAC algorithm. - - if is long enough to receive the HMAC value; otherwise, . - To be added. - - - - - + + The cancellation token was canceled. This exception is stored into the returned task. + + + + + + + + + + Method + + System.Security.Cryptography + 8.0.0.0 + + + System.Byte[] + + + + When overridden in a derived class, finalizes the HMAC computation after the last data is processed by the algorithm. + The computed HMAC value in a byte array. + To be added. + + + + + + + + + + + Field + + System.Security.Cryptography + 8.0.0.0 + + + System.Int32 + + 256 + + The hash size produced by the HMAC SHA3-256 algorithm, in bits. + To be added. + + + + + + + + + + Field + + System.Security.Cryptography + 8.0.0.0 + + + System.Int32 + + 32 + + The hash size produced by the HMAC SHA3-256 algorithm, in bytes. + To be added. + + + + + + + + + + Method + + System.Security.Cryptography + 8.0.0.0 + + + System.Void + + + + Initializes an instance of the default implementation of . + To be added. + + + + + + + + + + + Property + + System.Security.Cryptography + 8.0.0.0 + + + System.Boolean + + + Gets a value that indicates whether the algorithm is supported on the current platform. + + if the algorithm is supported; otherwise, . + To be added. + + + + + + + + + + Property + + System.Security.Cryptography + 8.0.0.0 + + + System.Byte[] + + + Gets or sets the key to use in the HMAC calculation. + The key to use in the HMAC calculation. + To be added. + + + + + + + + + + + Method + + System.Security.Cryptography + 8.0.0.0 + + + + [System.Runtime.CompilerServices.NullableContext(0)] + [<System.Runtime.CompilerServices.NullableContext(0)>] + + + + System.Boolean + + + + + + + + + The HMAC key. + The data to HMAC. + The buffer to receive the HMAC value. + When this method returns, the total number of bytes written into . + Attempts to compute the HMAC of data using the SHA3-256 algorithm. + + if is too small to hold the calculated hash, otherwise. + To be added. + + + + + + + + + + Method + + System.Security.Cryptography + 8.0.0.0 + + + + [System.Runtime.CompilerServices.NullableContext(0)] + [<System.Runtime.CompilerServices.NullableContext(0)>] + + + + System.Boolean + + + + + + + The buffer to receive the HMAC value. + When this method returns, contains the total number of bytes written into . This parameter is treated as uninitialized. + Attempts to finalize the HMAC computation after the last data is processed by the HMAC algorithm. + + if is long enough to receive the HMAC value; otherwise, . + To be added. + + + + + diff --git a/xml/System.Security.Cryptography/HMACSHA3_384.xml b/xml/System.Security.Cryptography/HMACSHA3_384.xml index 74d049615c3..22bd7716594 100644 --- a/xml/System.Security.Cryptography/HMACSHA3_384.xml +++ b/xml/System.Security.Cryptography/HMACSHA3_384.xml @@ -1,344 +1,344 @@ - - - - - - - - - System.Security.Cryptography - 8.0.0.0 - - - System.Security.Cryptography.HMAC - - - - - [System.Runtime.CompilerServices.Nullable(0)] - [<System.Runtime.CompilerServices.Nullable(0)>] - - - [System.Runtime.CompilerServices.NullableContext(1)] - [<System.Runtime.CompilerServices.NullableContext(1)>] - - - - Computes a Hash-based Message Authentication Code (HMAC) by using the SHA3-384 hash function. - To be added. - - - - - - - - - Constructor - - System.Security.Cryptography - 8.0.0.0 - - - - Initializes a new instance of the class with a randomly generated key. - - + + + + + + + + + System.Security.Cryptography + 8.0.0.0 + + + System.Security.Cryptography.HMAC + + + + + [System.Runtime.CompilerServices.Nullable(0)] + [<System.Runtime.CompilerServices.Nullable(0)>] + + + [System.Runtime.CompilerServices.NullableContext(1)] + [<System.Runtime.CompilerServices.NullableContext(1)>] + + + + Computes a Hash-based Message Authentication Code (HMAC) by using the SHA3-384 hash function. + To be added. + + + + + + + + + Constructor + + System.Security.Cryptography + 8.0.0.0 + + + + Initializes a new instance of the class with a randomly generated key. + + is a type of keyed hash algorithm that is constructed from the SHA3-384 hash function and used as a Hash-based Message Authentication Code (HMAC). The HMAC process mixes a secret key with the message data, hashes the result with the hash function, mixes that hash value with the secret key again, and then applies the hash function a second time. The output hash is 384 bits in length. - + This constructor uses a 104-byte, randomly generated key. - - - - - - - - - - - - Constructor - - System.Security.Cryptography - 8.0.0.0 - - - - - - The secret key for . The key can be any length. - Initializes a new instance of the class with the specified key data. - To be added. - - is . - - - - - - - - - - Method - - System.Security.Cryptography - 8.0.0.0 - - - System.Void - - - - - - - to release both managed and unmanaged resources; to release only unmanaged resources. - Releases the unmanaged resources used by the class when a key change is legitimate and optionally releases the managed resources. - To be added. - - - - - - - - - - - Method - - System.Security.Cryptography - 8.0.0.0 - - - - [System.Runtime.CompilerServices.NullableContext(0)] - [<System.Runtime.CompilerServices.NullableContext(0)>] - - - - System.Void - - - - - - The input to compute the HMAC code for. - Routes data written to the object into the HMAC algorithm for computing the HMAC. - To be added. - - - - - - - - - - - Method - - System.Security.Cryptography - 8.0.0.0 - - - System.Void - - - - - - - - The input data. - The offset into the byte array from which to begin using data. - The number of bytes in the array to use as data. - When overridden in a derived class, routes data written to the object into the HMAC algorithm for computing the HMAC value. - To be added. - - - - - - - - - - - Method - - System.Security.Cryptography - 8.0.0.0 - - - System.Byte[] - - - - - - - The HMAC key. - The data to HMAC. - Computes the HMAC of data using the SHA3-384 algorithm. - The HMAC of the data. - To be added. - - or is . - - - - - - - - - - Method - - System.Security.Cryptography - 8.0.0.0 - - - System.Byte[] - - - - - - - The HMAC key. - The stream to HMAC. - Computes the HMAC of a stream using the SHA3-384 algorithm. - The HMAC of the data. - To be added. - - or is . - - does not support reading. - - - - - - - - - - Method - - System.Security.Cryptography - 8.0.0.0 - - - System.Byte[] - - - - - - [System.Runtime.CompilerServices.Nullable(0)] - [<System.Runtime.CompilerServices.Nullable(0)>] - - - - - - - The HMAC key. - The stream to HMAC. - Computes the HMAC of a stream using the SHA3-384 algorithm. - The HMAC of the data. - To be added. - - is . - - does not support reading. - - - - - - - - - - Method - - System.Security.Cryptography - 8.0.0.0 - - - - [System.Runtime.CompilerServices.NullableContext(0)] - [<System.Runtime.CompilerServices.NullableContext(0)>] - - - - System.Byte[] - - - [System.Runtime.CompilerServices.Nullable(1)] - [<System.Runtime.CompilerServices.Nullable(1)>] - - - - - - - - - The HMAC key. - The data to HMAC. - Computes the HMAC of data using the SHA3-384 algorithm. - The HMAC of the data. - To be added. - - - - - - - - - - Method - - System.Security.Cryptography - 8.0.0.0 - - - - [System.Runtime.CompilerServices.NullableContext(0)] - [<System.Runtime.CompilerServices.NullableContext(0)>] - - - - System.Int32 - - - - - - - [System.Runtime.CompilerServices.Nullable(1)] - [<System.Runtime.CompilerServices.Nullable(1)>] - - - - - - - The HMAC key. - The stream to HMAC. - The buffer to receive the HMAC value. - Computes the HMAC of a stream using the SHA3-384 algorithm. - The total number of bytes written to . - To be added. - - is . + + + + + + + + + + + + Constructor + + System.Security.Cryptography + 8.0.0.0 + + + + + + The secret key for . The key can be any length. + Initializes a new instance of the class with the specified key data. + To be added. + + is . + + + + + + + + + + Method + + System.Security.Cryptography + 8.0.0.0 + + + System.Void + + + + + + + to release both managed and unmanaged resources; to release only unmanaged resources. + Releases the unmanaged resources used by the class when a key change is legitimate and optionally releases the managed resources. + To be added. + + + + + + + + + + + Method + + System.Security.Cryptography + 8.0.0.0 + + + + [System.Runtime.CompilerServices.NullableContext(0)] + [<System.Runtime.CompilerServices.NullableContext(0)>] + + + + System.Void + + + + + + The input to compute the HMAC code for. + Routes data written to the object into the HMAC algorithm for computing the HMAC. + To be added. + + + + + + + + + + + Method + + System.Security.Cryptography + 8.0.0.0 + + + System.Void + + + + + + + + The input data. + The offset into the byte array from which to begin using data. + The number of bytes in the array to use as data. + When overridden in a derived class, routes data written to the object into the HMAC algorithm for computing the HMAC value. + To be added. + + + + + + + + + + + Method + + System.Security.Cryptography + 8.0.0.0 + + + System.Byte[] + + + + + + + The HMAC key. + The data to HMAC. + Computes the HMAC of data using the SHA3-384 algorithm. + The HMAC of the data. + To be added. + + or is . + + + + + + + + + + Method + + System.Security.Cryptography + 8.0.0.0 + + + System.Byte[] + + + + + + + The HMAC key. + The stream to HMAC. + Computes the HMAC of a stream using the SHA3-384 algorithm. + The HMAC of the data. + To be added. + + or is . + + does not support reading. + + + + + + + + + + Method + + System.Security.Cryptography + 8.0.0.0 + + + System.Byte[] + + + + + + [System.Runtime.CompilerServices.Nullable(0)] + [<System.Runtime.CompilerServices.Nullable(0)>] + + + + + + + The HMAC key. + The stream to HMAC. + Computes the HMAC of a stream using the SHA3-384 algorithm. + The HMAC of the data. + To be added. + + is . + + does not support reading. + + + + + + + + + + Method + + System.Security.Cryptography + 8.0.0.0 + + + + [System.Runtime.CompilerServices.NullableContext(0)] + [<System.Runtime.CompilerServices.NullableContext(0)>] + + + + System.Byte[] + + + [System.Runtime.CompilerServices.Nullable(1)] + [<System.Runtime.CompilerServices.Nullable(1)>] + + + + + + + + + The HMAC key. + The data to HMAC. + Computes the HMAC of data using the SHA3-384 algorithm. + The HMAC of the data. + To be added. + + + + + + + + + + Method + + System.Security.Cryptography + 8.0.0.0 + + + + [System.Runtime.CompilerServices.NullableContext(0)] + [<System.Runtime.CompilerServices.NullableContext(0)>] + + + + System.Int32 + + + + + + + [System.Runtime.CompilerServices.Nullable(1)] + [<System.Runtime.CompilerServices.Nullable(1)>] + + + + + + + The HMAC key. + The stream to HMAC. + The buffer to receive the HMAC value. + Computes the HMAC of a stream using the SHA3-384 algorithm. + The total number of bytes written to . + To be added. + + is . The buffer in is too small to hold the calculated HMAC @@ -347,181 +347,183 @@ -or- does not support reading. - - - - - - - - - - - Method - - System.Security.Cryptography - 8.0.0.0 - - - - [System.Runtime.CompilerServices.NullableContext(0)] - [<System.Runtime.CompilerServices.NullableContext(0)>] - - - - System.Int32 - - - - - - - - The HMAC key. - The data to HMAC. - The buffer to receive the HMAC value. - Computes the HMAC of data using the SHA3-384 algorithm. - The total number of bytes written to . - To be added. + + + + + + + + + + + Method + + System.Security.Cryptography + 8.0.0.0 + + + + [System.Runtime.CompilerServices.NullableContext(0)] + [<System.Runtime.CompilerServices.NullableContext(0)>] + + + + System.Int32 + + + + + + + + The HMAC key. + The data to HMAC. + The buffer to receive the HMAC value. + Computes the HMAC of data using the SHA3-384 algorithm. + The total number of bytes written to . + To be added. The buffer in is too small to hold the calculated hash - size. The SHA3-384 algorithm always produces a 384-bit HMAC, or 48 bytes. - - - - - - - - - Method - - System.Security.Cryptography - 8.0.0.0 - - - System.Threading.Tasks.ValueTask<System.Byte[]> - - - [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })] - [<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })>] - - - - - - - - - - The HMAC key. - The stream to HMAC. + size. The SHA3-384 algorithm always produces a 384-bit HMAC, or 48 bytes. + + + + + + + + + Method + + System.Security.Cryptography + 8.0.0.0 + + + System.Threading.Tasks.ValueTask<System.Byte[]> + + + [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })] + [<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })>] + + + + + + + + + + The HMAC key. + The stream to HMAC. The token to monitor for cancellation requests. - The default value is . - Asynchronously computes the HMAC of a stream using the SHA3-384 algorithm. - The HMAC of the data. - To be added. - - or is . - - does not support reading. - - - - - - - - - Method - - System.Security.Cryptography - 8.0.0.0 - - - - [System.Runtime.CompilerServices.NullableContext(0)] - [<System.Runtime.CompilerServices.NullableContext(0)>] - - - - System.Threading.Tasks.ValueTask<System.Byte[]> - - - [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })] - [<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })>] - - - - - - - - - [System.Runtime.CompilerServices.Nullable(1)] - [<System.Runtime.CompilerServices.Nullable(1)>] - - - - - - - The HMAC key. - The stream to HMAC. + The default value is . + Asynchronously computes the HMAC of a stream using the SHA3-384 algorithm. + The HMAC of the data. + To be added. + + or is . + + does not support reading. + The cancellation token was canceled. This exception is stored into the returned task. + + + + + + + + + Method + + System.Security.Cryptography + 8.0.0.0 + + + + [System.Runtime.CompilerServices.NullableContext(0)] + [<System.Runtime.CompilerServices.NullableContext(0)>] + + + + System.Threading.Tasks.ValueTask<System.Byte[]> + + + [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })] + [<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })>] + + + + + + + + + [System.Runtime.CompilerServices.Nullable(1)] + [<System.Runtime.CompilerServices.Nullable(1)>] + + + + + + + The HMAC key. + The stream to HMAC. The token to monitor for cancellation requests. - The default value is . - Asynchronously computes the HMAC of a stream using the SHA3-384 algorithm. - The HMAC of the data. - To be added. - - is . - - does not support reading. - - - - - - - - - Method - - System.Security.Cryptography - 8.0.0.0 - - - - [System.Runtime.CompilerServices.NullableContext(0)] - [<System.Runtime.CompilerServices.NullableContext(0)>] - - - - System.Threading.Tasks.ValueTask<System.Int32> - - - - - - - [System.Runtime.CompilerServices.Nullable(1)] - [<System.Runtime.CompilerServices.Nullable(1)>] - - - - - - - - The HMAC key. - The stream to HMAC. - The buffer to receive the HMAC value. + The default value is . + Asynchronously computes the HMAC of a stream using the SHA3-384 algorithm. + The HMAC of the data. + To be added. + + is . + + does not support reading. + The cancellation token was canceled. This exception is stored into the returned task. + + + + + + + + + Method + + System.Security.Cryptography + 8.0.0.0 + + + + [System.Runtime.CompilerServices.NullableContext(0)] + [<System.Runtime.CompilerServices.NullableContext(0)>] + + + + System.Threading.Tasks.ValueTask<System.Int32> + + + + + + + [System.Runtime.CompilerServices.Nullable(1)] + [<System.Runtime.CompilerServices.Nullable(1)>] + + + + + + + + The HMAC key. + The stream to HMAC. + The buffer to receive the HMAC value. The token to monitor for cancellation requests. - The default value is . - Asynchronously computes the HMAC of a stream using the SHA3-384 algorithm. - The total number of bytes written to . - To be added. - - is . + The default value is . + Asynchronously computes the HMAC of a stream using the SHA3-384 algorithm. + The total number of bytes written to . + To be added. + + is . The buffer in is too small to hold the calculated hash @@ -530,212 +532,213 @@ -or- does not support reading. - - - - - - - - - - - Method - - System.Security.Cryptography - 8.0.0.0 - - - System.Byte[] - - - - When overridden in a derived class, finalizes the HMAC computation after the last data is processed by the algorithm. - The computed HMAC value in a byte array. - To be added. - - - - - - - - - - - Field - - System.Security.Cryptography - 8.0.0.0 - - - System.Int32 - - 384 - - The hash size produced by the HMAC SHA3-384 algorithm, in bits. - To be added. - - - - - - - - - - Field - - System.Security.Cryptography - 8.0.0.0 - - - System.Int32 - - 48 - - The hash size produced by the HMAC SHA3-384 algorithm, in bytes. - To be added. - - - - - - - - - - Method - - System.Security.Cryptography - 8.0.0.0 - - - System.Void - - - - Initializes an instance of the default implementation of . - To be added. - - - - - - - - - - - Property - - System.Security.Cryptography - 8.0.0.0 - - - System.Boolean - - - Gets a value that indicates whether the algorithm is supported on the current platform. - - if the algorithm is supported; otherwise, . - To be added. - - - - - - - - - - Property - - System.Security.Cryptography - 8.0.0.0 - - - System.Byte[] - - - Gets or sets the key to use in the HMAC calculation. - The key to use in the HMAC calculation. - To be added. - - - - - - - - - - - Method - - System.Security.Cryptography - 8.0.0.0 - - - - [System.Runtime.CompilerServices.NullableContext(0)] - [<System.Runtime.CompilerServices.NullableContext(0)>] - - - - System.Boolean - - - - - - - - - The HMAC key. - The data to HMAC. - The buffer to receive the HMAC value. - When this method returns, the total number of bytes written into . - Attempts to compute the HMAC of data using the SHA3-384 algorithm. - - if is too small to hold the calculated hash, otherwise. - To be added. - - - - - - - - - - Method - - System.Security.Cryptography - 8.0.0.0 - - - - [System.Runtime.CompilerServices.NullableContext(0)] - [<System.Runtime.CompilerServices.NullableContext(0)>] - - - - System.Boolean - - - - - - - The buffer to receive the HMAC value. - When this method returns, contains the total number of bytes written into . This parameter is treated as uninitialized. - Attempts to finalize the HMAC computation after the last data is processed by the HMAC algorithm. - - if is long enough to receive the HMAC value; otherwise, . - To be added. - - - - - + + The cancellation token was canceled. This exception is stored into the returned task. + + + + + + + + + + Method + + System.Security.Cryptography + 8.0.0.0 + + + System.Byte[] + + + + When overridden in a derived class, finalizes the HMAC computation after the last data is processed by the algorithm. + The computed HMAC value in a byte array. + To be added. + + + + + + + + + + + Field + + System.Security.Cryptography + 8.0.0.0 + + + System.Int32 + + 384 + + The hash size produced by the HMAC SHA3-384 algorithm, in bits. + To be added. + + + + + + + + + + Field + + System.Security.Cryptography + 8.0.0.0 + + + System.Int32 + + 48 + + The hash size produced by the HMAC SHA3-384 algorithm, in bytes. + To be added. + + + + + + + + + + Method + + System.Security.Cryptography + 8.0.0.0 + + + System.Void + + + + Initializes an instance of the default implementation of . + To be added. + + + + + + + + + + + Property + + System.Security.Cryptography + 8.0.0.0 + + + System.Boolean + + + Gets a value that indicates whether the algorithm is supported on the current platform. + + if the algorithm is supported; otherwise, . + To be added. + + + + + + + + + + Property + + System.Security.Cryptography + 8.0.0.0 + + + System.Byte[] + + + Gets or sets the key to use in the HMAC calculation. + The key to use in the HMAC calculation. + To be added. + + + + + + + + + + + Method + + System.Security.Cryptography + 8.0.0.0 + + + + [System.Runtime.CompilerServices.NullableContext(0)] + [<System.Runtime.CompilerServices.NullableContext(0)>] + + + + System.Boolean + + + + + + + + + The HMAC key. + The data to HMAC. + The buffer to receive the HMAC value. + When this method returns, the total number of bytes written into . + Attempts to compute the HMAC of data using the SHA3-384 algorithm. + + if is too small to hold the calculated hash, otherwise. + To be added. + + + + + + + + + + Method + + System.Security.Cryptography + 8.0.0.0 + + + + [System.Runtime.CompilerServices.NullableContext(0)] + [<System.Runtime.CompilerServices.NullableContext(0)>] + + + + System.Boolean + + + + + + + The buffer to receive the HMAC value. + When this method returns, contains the total number of bytes written into . This parameter is treated as uninitialized. + Attempts to finalize the HMAC computation after the last data is processed by the HMAC algorithm. + + if is long enough to receive the HMAC value; otherwise, . + To be added. + + + + + diff --git a/xml/System.Security.Cryptography/HMACSHA3_512.xml b/xml/System.Security.Cryptography/HMACSHA3_512.xml index d8cd30ac8fb..670d9b6d694 100644 --- a/xml/System.Security.Cryptography/HMACSHA3_512.xml +++ b/xml/System.Security.Cryptography/HMACSHA3_512.xml @@ -1,344 +1,344 @@ - - - - - - - - - System.Security.Cryptography - 8.0.0.0 - - - System.Security.Cryptography.HMAC - - - - - [System.Runtime.CompilerServices.Nullable(0)] - [<System.Runtime.CompilerServices.Nullable(0)>] - - - [System.Runtime.CompilerServices.NullableContext(1)] - [<System.Runtime.CompilerServices.NullableContext(1)>] - - - - Computes a Hash-based Message Authentication Code (HMAC) by using the SHA3-512 hash function. - To be added. - - - - - - - - - Constructor - - System.Security.Cryptography - 8.0.0.0 - - - - Initializes a new instance of the class with a randomly generated key. - - + + + + + + + + + System.Security.Cryptography + 8.0.0.0 + + + System.Security.Cryptography.HMAC + + + + + [System.Runtime.CompilerServices.Nullable(0)] + [<System.Runtime.CompilerServices.Nullable(0)>] + + + [System.Runtime.CompilerServices.NullableContext(1)] + [<System.Runtime.CompilerServices.NullableContext(1)>] + + + + Computes a Hash-based Message Authentication Code (HMAC) by using the SHA3-512 hash function. + To be added. + + + + + + + + + Constructor + + System.Security.Cryptography + 8.0.0.0 + + + + Initializes a new instance of the class with a randomly generated key. + + is a type of keyed hash algorithm that is constructed from the SHA3-512 hash function and used as a Hash-based Message Authentication Code (HMAC). The HMAC process mixes a secret key with the message data, hashes the result with the hash function, mixes that hash value with the secret key again, and then applies the hash function a second time. The output hash is 512 bits in length. - + This constructor uses a 72-byte, randomly generated key. - - - - - - - - - - - - Constructor - - System.Security.Cryptography - 8.0.0.0 - - - - - - The secret key for . The key can be any length. - Initializes a new instance of the class with the specified key data. - To be added. - - is . - - - - - - - - - - Method - - System.Security.Cryptography - 8.0.0.0 - - - System.Void - - - - - - - to release both managed and unmanaged resources; to release only unmanaged resources. - Releases the unmanaged resources used by the class when a key change is legitimate and optionally releases the managed resources. - To be added. - - - - - - - - - - - Method - - System.Security.Cryptography - 8.0.0.0 - - - - [System.Runtime.CompilerServices.NullableContext(0)] - [<System.Runtime.CompilerServices.NullableContext(0)>] - - - - System.Void - - - - - - The input to compute the HMAC code for. - Routes data written to the object into the HMAC algorithm for computing the HMAC. - To be added. - - - - - - - - - - - Method - - System.Security.Cryptography - 8.0.0.0 - - - System.Void - - - - - - - - The input data. - The offset into the byte array from which to begin using data. - The number of bytes in the array to use as data. - When overridden in a derived class, routes data written to the object into the HMAC algorithm for computing the HMAC value. - To be added. - - - - - - - - - - - Method - - System.Security.Cryptography - 8.0.0.0 - - - System.Byte[] - - - - - - - The HMAC key. - The data to HMAC. - Computes the HMAC of data using the SHA3-512 algorithm. - The HMAC of the data. - To be added. - - or is . - - - - - - - - - - Method - - System.Security.Cryptography - 8.0.0.0 - - - System.Byte[] - - - - - - - The HMAC key. - The stream to HMAC. - Computes the HMAC of a stream using the SHA3-512 algorithm. - The HMAC of the data. - To be added. - - or is . - - does not support reading. - - - - - - - - - - Method - - System.Security.Cryptography - 8.0.0.0 - - - System.Byte[] - - - - - - [System.Runtime.CompilerServices.Nullable(0)] - [<System.Runtime.CompilerServices.Nullable(0)>] - - - - - - - The HMAC key. - The stream to HMAC. - Computes the HMAC of a stream using the SHA3-512 algorithm. - The HMAC of the data. - To be added. - - is . - - does not support reading. - - - - - - - - - - Method - - System.Security.Cryptography - 8.0.0.0 - - - - [System.Runtime.CompilerServices.NullableContext(0)] - [<System.Runtime.CompilerServices.NullableContext(0)>] - - - - System.Byte[] - - - [System.Runtime.CompilerServices.Nullable(1)] - [<System.Runtime.CompilerServices.Nullable(1)>] - - - - - - - - - The HMAC key. - The data to HMAC. - Computes the HMAC of data using the SHA3-512 algorithm. - The HMAC of the data. - To be added. - - - - - - - - - - Method - - System.Security.Cryptography - 8.0.0.0 - - - - [System.Runtime.CompilerServices.NullableContext(0)] - [<System.Runtime.CompilerServices.NullableContext(0)>] - - - - System.Int32 - - - - - - - [System.Runtime.CompilerServices.Nullable(1)] - [<System.Runtime.CompilerServices.Nullable(1)>] - - - - - - - The HMAC key. - The stream to HMAC. - The buffer to receive the HMAC value. - Computes the HMAC of a stream using the SHA3-512 algorithm. - The total number of bytes written to . - To be added. - - is . + + + + + + + + + + + + Constructor + + System.Security.Cryptography + 8.0.0.0 + + + + + + The secret key for . The key can be any length. + Initializes a new instance of the class with the specified key data. + To be added. + + is . + + + + + + + + + + Method + + System.Security.Cryptography + 8.0.0.0 + + + System.Void + + + + + + + to release both managed and unmanaged resources; to release only unmanaged resources. + Releases the unmanaged resources used by the class when a key change is legitimate and optionally releases the managed resources. + To be added. + + + + + + + + + + + Method + + System.Security.Cryptography + 8.0.0.0 + + + + [System.Runtime.CompilerServices.NullableContext(0)] + [<System.Runtime.CompilerServices.NullableContext(0)>] + + + + System.Void + + + + + + The input to compute the HMAC code for. + Routes data written to the object into the HMAC algorithm for computing the HMAC. + To be added. + + + + + + + + + + + Method + + System.Security.Cryptography + 8.0.0.0 + + + System.Void + + + + + + + + The input data. + The offset into the byte array from which to begin using data. + The number of bytes in the array to use as data. + When overridden in a derived class, routes data written to the object into the HMAC algorithm for computing the HMAC value. + To be added. + + + + + + + + + + + Method + + System.Security.Cryptography + 8.0.0.0 + + + System.Byte[] + + + + + + + The HMAC key. + The data to HMAC. + Computes the HMAC of data using the SHA3-512 algorithm. + The HMAC of the data. + To be added. + + or is . + + + + + + + + + + Method + + System.Security.Cryptography + 8.0.0.0 + + + System.Byte[] + + + + + + + The HMAC key. + The stream to HMAC. + Computes the HMAC of a stream using the SHA3-512 algorithm. + The HMAC of the data. + To be added. + + or is . + + does not support reading. + + + + + + + + + + Method + + System.Security.Cryptography + 8.0.0.0 + + + System.Byte[] + + + + + + [System.Runtime.CompilerServices.Nullable(0)] + [<System.Runtime.CompilerServices.Nullable(0)>] + + + + + + + The HMAC key. + The stream to HMAC. + Computes the HMAC of a stream using the SHA3-512 algorithm. + The HMAC of the data. + To be added. + + is . + + does not support reading. + + + + + + + + + + Method + + System.Security.Cryptography + 8.0.0.0 + + + + [System.Runtime.CompilerServices.NullableContext(0)] + [<System.Runtime.CompilerServices.NullableContext(0)>] + + + + System.Byte[] + + + [System.Runtime.CompilerServices.Nullable(1)] + [<System.Runtime.CompilerServices.Nullable(1)>] + + + + + + + + + The HMAC key. + The data to HMAC. + Computes the HMAC of data using the SHA3-512 algorithm. + The HMAC of the data. + To be added. + + + + + + + + + + Method + + System.Security.Cryptography + 8.0.0.0 + + + + [System.Runtime.CompilerServices.NullableContext(0)] + [<System.Runtime.CompilerServices.NullableContext(0)>] + + + + System.Int32 + + + + + + + [System.Runtime.CompilerServices.Nullable(1)] + [<System.Runtime.CompilerServices.Nullable(1)>] + + + + + + + The HMAC key. + The stream to HMAC. + The buffer to receive the HMAC value. + Computes the HMAC of a stream using the SHA3-512 algorithm. + The total number of bytes written to . + To be added. + + is . The buffer in is too small to hold the calculated HMAC @@ -347,181 +347,183 @@ -or- does not support reading. - - - - - - - - - - - Method - - System.Security.Cryptography - 8.0.0.0 - - - - [System.Runtime.CompilerServices.NullableContext(0)] - [<System.Runtime.CompilerServices.NullableContext(0)>] - - - - System.Int32 - - - - - - - - The HMAC key. - The data to HMAC. - The buffer to receive the HMAC value. - Computes the HMAC of data using the SHA3-512 algorithm. - The total number of bytes written to . - To be added. + + + + + + + + + + + Method + + System.Security.Cryptography + 8.0.0.0 + + + + [System.Runtime.CompilerServices.NullableContext(0)] + [<System.Runtime.CompilerServices.NullableContext(0)>] + + + + System.Int32 + + + + + + + + The HMAC key. + The data to HMAC. + The buffer to receive the HMAC value. + Computes the HMAC of data using the SHA3-512 algorithm. + The total number of bytes written to . + To be added. The buffer in is too small to hold the calculated hash - size. The SHA3-512 algorithm always produces a 512-bit HMAC, or 64 bytes. - - - - - - - - - Method - - System.Security.Cryptography - 8.0.0.0 - - - System.Threading.Tasks.ValueTask<System.Byte[]> - - - [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })] - [<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })>] - - - - - - - - - - The HMAC key. - The stream to HMAC. + size. The SHA3-512 algorithm always produces a 512-bit HMAC, or 64 bytes. + + + + + + + + + Method + + System.Security.Cryptography + 8.0.0.0 + + + System.Threading.Tasks.ValueTask<System.Byte[]> + + + [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })] + [<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })>] + + + + + + + + + + The HMAC key. + The stream to HMAC. The token to monitor for cancellation requests. - The default value is . - Asynchronously computes the HMAC of a stream using the SHA3-512 algorithm. - The HMAC of the data. - To be added. - - or is . - - does not support reading. - - - - - - - - - Method - - System.Security.Cryptography - 8.0.0.0 - - - - [System.Runtime.CompilerServices.NullableContext(0)] - [<System.Runtime.CompilerServices.NullableContext(0)>] - - - - System.Threading.Tasks.ValueTask<System.Byte[]> - - - [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })] - [<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })>] - - - - - - - - - [System.Runtime.CompilerServices.Nullable(1)] - [<System.Runtime.CompilerServices.Nullable(1)>] - - - - - - - The HMAC key. - The stream to HMAC. + The default value is . + Asynchronously computes the HMAC of a stream using the SHA3-512 algorithm. + The HMAC of the data. + To be added. + + or is . + + does not support reading. + The cancellation token was canceled. This exception is stored into the returned task. + + + + + + + + + Method + + System.Security.Cryptography + 8.0.0.0 + + + + [System.Runtime.CompilerServices.NullableContext(0)] + [<System.Runtime.CompilerServices.NullableContext(0)>] + + + + System.Threading.Tasks.ValueTask<System.Byte[]> + + + [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })] + [<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })>] + + + + + + + + + [System.Runtime.CompilerServices.Nullable(1)] + [<System.Runtime.CompilerServices.Nullable(1)>] + + + + + + + The HMAC key. + The stream to HMAC. The token to monitor for cancellation requests. - The default value is . - Asynchronously computes the HMAC of a stream using the SHA3-512 algorithm. - The HMAC of the data. - To be added. - - is . - - does not support reading. - - - - - - - - - Method - - System.Security.Cryptography - 8.0.0.0 - - - - [System.Runtime.CompilerServices.NullableContext(0)] - [<System.Runtime.CompilerServices.NullableContext(0)>] - - - - System.Threading.Tasks.ValueTask<System.Int32> - - - - - - - [System.Runtime.CompilerServices.Nullable(1)] - [<System.Runtime.CompilerServices.Nullable(1)>] - - - - - - - - The HMAC key. - The stream to HMAC. - The buffer to receive the HMAC value. + The default value is . + Asynchronously computes the HMAC of a stream using the SHA3-512 algorithm. + The HMAC of the data. + To be added. + + is . + + does not support reading. + The cancellation token was canceled. This exception is stored into the returned task. + + + + + + + + + Method + + System.Security.Cryptography + 8.0.0.0 + + + + [System.Runtime.CompilerServices.NullableContext(0)] + [<System.Runtime.CompilerServices.NullableContext(0)>] + + + + System.Threading.Tasks.ValueTask<System.Int32> + + + + + + + [System.Runtime.CompilerServices.Nullable(1)] + [<System.Runtime.CompilerServices.Nullable(1)>] + + + + + + + + The HMAC key. + The stream to HMAC. + The buffer to receive the HMAC value. The token to monitor for cancellation requests. - The default value is . - Asynchronously computes the HMAC of a stream using the SHA3-512 algorithm. - The total number of bytes written to . - To be added. - - is . + The default value is . + Asynchronously computes the HMAC of a stream using the SHA3-512 algorithm. + The total number of bytes written to . + To be added. + + is . The buffer in is too small to hold the calculated hash @@ -530,212 +532,213 @@ -or- does not support reading. - - - - - - - - - - - Method - - System.Security.Cryptography - 8.0.0.0 - - - System.Byte[] - - - - When overridden in a derived class, finalizes the HMAC computation after the last data is processed by the algorithm. - The computed HMAC value in a byte array. - To be added. - - - - - - - - - - - Field - - System.Security.Cryptography - 8.0.0.0 - - - System.Int32 - - 512 - - The hash size produced by the HMAC SHA3-512 algorithm, in bits. - To be added. - - - - - - - - - - Field - - System.Security.Cryptography - 8.0.0.0 - - - System.Int32 - - 64 - - The hash size produced by the HMAC SHA3-512 algorithm, in bytes. - To be added. - - - - - - - - - - Method - - System.Security.Cryptography - 8.0.0.0 - - - System.Void - - - - Initializes an instance of the default implementation of . - To be added. - - - - - - - - - - - Property - - System.Security.Cryptography - 8.0.0.0 - - - System.Boolean - - - Gets a value that indicates whether the algorithm is supported on the current platform. - - if the algorithm is supported; otherwise, . - To be added. - - - - - - - - - - Property - - System.Security.Cryptography - 8.0.0.0 - - - System.Byte[] - - - Gets or sets the key to use in the HMAC calculation. - The key to use in the HMAC calculation. - To be added. - - - - - - - - - - - Method - - System.Security.Cryptography - 8.0.0.0 - - - - [System.Runtime.CompilerServices.NullableContext(0)] - [<System.Runtime.CompilerServices.NullableContext(0)>] - - - - System.Boolean - - - - - - - - - The HMAC key. - The data to HMAC. - The buffer to receive the HMAC value. - When this method returns, the total number of bytes written into . - Attempts to compute the HMAC of data using the SHA3-512 algorithm. - - if is too small to hold the calculated hash, otherwise. - To be added. - - - - - - - - - - Method - - System.Security.Cryptography - 8.0.0.0 - - - - [System.Runtime.CompilerServices.NullableContext(0)] - [<System.Runtime.CompilerServices.NullableContext(0)>] - - - - System.Boolean - - - - - - - The buffer to receive the HMAC value. - When this method returns, contains the total number of bytes written into . This parameter is treated as uninitialized. - Attempts to finalize the HMAC computation after the last data is processed by the HMAC algorithm. - - if is long enough to receive the HMAC value; otherwise, . - To be added. - - - - - + + The cancellation token was canceled. This exception is stored into the returned task. + + + + + + + + + + Method + + System.Security.Cryptography + 8.0.0.0 + + + System.Byte[] + + + + When overridden in a derived class, finalizes the HMAC computation after the last data is processed by the algorithm. + The computed HMAC value in a byte array. + To be added. + + + + + + + + + + + Field + + System.Security.Cryptography + 8.0.0.0 + + + System.Int32 + + 512 + + The hash size produced by the HMAC SHA3-512 algorithm, in bits. + To be added. + + + + + + + + + + Field + + System.Security.Cryptography + 8.0.0.0 + + + System.Int32 + + 64 + + The hash size produced by the HMAC SHA3-512 algorithm, in bytes. + To be added. + + + + + + + + + + Method + + System.Security.Cryptography + 8.0.0.0 + + + System.Void + + + + Initializes an instance of the default implementation of . + To be added. + + + + + + + + + + + Property + + System.Security.Cryptography + 8.0.0.0 + + + System.Boolean + + + Gets a value that indicates whether the algorithm is supported on the current platform. + + if the algorithm is supported; otherwise, . + To be added. + + + + + + + + + + Property + + System.Security.Cryptography + 8.0.0.0 + + + System.Byte[] + + + Gets or sets the key to use in the HMAC calculation. + The key to use in the HMAC calculation. + To be added. + + + + + + + + + + + Method + + System.Security.Cryptography + 8.0.0.0 + + + + [System.Runtime.CompilerServices.NullableContext(0)] + [<System.Runtime.CompilerServices.NullableContext(0)>] + + + + System.Boolean + + + + + + + + + The HMAC key. + The data to HMAC. + The buffer to receive the HMAC value. + When this method returns, the total number of bytes written into . + Attempts to compute the HMAC of data using the SHA3-512 algorithm. + + if is too small to hold the calculated hash, otherwise. + To be added. + + + + + + + + + + Method + + System.Security.Cryptography + 8.0.0.0 + + + + [System.Runtime.CompilerServices.NullableContext(0)] + [<System.Runtime.CompilerServices.NullableContext(0)>] + + + + System.Boolean + + + + + + + The buffer to receive the HMAC value. + When this method returns, contains the total number of bytes written into . This parameter is treated as uninitialized. + Attempts to finalize the HMAC computation after the last data is processed by the HMAC algorithm. + + if is long enough to receive the HMAC value; otherwise, . + To be added. + + + + + diff --git a/xml/System.Security.Cryptography/HMACSHA512.xml b/xml/System.Security.Cryptography/HMACSHA512.xml index dba112908ef..60f8715817f 100644 --- a/xml/System.Security.Cryptography/HMACSHA512.xml +++ b/xml/System.Security.Cryptography/HMACSHA512.xml @@ -649,6 +649,7 @@ or is . does not support reading. + The cancellation token was canceled. This exception is stored into the returned task. @@ -702,6 +703,7 @@ is . does not support reading. + The cancellation token was canceled. This exception is stored into the returned task. @@ -765,6 +767,7 @@ does not support reading. + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.Security.Cryptography/HashAlgorithm.xml b/xml/System.Security.Cryptography/HashAlgorithm.xml index 3cc7c868e26..4b582e52f39 100644 --- a/xml/System.Security.Cryptography/HashAlgorithm.xml +++ b/xml/System.Security.Cryptography/HashAlgorithm.xml @@ -512,6 +512,7 @@ The following example calculates the Asynchronously computes the hash value for the specified object. A task that represents the asynchronous compute hash operation and wraps the computed hash code. 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 . + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.Security.Cryptography/MD5.xml b/xml/System.Security.Cryptography/MD5.xml index 30fedc82e1a..c2ff0dba02f 100644 --- a/xml/System.Security.Cryptography/MD5.xml +++ b/xml/System.Security.Cryptography/MD5.xml @@ -555,6 +555,7 @@ is . does not support reading. + The cancellation token was canceled. This exception is stored into the returned task. @@ -616,6 +617,7 @@ does not support reading. + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.Security.Cryptography/SHA1.xml b/xml/System.Security.Cryptography/SHA1.xml index c3cb42bf4ad..767fe3dfb0c 100644 --- a/xml/System.Security.Cryptography/SHA1.xml +++ b/xml/System.Security.Cryptography/SHA1.xml @@ -511,6 +511,7 @@ is . does not support reading. + The cancellation token was canceled. This exception is stored into the returned task. @@ -566,6 +567,7 @@ does not support reading. + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.Security.Cryptography/SHA256.xml b/xml/System.Security.Cryptography/SHA256.xml index 794593002c9..47c3ba9716b 100644 --- a/xml/System.Security.Cryptography/SHA256.xml +++ b/xml/System.Security.Cryptography/SHA256.xml @@ -525,6 +525,7 @@ The .NET Framework includes the implementations and their associated hashName va is . does not support reading. + The cancellation token was canceled. This exception is stored into the returned task. @@ -580,6 +581,7 @@ The .NET Framework includes the implementations and their associated hashName va does not support reading. + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.Security.Cryptography/SHA384.xml b/xml/System.Security.Cryptography/SHA384.xml index 43da559edf3..4526a1ca9ab 100644 --- a/xml/System.Security.Cryptography/SHA384.xml +++ b/xml/System.Security.Cryptography/SHA384.xml @@ -515,6 +515,7 @@ is . does not support reading. + The cancellation token was canceled. This exception is stored into the returned task. @@ -570,6 +571,7 @@ does not support reading.

+ The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.Security.Cryptography/SHA3_256.xml b/xml/System.Security.Cryptography/SHA3_256.xml index 3486f654e72..ddfb4d98c41 100644 --- a/xml/System.Security.Cryptography/SHA3_256.xml +++ b/xml/System.Security.Cryptography/SHA3_256.xml @@ -1,435 +1,437 @@ - - - - - - - - - System.Security.Cryptography - 8.0.0.0 - - - System.Security.Cryptography.HashAlgorithm - - - - Computes the SHA3-256 hash for the input data. - This algorithm is specified by FIPS 202. - - - - - - - - - Constructor - - System.Security.Cryptography - 8.0.0.0 - - - - Initializes a new instance of . - To be added. - - - - - - - - - - Method - - System.Security.Cryptography - 8.0.0.0 - - - - [System.Runtime.CompilerServices.NullableContext(1)] - [<System.Runtime.CompilerServices.NullableContext(1)>] - - - - System.Security.Cryptography.SHA3_256 - - - - Creates an instance of the default implementation of . - A new instance of . - To be added. - The platform does not support SHA3-256. - - - - - - - - - - Method - - System.Security.Cryptography - 8.0.0.0 - - - - [System.Runtime.CompilerServices.NullableContext(1)] - [<System.Runtime.CompilerServices.NullableContext(1)>] - - - - System.Byte[] - - - - - - The data to hash. - Computes the hash of data using the SHA3-256 algorithm. - The hash of the data. - To be added. - - is . - The platform does not support SHA3-256. - - - - - - - - - - Method - - System.Security.Cryptography - 8.0.0.0 - - - - [System.Runtime.CompilerServices.NullableContext(1)] - [<System.Runtime.CompilerServices.NullableContext(1)>] - - - - System.Byte[] - - - - - - The stream to hash. - Computes the hash of a stream using the SHA3-256 algorithm. - The hash of the data. - To be added. - - is . - - does not support reading. - The platform does not support SHA3-256. - - - - - - - - - - Method - - System.Security.Cryptography - 8.0.0.0 - - - System.Byte[] - - - [System.Runtime.CompilerServices.Nullable(1)] - [<System.Runtime.CompilerServices.Nullable(1)>] - - - - - - - - The data to hash. - Computes the hash of data using the SHA3-256 algorithm. - The hash of the data. - To be added. - The platform does not support SHA3-256. - - - - - - - - - - Method - - System.Security.Cryptography - 8.0.0.0 - - - System.Int32 - - - - - - [System.Runtime.CompilerServices.Nullable(1)] - [<System.Runtime.CompilerServices.Nullable(1)>] - - - - - - - The stream to hash. - The buffer to receive the hash value. - Computes the hash of a stream using the SHA3-256 algorithm. - The total number of bytes written to . - To be added. - - is . - + + + + + + + + + System.Security.Cryptography + 8.0.0.0 + + + System.Security.Cryptography.HashAlgorithm + + + + Computes the SHA3-256 hash for the input data. + This algorithm is specified by FIPS 202. + + + + + + + + + Constructor + + System.Security.Cryptography + 8.0.0.0 + + + + Initializes a new instance of . + To be added. + + + + + + + + + + Method + + System.Security.Cryptography + 8.0.0.0 + + + + [System.Runtime.CompilerServices.NullableContext(1)] + [<System.Runtime.CompilerServices.NullableContext(1)>] + + + + System.Security.Cryptography.SHA3_256 + + + + Creates an instance of the default implementation of . + A new instance of . + To be added. + The platform does not support SHA3-256. + + + + + + + + + + Method + + System.Security.Cryptography + 8.0.0.0 + + + + [System.Runtime.CompilerServices.NullableContext(1)] + [<System.Runtime.CompilerServices.NullableContext(1)>] + + + + System.Byte[] + + + + + + The data to hash. + Computes the hash of data using the SHA3-256 algorithm. + The hash of the data. + To be added. + + is . + The platform does not support SHA3-256. + + + + + + + + + + Method + + System.Security.Cryptography + 8.0.0.0 + + + + [System.Runtime.CompilerServices.NullableContext(1)] + [<System.Runtime.CompilerServices.NullableContext(1)>] + + + + System.Byte[] + + + + + + The stream to hash. + Computes the hash of a stream using the SHA3-256 algorithm. + The hash of the data. + To be added. + + is . + + does not support reading. + The platform does not support SHA3-256. + + + + + + + + + + Method + + System.Security.Cryptography + 8.0.0.0 + + + System.Byte[] + + + [System.Runtime.CompilerServices.Nullable(1)] + [<System.Runtime.CompilerServices.Nullable(1)>] + + + + + + + + The data to hash. + Computes the hash of data using the SHA3-256 algorithm. + The hash of the data. + To be added. + The platform does not support SHA3-256. + + + + + + + + + + Method + + System.Security.Cryptography + 8.0.0.0 + + + System.Int32 + + + + + + [System.Runtime.CompilerServices.Nullable(1)] + [<System.Runtime.CompilerServices.Nullable(1)>] + + + + + + + The stream to hash. + The buffer to receive the hash value. + Computes the hash of a stream using the SHA3-256 algorithm. + The total number of bytes written to . + To be added. + + is . +

The buffer in is too small to hold the calculated hash size. The SHA3-256 algorithm always produces a 256-bit hash, or 32 bytes. -

-

-or-

-

+

+

-or-

+

does not support reading. -

- - The platform does not support SHA3-256. - - - - - - - - - - Method - - System.Security.Cryptography - 8.0.0.0 - - - System.Int32 - - - - - - - The data to hash. - The buffer to receive the hash value. - Computes the hash of data using the SHA3-256 algorithm. - The total number of bytes written to . - To be added. +

+ + The platform does not support SHA3-256. + + + + + + + + + + Method + + System.Security.Cryptography + 8.0.0.0 + + + System.Int32 + + + + + + + The data to hash. + The buffer to receive the hash value. + Computes the hash of data using the SHA3-256 algorithm. + The total number of bytes written to . + To be added. The buffer in is too small to hold the calculated hash - size. The SHA3-256 algorithm always produces a 256-bit hash, or 32 bytes. - The platform does not support SHA3-256. - - - - - - - - - Method - - System.Security.Cryptography - 8.0.0.0 - - - - [System.Runtime.CompilerServices.NullableContext(1)] - [<System.Runtime.CompilerServices.NullableContext(1)>] - - - - System.Threading.Tasks.ValueTask<System.Byte[]> - - - [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })] - [<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })>] - - - - - - - - - The stream to hash. + size. The SHA3-256 algorithm always produces a 256-bit hash, or 32 bytes. + The platform does not support SHA3-256. + + + + + + + + + Method + + System.Security.Cryptography + 8.0.0.0 + + + + [System.Runtime.CompilerServices.NullableContext(1)] + [<System.Runtime.CompilerServices.NullableContext(1)>] + + + + System.Threading.Tasks.ValueTask<System.Byte[]> + + + [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })] + [<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })>] + + + + + + + + + The stream to hash. The token to monitor for cancellation requests. - The default value is . - Asynchronously computes the hash of a stream using the SHA3-256 algorithm. - The hash of the data. - To be added. - - is . - - does not support reading. - The platform does not support SHA3-256. - - - - - - - - - Method - - System.Security.Cryptography - 8.0.0.0 - - - System.Threading.Tasks.ValueTask<System.Int32> - - - - - - [System.Runtime.CompilerServices.Nullable(1)] - [<System.Runtime.CompilerServices.Nullable(1)>] - - - - - - - - The stream to hash. - The buffer to receive the hash value. + The default value is . + Asynchronously computes the hash of a stream using the SHA3-256 algorithm. + The hash of the data. + To be added. + + is . + + does not support reading. + The platform does not support SHA3-256. + The cancellation token was canceled. This exception is stored into the returned task. + + + + + + + + + Method + + System.Security.Cryptography + 8.0.0.0 + + + System.Threading.Tasks.ValueTask<System.Int32> + + + + + + [System.Runtime.CompilerServices.Nullable(1)] + [<System.Runtime.CompilerServices.Nullable(1)>] + + + + + + + + The stream to hash. + The buffer to receive the hash value. The token to monitor for cancellation requests. - The default value is . - Asynchronously computes the hash of a stream using the SHA3-256 algorithm. - The total number of bytes written to . - To be added. - - is . - + The default value is . + Asynchronously computes the hash of a stream using the SHA3-256 algorithm. + The total number of bytes written to . + To be added. + + is . +

The buffer in is too small to hold the calculated hash size. The SHA3-256 algorithm always produces a 256-bit hash, or 32 bytes. -

-

-or-

-

+

+

-or-

+

does not support reading. -

- - The platform does not support SHA3-256. - - - - - - - - - - Field - - System.Security.Cryptography - 8.0.0.0 - - - System.Int32 - - 256 - - The hash size produced by the SHA3-256 algorithm, in bits. - To be added. - - - - - - - - - - Field - - System.Security.Cryptography - 8.0.0.0 - - - System.Int32 - - 32 - - The hash size produced by the SHA3-256 algorithm, in bytes. - To be added. - - - - - - - - - - Property - - System.Security.Cryptography - 8.0.0.0 - - - System.Boolean - - - Gets a value that indicates whether the algorithm is supported on the current platform. - - if the algorithm is supported; otherwise, . - To be added. - - - - - - - - - - Method - - System.Security.Cryptography - 8.0.0.0 - - - System.Boolean - - - - - - - - The data to hash. - The buffer to receive the hash value. - When this method returns, the total number of bytes written into . - Attempts to compute the hash of data using the SHA3-256 algorithm. - - if is too small to hold the calculated hash, otherwise. - To be added. - The platform does not support SHA3-256. - - - - +

+ + The platform does not support SHA3-256. + The cancellation token was canceled. This exception is stored into the returned task. + + + + + + + + + + Field + + System.Security.Cryptography + 8.0.0.0 + + + System.Int32 + + 256 + + The hash size produced by the SHA3-256 algorithm, in bits. + To be added. + + + + + + + + + + Field + + System.Security.Cryptography + 8.0.0.0 + + + System.Int32 + + 32 + + The hash size produced by the SHA3-256 algorithm, in bytes. + To be added. + + + + + + + + + + Property + + System.Security.Cryptography + 8.0.0.0 + + + System.Boolean + + + Gets a value that indicates whether the algorithm is supported on the current platform. + + if the algorithm is supported; otherwise, . + To be added. + + + + + + + + + + Method + + System.Security.Cryptography + 8.0.0.0 + + + System.Boolean + + + + + + + + The data to hash. + The buffer to receive the hash value. + When this method returns, the total number of bytes written into . + Attempts to compute the hash of data using the SHA3-256 algorithm. + + if is too small to hold the calculated hash, otherwise. + To be added. + The platform does not support SHA3-256. + + + + diff --git a/xml/System.Security.Cryptography/SHA3_384.xml b/xml/System.Security.Cryptography/SHA3_384.xml index 9c58a47c4d8..45b803b940c 100644 --- a/xml/System.Security.Cryptography/SHA3_384.xml +++ b/xml/System.Security.Cryptography/SHA3_384.xml @@ -1,205 +1,205 @@ - - - - - - - - - System.Security.Cryptography - 8.0.0.0 - - - System.Security.Cryptography.HashAlgorithm - - - - Computes the SHA3-384 hash for the input data. - This algorithm is specified by FIPS 202. - - - - - - - - - Constructor - - System.Security.Cryptography - 8.0.0.0 - - - - Initializes a new instance of . - To be added. - - - - - - - - - - Method - - System.Security.Cryptography - 8.0.0.0 - - - - [System.Runtime.CompilerServices.NullableContext(1)] - [<System.Runtime.CompilerServices.NullableContext(1)>] - - - - System.Security.Cryptography.SHA3_384 - - - - Creates an instance of the default implementation of . - A new instance of . - To be added. - The platform does not support SHA3-384. - - - - - - - - - - Method - - System.Security.Cryptography - 8.0.0.0 - - - - [System.Runtime.CompilerServices.NullableContext(1)] - [<System.Runtime.CompilerServices.NullableContext(1)>] - - - - System.Byte[] - - - - - - The data to hash. - Computes the hash of data using the SHA3-384 algorithm. - The hash of the data. - To be added. - - is . - The platform does not support SHA3-384. - - - - - - - - - - Method - - System.Security.Cryptography - 8.0.0.0 - - - - [System.Runtime.CompilerServices.NullableContext(1)] - [<System.Runtime.CompilerServices.NullableContext(1)>] - - - - System.Byte[] - - - - - - The stream to hash. - Computes the hash of a stream using the SHA3-384 algorithm. - The hash of the data. - To be added. - - is . - - does not support reading. - The platform does not support SHA3-384. - - - - - - - - - - Method - - System.Security.Cryptography - 8.0.0.0 - - - System.Byte[] - - - [System.Runtime.CompilerServices.Nullable(1)] - [<System.Runtime.CompilerServices.Nullable(1)>] - - - - - - - - The data to hash. - Computes the hash of data using the SHA3-384 algorithm. - The hash of the data. - To be added. - The platform does not support SHA3-384. - - - - - - - - - - Method - - System.Security.Cryptography - 8.0.0.0 - - - System.Int32 - - - - - - [System.Runtime.CompilerServices.Nullable(1)] - [<System.Runtime.CompilerServices.Nullable(1)>] - - - - - - - The stream to hash. - The buffer to receive the hash value. - Computes the hash of a stream using the SHA3-384 algorithm. - The total number of bytes written to . - To be added. - - is . + + + + + + + + + System.Security.Cryptography + 8.0.0.0 + + + System.Security.Cryptography.HashAlgorithm + + + + Computes the SHA3-384 hash for the input data. + This algorithm is specified by FIPS 202. + + + + + + + + + Constructor + + System.Security.Cryptography + 8.0.0.0 + + + + Initializes a new instance of . + To be added. + + + + + + + + + + Method + + System.Security.Cryptography + 8.0.0.0 + + + + [System.Runtime.CompilerServices.NullableContext(1)] + [<System.Runtime.CompilerServices.NullableContext(1)>] + + + + System.Security.Cryptography.SHA3_384 + + + + Creates an instance of the default implementation of . + A new instance of . + To be added. + The platform does not support SHA3-384. + + + + + + + + + + Method + + System.Security.Cryptography + 8.0.0.0 + + + + [System.Runtime.CompilerServices.NullableContext(1)] + [<System.Runtime.CompilerServices.NullableContext(1)>] + + + + System.Byte[] + + + + + + The data to hash. + Computes the hash of data using the SHA3-384 algorithm. + The hash of the data. + To be added. + + is . + The platform does not support SHA3-384. + + + + + + + + + + Method + + System.Security.Cryptography + 8.0.0.0 + + + + [System.Runtime.CompilerServices.NullableContext(1)] + [<System.Runtime.CompilerServices.NullableContext(1)>] + + + + System.Byte[] + + + + + + The stream to hash. + Computes the hash of a stream using the SHA3-384 algorithm. + The hash of the data. + To be added. + + is . + + does not support reading. + The platform does not support SHA3-384. + + + + + + + + + + Method + + System.Security.Cryptography + 8.0.0.0 + + + System.Byte[] + + + [System.Runtime.CompilerServices.Nullable(1)] + [<System.Runtime.CompilerServices.Nullable(1)>] + + + + + + + + The data to hash. + Computes the hash of data using the SHA3-384 algorithm. + The hash of the data. + To be added. + The platform does not support SHA3-384. + + + + + + + + + + Method + + System.Security.Cryptography + 8.0.0.0 + + + System.Int32 + + + + + + [System.Runtime.CompilerServices.Nullable(1)] + [<System.Runtime.CompilerServices.Nullable(1)>] + + + + + + + The stream to hash. + The buffer to receive the hash value. + Computes the hash of a stream using the SHA3-384 algorithm. + The total number of bytes written to . + To be added. + + is . The buffer in is too small to hold the calculated hash @@ -208,120 +208,121 @@ -or- does not support reading. - - The platform does not support SHA3-384. - - - - - - - - - - Method - - System.Security.Cryptography - 8.0.0.0 - - - System.Int32 - - - - - - - The data to hash. - The buffer to receive the hash value. - Computes the hash of data using the SHA3-384 algorithm. - The total number of bytes written to . - To be added. + + The platform does not support SHA3-384. + + + + + + + + + + Method + + System.Security.Cryptography + 8.0.0.0 + + + System.Int32 + + + + + + + The data to hash. + The buffer to receive the hash value. + Computes the hash of data using the SHA3-384 algorithm. + The total number of bytes written to . + To be added. The buffer in is too small to hold the calculated hash - size. The SHA3-384 algorithm always produces a 384-bit hash, or 48 bytes. - The platform does not support SHA3-384. - - - - - - - - - Method - - System.Security.Cryptography - 8.0.0.0 - - - - [System.Runtime.CompilerServices.NullableContext(1)] - [<System.Runtime.CompilerServices.NullableContext(1)>] - - - - System.Threading.Tasks.ValueTask<System.Byte[]> - - - [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })] - [<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })>] - - - - - - - - - The stream to hash. + size. The SHA3-384 algorithm always produces a 384-bit hash, or 48 bytes. + The platform does not support SHA3-384. + + + + + + + + + Method + + System.Security.Cryptography + 8.0.0.0 + + + + [System.Runtime.CompilerServices.NullableContext(1)] + [<System.Runtime.CompilerServices.NullableContext(1)>] + + + + System.Threading.Tasks.ValueTask<System.Byte[]> + + + [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })] + [<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })>] + + + + + + + + + The stream to hash. The token to monitor for cancellation requests. - The default value is . - Asynchronously computes the hash of a stream using the SHA3-384 algorithm. - The hash of the data. - To be added. - - is . - - does not support reading. - The platform does not support SHA3-384. - - - - - - - - - Method - - System.Security.Cryptography - 8.0.0.0 - - - System.Threading.Tasks.ValueTask<System.Int32> - - - - - - [System.Runtime.CompilerServices.Nullable(1)] - [<System.Runtime.CompilerServices.Nullable(1)>] - - - - - - - - The stream to hash. - The buffer to receive the hash value. + The default value is . + Asynchronously computes the hash of a stream using the SHA3-384 algorithm. + The hash of the data. + To be added. + + is . + + does not support reading. + The platform does not support SHA3-384. + The cancellation token was canceled. This exception is stored into the returned task. + + + + + + + + + Method + + System.Security.Cryptography + 8.0.0.0 + + + System.Threading.Tasks.ValueTask<System.Int32> + + + + + + [System.Runtime.CompilerServices.Nullable(1)] + [<System.Runtime.CompilerServices.Nullable(1)>] + + + + + + + + The stream to hash. + The buffer to receive the hash value. The token to monitor for cancellation requests. - The default value is . - Asynchronously computes the hash of a stream using the SHA3-384 algorithm. - The total number of bytes written to . - To be added. - - is . + The default value is . + Asynchronously computes the hash of a stream using the SHA3-384 algorithm. + The total number of bytes written to . + To be added. + + is . The buffer in is too small to hold the calculated hash @@ -330,104 +331,105 @@ -or- does not support reading. - - The platform does not support SHA3-384. - - - - - - - - - - Field - - System.Security.Cryptography - 8.0.0.0 - - - System.Int32 - - 384 - - The hash size produced by the SHA3-384 algorithm, in bits. - To be added. - - - - - - - - - - Field - - System.Security.Cryptography - 8.0.0.0 - - - System.Int32 - - 48 - - The hash size produced by the SHA3-384 algorithm, in bytes. - To be added. - - - - - - - - - - Property - - System.Security.Cryptography - 8.0.0.0 - - - System.Boolean - - - Gets a value that indicates whether the algorithm is supported on the current platform. - - if the algorithm is supported; otherwise, . - To be added. - - - - - - - - - - Method - - System.Security.Cryptography - 8.0.0.0 - - - System.Boolean - - - - - - - - The data to hash. - The buffer to receive the hash value. - When this method returns, the total number of bytes written into . - Attempts to compute the hash of data using the SHA3-384 algorithm. - - if is too small to hold the calculated hash, otherwise. - To be added. - The platform does not support SHA3-384. - - - - + + The platform does not support SHA3-384. + The cancellation token was canceled. This exception is stored into the returned task. + + + + + + + + + + Field + + System.Security.Cryptography + 8.0.0.0 + + + System.Int32 + + 384 + + The hash size produced by the SHA3-384 algorithm, in bits. + To be added. + + + + + + + + + + Field + + System.Security.Cryptography + 8.0.0.0 + + + System.Int32 + + 48 + + The hash size produced by the SHA3-384 algorithm, in bytes. + To be added. + + + + + + + + + + Property + + System.Security.Cryptography + 8.0.0.0 + + + System.Boolean + + + Gets a value that indicates whether the algorithm is supported on the current platform. + + if the algorithm is supported; otherwise, . + To be added. + + + + + + + + + + Method + + System.Security.Cryptography + 8.0.0.0 + + + System.Boolean + + + + + + + + The data to hash. + The buffer to receive the hash value. + When this method returns, the total number of bytes written into . + Attempts to compute the hash of data using the SHA3-384 algorithm. + + if is too small to hold the calculated hash, otherwise. + To be added. + The platform does not support SHA3-384. + + + + diff --git a/xml/System.Security.Cryptography/SHA3_512.xml b/xml/System.Security.Cryptography/SHA3_512.xml index d499760c47c..0a32c19cc56 100644 --- a/xml/System.Security.Cryptography/SHA3_512.xml +++ b/xml/System.Security.Cryptography/SHA3_512.xml @@ -1,205 +1,205 @@ - - - - - - - - - System.Security.Cryptography - 8.0.0.0 - - - System.Security.Cryptography.HashAlgorithm - - - - Computes the SHA3-512 hash for the input data. - This algorithm is specified by FIPS 202. - - - - - - - - - Constructor - - System.Security.Cryptography - 8.0.0.0 - - - - Initializes a new instance of . - To be added. - - - - - - - - - - Method - - System.Security.Cryptography - 8.0.0.0 - - - - [System.Runtime.CompilerServices.NullableContext(1)] - [<System.Runtime.CompilerServices.NullableContext(1)>] - - - - System.Security.Cryptography.SHA3_512 - - - - Creates an instance of the default implementation of . - A new instance of . - To be added. - The platform does not support SHA3-512. - - - - - - - - - - Method - - System.Security.Cryptography - 8.0.0.0 - - - - [System.Runtime.CompilerServices.NullableContext(1)] - [<System.Runtime.CompilerServices.NullableContext(1)>] - - - - System.Byte[] - - - - - - The data to hash. - Computes the hash of data using the SHA3-512 algorithm. - The hash of the data. - To be added. - - is . - The platform does not support SHA3-512. - - - - - - - - - - Method - - System.Security.Cryptography - 8.0.0.0 - - - - [System.Runtime.CompilerServices.NullableContext(1)] - [<System.Runtime.CompilerServices.NullableContext(1)>] - - - - System.Byte[] - - - - - - The stream to hash. - Computes the hash of a stream using the SHA3-512 algorithm. - The hash of the data. - To be added. - - is . - - does not support reading. - The platform does not support SHA3-512. - - - - - - - - - - Method - - System.Security.Cryptography - 8.0.0.0 - - - System.Byte[] - - - [System.Runtime.CompilerServices.Nullable(1)] - [<System.Runtime.CompilerServices.Nullable(1)>] - - - - - - - - The data to hash. - Computes the hash of data using the SHA3-512 algorithm. - The hash of the data. - To be added. - The platform does not support SHA3-512. - - - - - - - - - - Method - - System.Security.Cryptography - 8.0.0.0 - - - System.Int32 - - - - - - [System.Runtime.CompilerServices.Nullable(1)] - [<System.Runtime.CompilerServices.Nullable(1)>] - - - - - - - The stream to hash. - The buffer to receive the hash value. - Computes the hash of a stream using the SHA3-512 algorithm. - The total number of bytes written to . - To be added. - - is . + + + + + + + + + System.Security.Cryptography + 8.0.0.0 + + + System.Security.Cryptography.HashAlgorithm + + + + Computes the SHA3-512 hash for the input data. + This algorithm is specified by FIPS 202. + + + + + + + + + Constructor + + System.Security.Cryptography + 8.0.0.0 + + + + Initializes a new instance of . + To be added. + + + + + + + + + + Method + + System.Security.Cryptography + 8.0.0.0 + + + + [System.Runtime.CompilerServices.NullableContext(1)] + [<System.Runtime.CompilerServices.NullableContext(1)>] + + + + System.Security.Cryptography.SHA3_512 + + + + Creates an instance of the default implementation of . + A new instance of . + To be added. + The platform does not support SHA3-512. + + + + + + + + + + Method + + System.Security.Cryptography + 8.0.0.0 + + + + [System.Runtime.CompilerServices.NullableContext(1)] + [<System.Runtime.CompilerServices.NullableContext(1)>] + + + + System.Byte[] + + + + + + The data to hash. + Computes the hash of data using the SHA3-512 algorithm. + The hash of the data. + To be added. + + is . + The platform does not support SHA3-512. + + + + + + + + + + Method + + System.Security.Cryptography + 8.0.0.0 + + + + [System.Runtime.CompilerServices.NullableContext(1)] + [<System.Runtime.CompilerServices.NullableContext(1)>] + + + + System.Byte[] + + + + + + The stream to hash. + Computes the hash of a stream using the SHA3-512 algorithm. + The hash of the data. + To be added. + + is . + + does not support reading. + The platform does not support SHA3-512. + + + + + + + + + + Method + + System.Security.Cryptography + 8.0.0.0 + + + System.Byte[] + + + [System.Runtime.CompilerServices.Nullable(1)] + [<System.Runtime.CompilerServices.Nullable(1)>] + + + + + + + + The data to hash. + Computes the hash of data using the SHA3-512 algorithm. + The hash of the data. + To be added. + The platform does not support SHA3-512. + + + + + + + + + + Method + + System.Security.Cryptography + 8.0.0.0 + + + System.Int32 + + + + + + [System.Runtime.CompilerServices.Nullable(1)] + [<System.Runtime.CompilerServices.Nullable(1)>] + + + + + + + The stream to hash. + The buffer to receive the hash value. + Computes the hash of a stream using the SHA3-512 algorithm. + The total number of bytes written to . + To be added. + + is . The buffer in is too small to hold the calculated hash @@ -208,120 +208,121 @@ -or- does not support reading. - - The platform does not support SHA3-512. - - - - - - - - - - Method - - System.Security.Cryptography - 8.0.0.0 - - - System.Int32 - - - - - - - The data to hash. - The buffer to receive the hash value. - Computes the hash of data using the SHA3-512 algorithm. - The total number of bytes written to . - To be added. + + The platform does not support SHA3-512. + + + + + + + + + + Method + + System.Security.Cryptography + 8.0.0.0 + + + System.Int32 + + + + + + + The data to hash. + The buffer to receive the hash value. + Computes the hash of data using the SHA3-512 algorithm. + The total number of bytes written to . + To be added. The buffer in is too small to hold the calculated hash - size. The SHA3-512 algorithm always produces a 512-bit hash, or 64 bytes. - The platform does not support SHA3-512. - - - - - - - - - Method - - System.Security.Cryptography - 8.0.0.0 - - - - [System.Runtime.CompilerServices.NullableContext(1)] - [<System.Runtime.CompilerServices.NullableContext(1)>] - - - - System.Threading.Tasks.ValueTask<System.Byte[]> - - - [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })] - [<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })>] - - - - - - - - - The stream to hash. + size. The SHA3-512 algorithm always produces a 512-bit hash, or 64 bytes. + The platform does not support SHA3-512. + + + + + + + + + Method + + System.Security.Cryptography + 8.0.0.0 + + + + [System.Runtime.CompilerServices.NullableContext(1)] + [<System.Runtime.CompilerServices.NullableContext(1)>] + + + + System.Threading.Tasks.ValueTask<System.Byte[]> + + + [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })] + [<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })>] + + + + + + + + + The stream to hash. The token to monitor for cancellation requests. - The default value is . - Asynchronously computes the hash of a stream using the SHA3-512 algorithm. - The hash of the data. - To be added. - - is . - - does not support reading. - The platform does not support SHA3-512. - - - - - - - - - Method - - System.Security.Cryptography - 8.0.0.0 - - - System.Threading.Tasks.ValueTask<System.Int32> - - - - - - [System.Runtime.CompilerServices.Nullable(1)] - [<System.Runtime.CompilerServices.Nullable(1)>] - - - - - - - - The stream to hash. - The buffer to receive the hash value. + The default value is . + Asynchronously computes the hash of a stream using the SHA3-512 algorithm. + The hash of the data. + To be added. + + is . + + does not support reading. + The platform does not support SHA3-512. + The cancellation token was canceled. This exception is stored into the returned task. + + + + + + + + + Method + + System.Security.Cryptography + 8.0.0.0 + + + System.Threading.Tasks.ValueTask<System.Int32> + + + + + + [System.Runtime.CompilerServices.Nullable(1)] + [<System.Runtime.CompilerServices.Nullable(1)>] + + + + + + + + The stream to hash. + The buffer to receive the hash value. The token to monitor for cancellation requests. - The default value is . - Asynchronously computes the hash of a stream using the SHA3-512 algorithm. - The total number of bytes written to . - To be added. - - is . + The default value is . + Asynchronously computes the hash of a stream using the SHA3-512 algorithm. + The total number of bytes written to . + To be added. + + is . The buffer in is too small to hold the calculated hash @@ -330,104 +331,105 @@ -or- does not support reading. - - The platform does not support SHA3-512. - - - - - - - - - - Field - - System.Security.Cryptography - 8.0.0.0 - - - System.Int32 - - 512 - - The hash size produced by the SHA3-512 algorithm, in bits. - To be added. - - - - - - - - - - Field - - System.Security.Cryptography - 8.0.0.0 - - - System.Int32 - - 64 - - The hash size produced by the SHA3-512 algorithm, in bytes. - To be added. - - - - - - - - - - Property - - System.Security.Cryptography - 8.0.0.0 - - - System.Boolean - - - Gets a value that indicates whether the algorithm is supported on the current platform. - - if the algorithm is supported; otherwise, . - To be added. - - - - - - - - - - Method - - System.Security.Cryptography - 8.0.0.0 - - - System.Boolean - - - - - - - - The data to hash. - The buffer to receive the hash value. - When this method returns, the total number of bytes written into . - Attempts to compute the hash of data using the SHA3-512 algorithm. - - if is too small to hold the calculated hash, otherwise. - To be added. - The platform does not support SHA3-512. - - - - + + The platform does not support SHA3-512. + The cancellation token was canceled. This exception is stored into the returned task. + + + + + + + + + + Field + + System.Security.Cryptography + 8.0.0.0 + + + System.Int32 + + 512 + + The hash size produced by the SHA3-512 algorithm, in bits. + To be added. + + + + + + + + + + Field + + System.Security.Cryptography + 8.0.0.0 + + + System.Int32 + + 64 + + The hash size produced by the SHA3-512 algorithm, in bytes. + To be added. + + + + + + + + + + Property + + System.Security.Cryptography + 8.0.0.0 + + + System.Boolean + + + Gets a value that indicates whether the algorithm is supported on the current platform. + + if the algorithm is supported; otherwise, . + To be added. + + + + + + + + + + Method + + System.Security.Cryptography + 8.0.0.0 + + + System.Boolean + + + + + + + + The data to hash. + The buffer to receive the hash value. + When this method returns, the total number of bytes written into . + Attempts to compute the hash of data using the SHA3-512 algorithm. + + if is too small to hold the calculated hash, otherwise. + To be added. + The platform does not support SHA3-512. + + + + diff --git a/xml/System.Security.Cryptography/SHA512.xml b/xml/System.Security.Cryptography/SHA512.xml index eec70474596..f12891ac0da 100644 --- a/xml/System.Security.Cryptography/SHA512.xml +++ b/xml/System.Security.Cryptography/SHA512.xml @@ -524,6 +524,7 @@ is . does not support reading. + The cancellation token was canceled. This exception is stored into the returned task. @@ -579,6 +580,7 @@ does not support reading.

+ The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.ServiceModel.Discovery/DiscoveryClient.xml b/xml/System.ServiceModel.Discovery/DiscoveryClient.xml index e5ef6f771e1..44146d194cf 100644 --- a/xml/System.ServiceModel.Discovery/DiscoveryClient.xml +++ b/xml/System.ServiceModel.Discovery/DiscoveryClient.xml @@ -435,6 +435,7 @@ Begins an asynchronous find task operation with the specified criteria and cancellation token object. An asynchronous find task operation. To be added. + The cancellation token was canceled. This exception is stored into the returned task. @@ -693,6 +694,7 @@ Begins an asynchronous resolve task operation with the specified criteria and cancellation token. An asynchronous resolve task operation. To be added. + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.Text.Json.Nodes/JsonNode.xml b/xml/System.Text.Json.Nodes/JsonNode.xml index 7eb98c1aeb5..915b9cad803 100644 --- a/xml/System.Text.Json.Nodes/JsonNode.xml +++ b/xml/System.Text.Json.Nodes/JsonNode.xml @@ -14,8 +14,7 @@ System.Object - - + [System.Runtime.CompilerServices.Nullable(0)] @@ -2703,6 +2702,7 @@ This method makes a copy of the data the reader acted on, so there is no caller To be added. does not represent a valid single JSON value. + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.Text.Json/JsonDocument.xml b/xml/System.Text.Json/JsonDocument.xml index ab43c53c77b..c0546e5e9b9 100644 --- a/xml/System.Text.Json/JsonDocument.xml +++ b/xml/System.Text.Json/JsonDocument.xml @@ -331,6 +331,7 @@ The value may be used for the entire lifetime o does not represent a valid single JSON value. contains unsupported options. + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.Text.Json/JsonSerializer.xml b/xml/System.Text.Json/JsonSerializer.xml index 1f349dc2b21..09b7de22cd3 100644 --- a/xml/System.Text.Json/JsonSerializer.xml +++ b/xml/System.Text.Json/JsonSerializer.xml @@ -2415,6 +2415,7 @@ The used to create the instance of the or is . The JSON is invalid, or when there is remaining data in the Stream. + The cancellation token was canceled. This exception is stored into the returned task. @@ -2498,6 +2499,7 @@ For more information, see [How to serialize and deserialize JSON](/dotnet/standa There is remaining data in the stream. There is no compatible for or its serializable members. + The cancellation token was canceled. This exception is stored into the returned task. @@ -2536,6 +2538,7 @@ There is remaining data in the stream. The JSON is invalid, the is not compatible with the JSON, or there is remaining data in the Stream. There is no compatible for or its serializable members. The method on the provided did not return a compatible for . + The cancellation token was canceled. This exception is stored into the returned task. @@ -2616,6 +2619,7 @@ There is remaining data in the stream. There is no compatible for or its serializable members. is . + The cancellation token was canceled. This exception is stored into the returned task. @@ -2662,6 +2666,7 @@ There is remaining data in the stream. or is . The JSON is invalid, is not compatible with the JSON, or there is remaining data in the Stream. There is no compatible for or its serializable members. + The cancellation token was canceled. This exception is stored into the returned task. @@ -2719,6 +2724,7 @@ There is remaining data in the stream. To be added. is . + The cancellation token was canceled. This exception is stored into the returned task. @@ -2761,6 +2767,7 @@ There is remaining data in the stream. To be added. or is . + The cancellation token was canceled. This exception is stored into the returned task. @@ -3649,6 +3656,7 @@ For more information, see [How to serialize and deserialize JSON](/dotnet/standa is . does not match the type of . + The cancellation token was canceled. This exception is stored into the returned task. @@ -3734,6 +3742,7 @@ For more information, see [How to serialize and deserialize JSON](/dotnet/standa or is . There is no compatible for or its serializable members. + The cancellation token was canceled. This exception is stored into the returned task. @@ -3780,6 +3789,7 @@ For more information, see [How to serialize and deserialize JSON](/dotnet/standa , , or is . There is no compatible for or its serializable members. + The cancellation token was canceled. This exception is stored into the returned task. @@ -3856,6 +3866,7 @@ For more information, see [How to serialize and deserialize JSON](/dotnet/standa is . There is no compatible for or its serializable members. + The cancellation token was canceled. This exception is stored into the returned task. @@ -3902,6 +3913,7 @@ For more information, see [How to serialize and deserialize JSON](/dotnet/standa is . There is no compatible for or its serializable members. + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.Text.Json/Utf8JsonWriter.xml b/xml/System.Text.Json/Utf8JsonWriter.xml index 1f8a0c4f830..95c3e9969ff 100644 --- a/xml/System.Text.Json/Utf8JsonWriter.xml +++ b/xml/System.Text.Json/Utf8JsonWriter.xml @@ -378,6 +378,7 @@ This method stores in the task it returns all non-usage exceptions that the meth ]]> This instance has been disposed. + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.Threading.Channels/ChannelReader`1.xml b/xml/System.Threading.Channels/ChannelReader`1.xml index 89d990cc14f..e2561f0720a 100644 --- a/xml/System.Threading.Channels/ChannelReader`1.xml +++ b/xml/System.Threading.Channels/ChannelReader`1.xml @@ -204,6 +204,7 @@ Each call t ]]> + The cancellation token was canceled. This exception is stored into the returned task. @@ -234,6 +235,7 @@ Each call t Asynchronously reads an item from the channel. A that represents the asynchronous read operation. If the operation is canceled, the operation will not have removed an item from the channel. + The cancellation token was canceled. This exception is stored into the returned task. @@ -348,6 +350,7 @@ Each call t If the channel completes with an exception, the task will also complete with an exception. To be added. + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.Threading.Channels/ChannelWriter`1.xml b/xml/System.Threading.Channels/ChannelWriter`1.xml index 5b1b9c9c3cc..d22fa996d2f 100644 --- a/xml/System.Threading.Channels/ChannelWriter`1.xml +++ b/xml/System.Threading.Channels/ChannelWriter`1.xml @@ -199,6 +199,7 @@ A that will complete with a result when space is available to write an item or with a result when no further writing will be permitted. To be added. + The cancellation token was canceled. This exception is stored into the returned task. @@ -237,6 +238,7 @@ Asynchronously writes an item to the channel. A that represents the asynchronous write operation. To be added. + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.Threading.Tasks.Dataflow/DataflowBlock.xml b/xml/System.Threading.Tasks.Dataflow/DataflowBlock.xml index 389faf18c11..d34d40cb524 100644 --- a/xml/System.Threading.Tasks.Dataflow/DataflowBlock.xml +++ b/xml/System.Threading.Tasks.Dataflow/DataflowBlock.xml @@ -888,6 +888,7 @@ batchBlock.Complete(); Provides a that asynchronously monitors the source for available output. A that informs of whether and when more output is available. If, when the task completes, its is , more output is available in the source (though another consumer of the source may retrieve the data). If it returns , more output is not and will never be available, due to the source completing prior to output being available. To be added. + The cancellation token was canceled. This exception is stored into the returned task. @@ -1224,6 +1225,7 @@ batchBlock.Complete(); The created async enumerable. To be added. The is . + The cancellation token was canceled. This exception is stored into the returned task. @@ -1322,6 +1324,7 @@ batchBlock.Complete(); To be added. is . + The cancellation token was canceled. This exception is stored into the returned task. @@ -1436,6 +1439,7 @@ batchBlock.Complete(); -or- is greater than Int32.MaxValue. + The cancellation token was canceled. This exception is stored into the returned task. @@ -1538,6 +1542,7 @@ batchBlock.Complete(); If cancellation is requested before the target has successfully consumed the sent data, the returned task will complete in the Canceled state and the data will no longer be available to the target. To be added. The is null (Nothing in Visual Basic). + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.Threading.Tasks/Parallel.xml b/xml/System.Threading.Tasks/Parallel.xml index a67c7d7799e..ad75560d9ad 100644 --- a/xml/System.Threading.Tasks/Parallel.xml +++ b/xml/System.Threading.Tasks/Parallel.xml @@ -1082,6 +1082,7 @@ A task that represents the entire for each operation. The operation will execute at most operations in parallel. The argument is . + The cancellation token was canceled. This exception is stored into the returned task. @@ -3018,6 +3019,7 @@ The operation will execute at most oper or is . + The cancellation token was canceled. This exception is stored into the returned task. @@ -3126,6 +3128,7 @@ The operation will execute at most oper or is . + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.Threading.Tasks/Task.xml b/xml/System.Threading.Tasks/Task.xml index 6e8dabf0399..feaaa01e326 100644 --- a/xml/System.Threading.Tasks/Task.xml +++ b/xml/System.Threading.Tasks/Task.xml @@ -1,87 +1,87 @@ - - - - - - - - - - - - - - - System.Threading.Tasks - 4.0.0.0 - 4.0.10.0 - - - mscorlib - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Runtime - 4.2.0.0 - 4.2.1.0 - 4.2.2.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - - - - - - - - - - - - - - - System.Object - - - - System.IAsyncResult - - - System.IDisposable - - - - - [System.Runtime.CompilerServices.Nullable(0)] - [<System.Runtime.CompilerServices.Nullable(0)>] - - - [System.Runtime.CompilerServices.NullableContext(1)] - [<System.Runtime.CompilerServices.NullableContext(1)>] - - - [System.Diagnostics.DebuggerDisplay("Id = {Id}, Status = {Status}, Method = {DebuggerDisplayMethodDescription}")] - [<System.Diagnostics.DebuggerDisplay("Id = {Id}, Status = {Status}, Method = {DebuggerDisplayMethodDescription}")>] - - - [System.Diagnostics.DebuggerTypeProxy(typeof(System.Threading.Tasks.SystemThreadingTasks_TaskDebugView))] - [<System.Diagnostics.DebuggerTypeProxy(typeof(System.Threading.Tasks.SystemThreadingTasks_TaskDebugView))>] - - - - Represents an asynchronous operation. - + + + + + + + + + + + + + + + System.Threading.Tasks + 4.0.0.0 + 4.0.10.0 + + + mscorlib + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Runtime + 4.2.0.0 + 4.2.1.0 + 4.2.2.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + + + + + + + + + + + + + + + System.Object + + + + System.IAsyncResult + + + System.IDisposable + + + + + [System.Runtime.CompilerServices.Nullable(0)] + [<System.Runtime.CompilerServices.Nullable(0)>] + + + [System.Runtime.CompilerServices.NullableContext(1)] + [<System.Runtime.CompilerServices.NullableContext(1)>] + + + [System.Diagnostics.DebuggerDisplay("Id = {Id}, Status = {Status}, Method = {DebuggerDisplayMethodDescription}")] + [<System.Diagnostics.DebuggerDisplay("Id = {Id}, Status = {Status}, Method = {DebuggerDisplayMethodDescription}")>] + + + [System.Diagnostics.DebuggerTypeProxy(typeof(System.Threading.Tasks.SystemThreadingTasks_TaskDebugView))] + [<System.Diagnostics.DebuggerTypeProxy(typeof(System.Threading.Tasks.SystemThreadingTasks_TaskDebugView))>] + + + + Represents an asynchronous operation. + ## Creating and executing a task - instances may be created in a variety of ways. The most common approach, which is available starting with the .NET Framework 4.5, is to call the static method. The method provides a simple way to start a task using default values and without requiring additional parameters. The following example uses the method to start a task that loops and then displays the number of loop iterations: + +You can create instances in a variety of ways. The most common approach is to call the static method. The method provides a simple way to start a task using default values and without requiring additional parameters. The following example uses the method to start a task that loops and then displays the number of loop iterations: :::code language="csharp" source="~/snippets/csharp/System.Threading.Tasks/Task/Overview/run1.cs" id="Snippet6"::: :::code language="fsharp" source="~/snippets/fsharp/System.Threading.Tasks/Task/Overview/run1.fs" id="Snippet6"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.threading.tasks.task/vb/run1.vb" id="Snippet6"::: - An alternative, and the most common method to start a task in .NET Framework 4, is the static method. The property returns a object. Overloads of the method let you specify parameters to pass to the task creation options and a task scheduler. The following example uses the method to start a task. It is functionally equivalent to the code in the previous example. + An alternative is the static method. The property returns a object. Overloads of the method let you specify parameters to pass to the task creation options and a task scheduler. The following example uses the method to start a task. It is functionally equivalent to the code in the previous example. :::code language="csharp" source="~/snippets/csharp/System.Threading.Tasks/Task/Overview/startnew1.cs" id="Snippet7"::: :::code language="fsharp" source="~/snippets/fsharp/System.Threading.Tasks/Task/Overview/startnew1.fs" id="Snippet7"::: @@ -187,66 +188,66 @@ ## For debugger developers For developers implementing custom debuggers, several internal and private members of task may be useful (these may change from release to release). The `m_taskId` field serves as the backing store for the property, however accessing this field directly from a debugger may be more efficient than accessing the same value through the property's getter method (the `s_taskIdCounter` counter is used to retrieve the next available ID for a task). Similarly, the `m_stateFlags` field stores information about the current lifecycle stage of the task, information also accessible through the property. The `m_action` field stores a reference to the task's delegate, and the `m_stateObject` field stores the async state passed to the task by the developer. Finally, for debuggers that parse stack frames, the `InternalWait` method serves a potential marker for when a task is entering a wait operation. - ]]> - - All members of , except for , are thread-safe and may be used from multiple threads concurrently. - - Task Parallel Library (TPL) - Task-based asynchronous pattern (TAP) in .NET: Introduction and overview - Task-based Asynchronous Programming - Samples for Parallel Programming with the .NET Core and .NET Standard - - - - - System.Threading.Tasks - 4.0.0.0 - 4.0.10.0 - - - Initializes a new . - - - - - - - - - - Constructor - - System.Threading.Tasks - 4.0.0.0 - 4.0.10.0 - - - mscorlib - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Runtime - 4.2.0.0 - 4.2.1.0 - 4.2.2.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - - - - The delegate that represents the code to execute in the task. - Initializes a new with the specified action. - + ]]> + + All members of , except for , are thread-safe and may be used from multiple threads concurrently. + + Task Parallel Library (TPL) + Task-based asynchronous pattern (TAP) in .NET: Introduction and overview + Task-based Asynchronous Programming + Samples for Parallel Programming with the .NET Core and .NET Standard + + + + + System.Threading.Tasks + 4.0.0.0 + 4.0.10.0 + + + Initializes a new . + + + + + + + + + + Constructor + + System.Threading.Tasks + 4.0.0.0 + 4.0.10.0 + + + mscorlib + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Runtime + 4.2.0.0 + 4.2.1.0 + 4.2.2.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + + + + The delegate that represents the code to execute in the task. + Initializes a new with the specified action. + - - The argument is . - - - - - - - - - - - Constructor - - System.Threading.Tasks - 4.0.0.0 - 4.0.10.0 - - - mscorlib - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Runtime - 4.2.0.0 - 4.2.1.0 - 4.2.2.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - - - - - The delegate that represents the code to execute in the task. - The that the new task will observe. - Initializes a new with the specified action and . - + ]]> + + The argument is . + + + + + + + + + + + Constructor + + System.Threading.Tasks + 4.0.0.0 + 4.0.10.0 + + + mscorlib + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Runtime + 4.2.0.0 + 4.2.1.0 + 4.2.2.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + + + + + The delegate that represents the code to execute in the task. + The that the new task will observe. + Initializes a new with the specified action and . + - - The provided has already been disposed. - The argument is null. - - - - - - - - - - Constructor - - System.Threading.Tasks - 4.0.0.0 - 4.0.10.0 - - - mscorlib - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Runtime - 4.2.0.0 - 4.2.1.0 - 4.2.2.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - - - - - The delegate that represents the code to execute in the task. - The used to customize the task's behavior. - Initializes a new with the specified action and creation options. - + ]]> + + The provided has already been disposed. + The argument is null. + + + + + + + + + + Constructor + + System.Threading.Tasks + 4.0.0.0 + 4.0.10.0 + + + mscorlib + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Runtime + 4.2.0.0 + 4.2.1.0 + 4.2.2.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + + + + + The delegate that represents the code to execute in the task. + The used to customize the task's behavior. + Initializes a new with the specified action and creation options. + object and launch a task is by calling the static method. The only advantage offered by this constructor is that it allows object instantiation to be separated from task invocation. - ]]> - - The argument is null. - The argument specifies an invalid value for . - - - - - - - - - - - Constructor - - System.Threading.Tasks - 4.0.0.0 - 4.0.10.0 - - - mscorlib - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Runtime - 4.2.0.0 - 4.2.1.0 - 4.2.2.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - - [System.Runtime.CompilerServices.NullableContext(2)] - [<System.Runtime.CompilerServices.NullableContext(2)>] - - - - - - - [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 1, 2 })] - [<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 1, 2 })>] - - - - - - - The delegate that represents the code to execute in the task. - An object representing data to be used by the action. - Initializes a new with the specified action and state. - + ]]> + + The argument is null. + The argument specifies an invalid value for . + + + + + + + + + + + Constructor + + System.Threading.Tasks + 4.0.0.0 + 4.0.10.0 + + + mscorlib + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Runtime + 4.2.0.0 + 4.2.1.0 + 4.2.2.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + + [System.Runtime.CompilerServices.NullableContext(2)] + [<System.Runtime.CompilerServices.NullableContext(2)>] + + + + + + + [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 1, 2 })] + [<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 1, 2 })>] + + + + + + + The delegate that represents the code to execute in the task. + An object representing data to be used by the action. + Initializes a new with the specified action and state. + - - The argument is null. - - - - - - - - - - - Constructor - - System.Threading.Tasks - 4.0.0.0 - 4.0.10.0 - - - mscorlib - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Runtime - 4.2.0.0 - 4.2.1.0 - 4.2.2.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - - - - - - The delegate that represents the code to execute in the task. - The that the new task will observe. - The used to customize the task's behavior. - Initializes a new with the specified action and creation options. - + ]]> + + The argument is null. + + + + + + + + + + + Constructor + + System.Threading.Tasks + 4.0.0.0 + 4.0.10.0 + + + mscorlib + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Runtime + 4.2.0.0 + 4.2.1.0 + 4.2.2.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + + + + + + The delegate that represents the code to execute in the task. + The that the new task will observe. + The used to customize the task's behavior. + Initializes a new with the specified action and creation options. + - - The that created has already been disposed. - The argument is null. - The argument specifies an invalid value for . - - - - - - - - - - - Constructor - - System.Threading.Tasks - 4.0.0.0 - 4.0.10.0 - - - mscorlib - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Runtime - 4.2.0.0 - 4.2.1.0 - 4.2.2.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - - [System.Runtime.CompilerServices.NullableContext(2)] - [<System.Runtime.CompilerServices.NullableContext(2)>] - - - - - - - [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 1, 2 })] - [<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 1, 2 })>] - - - - - - - - The delegate that represents the code to execute in the task. - An object representing data to be used by the action. - The that the new task will observe. - Initializes a new with the specified action, state, and options. - + ]]> + + The that created has already been disposed. + The argument is null. + The argument specifies an invalid value for . + + + + + + + + + + + Constructor + + System.Threading.Tasks + 4.0.0.0 + 4.0.10.0 + + + mscorlib + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Runtime + 4.2.0.0 + 4.2.1.0 + 4.2.2.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + + [System.Runtime.CompilerServices.NullableContext(2)] + [<System.Runtime.CompilerServices.NullableContext(2)>] + + + + + + + [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 1, 2 })] + [<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 1, 2 })>] + + + + + + + + The delegate that represents the code to execute in the task. + An object representing data to be used by the action. + The that the new task will observe. + Initializes a new with the specified action, state, and options. + object and launch a task is by calling the static method. The only advantage offered by this constructor is that it allows object instantiation to be separated from task invocation. - ]]> - - The that created has already been disposed. - The argument is null. - - - - - - - - - - - Constructor - - System.Threading.Tasks - 4.0.0.0 - 4.0.10.0 - - - mscorlib - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Runtime - 4.2.0.0 - 4.2.1.0 - 4.2.2.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - - [System.Runtime.CompilerServices.NullableContext(2)] - [<System.Runtime.CompilerServices.NullableContext(2)>] - - - - - - - [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 1, 2 })] - [<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 1, 2 })>] - - - - - - - - The delegate that represents the code to execute in the task. - An object representing data to be used by the action. - The used to customize the task's behavior. - Initializes a new with the specified action, state, and options. - + ]]> + + The that created has already been disposed. + The argument is null. + + + + + + + + + + + Constructor + + System.Threading.Tasks + 4.0.0.0 + 4.0.10.0 + + + mscorlib + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Runtime + 4.2.0.0 + 4.2.1.0 + 4.2.2.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + + [System.Runtime.CompilerServices.NullableContext(2)] + [<System.Runtime.CompilerServices.NullableContext(2)>] + + + + + + + [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 1, 2 })] + [<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 1, 2 })>] + + + + + + + + The delegate that represents the code to execute in the task. + An object representing data to be used by the action. + The used to customize the task's behavior. + Initializes a new with the specified action, state, and options. + object and launch a task is by calling the static method. The only advantage offered by this constructor is that it allows object instantiation to be separated from task invocation. - ]]> - - The argument is null. - The argument specifies an invalid value for . - - - - - - - - - - - Constructor - - System.Threading.Tasks - 4.0.0.0 - 4.0.10.0 - - - mscorlib - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Runtime - 4.2.0.0 - 4.2.1.0 - 4.2.2.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - - [System.Runtime.CompilerServices.NullableContext(2)] - [<System.Runtime.CompilerServices.NullableContext(2)>] - - - - - - - [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 1, 2 })] - [<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 1, 2 })>] - - - - - - - - - The delegate that represents the code to execute in the task. - An object representing data to be used by the action. - The that the new task will observe. - The used to customize the task's behavior. - Initializes a new with the specified action, state, and options. - + ]]> + + The argument is null. + The argument specifies an invalid value for . + + + + + + + + + + + Constructor + + System.Threading.Tasks + 4.0.0.0 + 4.0.10.0 + + + mscorlib + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Runtime + 4.2.0.0 + 4.2.1.0 + 4.2.2.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + + [System.Runtime.CompilerServices.NullableContext(2)] + [<System.Runtime.CompilerServices.NullableContext(2)>] + + + + + + + [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 1, 2 })] + [<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 1, 2 })>] + + + + + + + + + The delegate that represents the code to execute in the task. + An object representing data to be used by the action. + The that the new task will observe. + The used to customize the task's behavior. + Initializes a new with the specified action, state, and options. + object and launch a task is by calling the static method. The only advantage offered by this constructor is that it allows object instantiation to be separated from task invocation. - ]]> - - The that created has already been disposed. - The argument is null. - The argument specifies an invalid value for . - - - - - - - - - - - Property - - P:System.IAsyncResult.AsyncState - - - System.Threading.Tasks - 4.0.0.0 - 4.0.10.0 - - - mscorlib - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Runtime - 4.2.0.0 - 4.2.1.0 - 4.2.2.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - - [System.Runtime.CompilerServices.Nullable(2)] - [<System.Runtime.CompilerServices.Nullable(2)>] - - - [get: System.Runtime.CompilerServices.NullableContext(2)] - [<get: System.Runtime.CompilerServices.NullableContext(2)>] - - - - System.Object - - - Gets the state object supplied when the was created, or null if none was supplied. - An that represents the state data that was passed in to the task when it was created. - + ]]> + + The that created has already been disposed. + The argument is null. + The argument specifies an invalid value for . + + + + + + + + + + + Property + + P:System.IAsyncResult.AsyncState + + + System.Threading.Tasks + 4.0.0.0 + 4.0.10.0 + + + mscorlib + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Runtime + 4.2.0.0 + 4.2.1.0 + 4.2.2.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + + [System.Runtime.CompilerServices.Nullable(2)] + [<System.Runtime.CompilerServices.Nullable(2)>] + + + [get: System.Runtime.CompilerServices.NullableContext(2)] + [<get: System.Runtime.CompilerServices.NullableContext(2)>] + + + + System.Object + + + Gets the state object supplied when the was created, or null if none was supplied. + An that represents the state data that was passed in to the task when it was created. + - - - - - - - - - - - Property - - System.Threading.Tasks - 4.0.10.0 - - - mscorlib - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Runtime - 4.2.0.0 - 4.2.1.0 - 4.2.2.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - System.Threading.Tasks.Task - - - Gets a task that has already completed successfully. - The successfully completed task. - + ]]> + + + + + + + + + + + Property + + System.Threading.Tasks + 4.0.10.0 + + + mscorlib + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Runtime + 4.2.0.0 + 4.2.1.0 + 4.2.2.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + System.Threading.Tasks.Task + + + Gets a task that has already completed successfully. + The successfully completed task. + - - - - - - - - - - - - Method - - System.Threading.Tasks - 4.0.0.0 - 4.0.10.0 - - - mscorlib - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Runtime - 4.2.0.0 - 4.2.1.0 - 4.2.2.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - - [System.Runtime.TargetedPatchingOptOut("Performance critical to inline across NGen image boundaries")] - [<System.Runtime.TargetedPatchingOptOut("Performance critical to inline across NGen image boundaries")>] - - - - System.Runtime.CompilerServices.ConfiguredTaskAwaitable - - - - - - - to attempt to marshal the continuation back to the original context captured; otherwise, . - Configures an awaiter used to await this . - An object used to await this task. - + ]]> + + + + + + + + + + + + Method + + System.Threading.Tasks + 4.0.0.0 + 4.0.10.0 + + + mscorlib + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Runtime + 4.2.0.0 + 4.2.1.0 + 4.2.2.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + + [System.Runtime.TargetedPatchingOptOut("Performance critical to inline across NGen image boundaries")] + [<System.Runtime.TargetedPatchingOptOut("Performance critical to inline across NGen image boundaries")>] + + + + System.Runtime.CompilerServices.ConfiguredTaskAwaitable + + + + + + + to attempt to marshal the continuation back to the original context captured; otherwise, . + Configures an awaiter used to await this . + An object used to await this task. + directly, continuation usually occurs in the same thread that created the task, depending on the async context. This behavior can be costly in terms of performance and can result in a deadlock on the UI thread. To avoid these problems, call `Task.ConfigureAwait(false)`. For more information, see [ConfigureAwait FAQ](https://devblogs.microsoft.com/dotnet/configureawait-faq/). - ]]> - - ConfigureAwait FAQ - - - - - - - - - - Method - - System.Runtime - 8.0.0.0 - - - System.Threading.Tasks - - - mscorlib - - - netstandard - - - System.Runtime.CompilerServices.ConfiguredTaskAwaitable - - - - - - Options used to configure how awaits on this task are performed. - Configures an awaiter used to await this . - An object used to await this task. - To be added. - The argument specifies an invalid value. - - - - - System.Threading.Tasks - 4.0.0.0 - 4.0.10.0 - - - Creates a continuation that executes asynchronously when the target completes. - - - - - - - - - - Method - - System.Threading.Tasks - 4.0.0.0 - 4.0.10.0 - - - mscorlib - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Runtime - 4.2.0.0 - 4.2.1.0 - 4.2.2.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - System.Threading.Tasks.Task - - - - - - An action to run when the completes. When run, the delegate will be passed the completed task as an argument. - Creates a continuation that executes asynchronously when the target completes. - A new continuation . - + ]]> + + ConfigureAwait FAQ + + + + + + + + + + Method + + System.Runtime + 8.0.0.0 + + + System.Threading.Tasks + + + mscorlib + + + netstandard + + + System.Runtime.CompilerServices.ConfiguredTaskAwaitable + + + + + + Options used to configure how awaits on this task are performed. + Configures an awaiter used to await this . + An object used to await this task. + To be added. + The argument specifies an invalid value. + + + + + System.Threading.Tasks + 4.0.0.0 + 4.0.10.0 + + + Creates a continuation that executes asynchronously when the target completes. + + + + + + + + + + Method + + System.Threading.Tasks + 4.0.0.0 + 4.0.10.0 + + + mscorlib + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Runtime + 4.2.0.0 + 4.2.1.0 + 4.2.2.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + System.Threading.Tasks.Task + + + + + + An action to run when the completes. When run, the delegate will be passed the completed task as an argument. + Creates a continuation that executes asynchronously when the target completes. + A new continuation . + directly For an additional example, see [Chaining Tasks by Using Continuation Tasks](/dotnet/standard/parallel-programming/chaining-tasks-by-using-continuation-tasks). - ]]> - - The argument is . - - - - - - - - - - - Method - - System.Threading.Tasks - 4.0.0.0 - 4.0.10.0 - - - mscorlib - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Runtime - 4.2.0.0 - 4.2.1.0 - 4.2.2.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - System.Threading.Tasks.Task - - - - - - [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 1, 1, 2 })] - [<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 1, 1, 2 })>] - - - - - - - [System.Runtime.CompilerServices.Nullable(2)] - [<System.Runtime.CompilerServices.Nullable(2)>] - - - - - - An action to run when the task completes. When run, the delegate is passed the completed task and a caller-supplied state object as arguments. - An object representing data to be used by the continuation action. - Creates a continuation that receives caller-supplied state information and executes when the target completes. - A new continuation task. - + ]]> + + The argument is . + + + + + + + + + + + Method + + System.Threading.Tasks + 4.0.0.0 + 4.0.10.0 + + + mscorlib + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Runtime + 4.2.0.0 + 4.2.1.0 + 4.2.2.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + System.Threading.Tasks.Task + + + + + + [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 1, 1, 2 })] + [<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 1, 1, 2 })>] + + + + + + + [System.Runtime.CompilerServices.Nullable(2)] + [<System.Runtime.CompilerServices.Nullable(2)>] + + + + + + An action to run when the task completes. When run, the delegate is passed the completed task and a caller-supplied state object as arguments. + An object representing data to be used by the continuation action. + Creates a continuation that receives caller-supplied state information and executes when the target completes. + A new continuation task. + will not be scheduled for execution until the current task has completed, whether it completes due to running to completion successfully, faulting due to an unhandled exception, or exiting early due to cancellation. - ]]> - - The argument is . - - - - - - - - - - Method - - System.Threading.Tasks - 4.0.0.0 - 4.0.10.0 - - - mscorlib - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Runtime - 4.2.0.0 - 4.2.1.0 - 4.2.2.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - System.Threading.Tasks.Task - - - - - - - An action to run when the completes. When run, the delegate will be passed the completed task as an argument. - The that will be assigned to the new continuation task. - Creates a continuation that receives a cancellation token and executes asynchronously when the target completes. - A new continuation . - + ]]> + + The argument is . + + + + + + + + + + Method + + System.Threading.Tasks + 4.0.0.0 + 4.0.10.0 + + + mscorlib + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Runtime + 4.2.0.0 + 4.2.1.0 + 4.2.2.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + System.Threading.Tasks.Task + + + + + + + An action to run when the completes. When run, the delegate will be passed the completed task as an argument. + The that will be assigned to the new continuation task. + Creates a continuation that receives a cancellation token and executes asynchronously when the target completes. + A new continuation . + will not be scheduled for execution until the current task has completed, whether it completes due to running to completion successfully, faulting due to an unhandled exception, or exiting out early due to being canceled. - ]]> - - The that created the token has already been disposed. - The argument is null. - - - - - - - - - - Method - - System.Threading.Tasks - 4.0.0.0 - 4.0.10.0 - - - mscorlib - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Runtime - 4.2.0.0 - 4.2.1.0 - 4.2.2.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - System.Threading.Tasks.Task - - - - - - - An action to run according to the specified . When run, the delegate will be passed the completed task as an argument. - Options for when the continuation is scheduled and how it behaves. This includes criteria, such as , as well as execution options, such as . - Creates a continuation that executes when the target task completes according to the specified . - A new continuation . - + ]]> + + The that created the token has already been disposed. + The argument is null. + + + + + + + + + + Method + + System.Threading.Tasks + 4.0.0.0 + 4.0.10.0 + + + mscorlib + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Runtime + 4.2.0.0 + 4.2.1.0 + 4.2.2.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + System.Threading.Tasks.Task + + + + + + + An action to run according to the specified . When run, the delegate will be passed the completed task as an argument. + Options for when the continuation is scheduled and how it behaves. This includes criteria, such as , as well as execution options, such as . + Creates a continuation that executes when the target task completes according to the specified . + A new continuation . + - - The argument is null. - The argument specifies an invalid value for . - - - - - - - - - - Method - - System.Threading.Tasks - 4.0.0.0 - 4.0.10.0 - - - mscorlib - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Runtime - 4.2.0.0 - 4.2.1.0 - 4.2.2.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - System.Threading.Tasks.Task - - - - - - - An action to run when the completes. When run, the delegate will be passed the completed task as an argument. - The to associate with the continuation task and to use for its execution. - Creates a continuation that executes asynchronously when the target completes. The continuation uses a specified scheduler. - A new continuation . - + ]]> + + The argument is null. + The argument specifies an invalid value for . + + + + + + + + + + Method + + System.Threading.Tasks + 4.0.0.0 + 4.0.10.0 + + + mscorlib + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Runtime + 4.2.0.0 + 4.2.1.0 + 4.2.2.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + System.Threading.Tasks.Task + + + + + + + An action to run when the completes. When run, the delegate will be passed the completed task as an argument. + The to associate with the continuation task and to use for its execution. + Creates a continuation that executes asynchronously when the target completes. The continuation uses a specified scheduler. + A new continuation . + will not be scheduled for execution until the current task has completed, whether it completes due to running to completion successfully, faulting due to an unhandled exception, or exiting out early due to being canceled. - ]]> - - The has been disposed. + ]]> + + The has been disposed. The argument is . -or- - The argument is null. - - - - - - - - - - - Method - - System.Threading.Tasks - 4.0.0.0 - 4.0.10.0 - - - mscorlib - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Runtime - 4.2.0.0 - 4.2.1.0 - 4.2.2.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - System.Threading.Tasks.Task - - - - - - [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 1, 1, 2 })] - [<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 1, 1, 2 })>] - - - - - - - [System.Runtime.CompilerServices.Nullable(2)] - [<System.Runtime.CompilerServices.Nullable(2)>] - - - - - - - An action to run when the completes. When run, the delegate will be passed the completed task and the caller-supplied state object as arguments. - An object representing data to be used by the continuation action. - The that will be assigned to the new continuation task. - Creates a continuation that receives caller-supplied state information and a cancellation token and that executes asynchronously when the target completes. - A new continuation . - + The argument is null. + + + + + + + + + + + Method + + System.Threading.Tasks + 4.0.0.0 + 4.0.10.0 + + + mscorlib + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Runtime + 4.2.0.0 + 4.2.1.0 + 4.2.2.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + System.Threading.Tasks.Task + + + + + + [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 1, 1, 2 })] + [<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 1, 1, 2 })>] + + + + + + + [System.Runtime.CompilerServices.Nullable(2)] + [<System.Runtime.CompilerServices.Nullable(2)>] + + + + + + + An action to run when the completes. When run, the delegate will be passed the completed task and the caller-supplied state object as arguments. + An object representing data to be used by the continuation action. + The that will be assigned to the new continuation task. + Creates a continuation that receives caller-supplied state information and a cancellation token and that executes asynchronously when the target completes. + A new continuation . + will not be scheduled for execution until the current task has completed, whether it completes due to running to completion successfully, faulting due to an unhandled exception, or exiting out early due to being canceled. - ]]> - - The argument is . - The provided has already been disposed. - - - - - - - - - - - Method - - System.Threading.Tasks - 4.0.0.0 - 4.0.10.0 - - - mscorlib - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Runtime - 4.2.0.0 - 4.2.1.0 - 4.2.2.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - System.Threading.Tasks.Task - - - - - - [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 1, 1, 2 })] - [<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 1, 1, 2 })>] - - - - - - - [System.Runtime.CompilerServices.Nullable(2)] - [<System.Runtime.CompilerServices.Nullable(2)>] - - - - - - - An action to run when the completes. When run, the delegate will be passed the completed task and the caller-supplied state object as arguments. - An object representing data to be used by the continuation action. - Options for when the continuation is scheduled and how it behaves. This includes criteria, such as , as well as execution options, such as . - Creates a continuation that receives caller-supplied state information and executes when the target completes. The continuation executes based on a set of specified conditions. - A new continuation . - + ]]> + + The argument is . + The provided has already been disposed. + + + + + + + + + + + Method + + System.Threading.Tasks + 4.0.0.0 + 4.0.10.0 + + + mscorlib + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Runtime + 4.2.0.0 + 4.2.1.0 + 4.2.2.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + System.Threading.Tasks.Task + + + + + + [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 1, 1, 2 })] + [<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 1, 1, 2 })>] + + + + + + + [System.Runtime.CompilerServices.Nullable(2)] + [<System.Runtime.CompilerServices.Nullable(2)>] + + + + + + + An action to run when the completes. When run, the delegate will be passed the completed task and the caller-supplied state object as arguments. + An object representing data to be used by the continuation action. + Options for when the continuation is scheduled and how it behaves. This includes criteria, such as , as well as execution options, such as . + Creates a continuation that receives caller-supplied state information and executes when the target completes. The continuation executes based on a set of specified conditions. + A new continuation . + will not be scheduled for execution until the current task has completed. If the continuation criteria specified through the `continuationOptions` parameter are not met, the continuation task will be canceled instead of scheduled. - ]]> - - The argument is . - The argument specifies an invalid value for . - - - - - - - - - - - Method - - System.Threading.Tasks - 4.0.0.0 - 4.0.10.0 - - - mscorlib - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Runtime - 4.2.0.0 - 4.2.1.0 - 4.2.2.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - System.Threading.Tasks.Task - - - - - - [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 1, 1, 2 })] - [<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 1, 1, 2 })>] - - - - - - - [System.Runtime.CompilerServices.Nullable(2)] - [<System.Runtime.CompilerServices.Nullable(2)>] - - - - - - - An action to run when the completes. When run, the delegate will be passed the completed task and the caller-supplied state object as arguments. - An object representing data to be used by the continuation action. - The to associate with the continuation task and to use for its execution. - Creates a continuation that receives caller-supplied state information and executes asynchronously when the target completes. The continuation uses a specified scheduler. - A new continuation . - + ]]> + + The argument is . + The argument specifies an invalid value for . + + + + + + + + + + + Method + + System.Threading.Tasks + 4.0.0.0 + 4.0.10.0 + + + mscorlib + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Runtime + 4.2.0.0 + 4.2.1.0 + 4.2.2.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + System.Threading.Tasks.Task + + + + + + [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 1, 1, 2 })] + [<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 1, 1, 2 })>] + + + + + + + [System.Runtime.CompilerServices.Nullable(2)] + [<System.Runtime.CompilerServices.Nullable(2)>] + + + + + + + An action to run when the completes. When run, the delegate will be passed the completed task and the caller-supplied state object as arguments. + An object representing data to be used by the continuation action. + The to associate with the continuation task and to use for its execution. + Creates a continuation that receives caller-supplied state information and executes asynchronously when the target completes. The continuation uses a specified scheduler. + A new continuation . + will not be scheduled for execution until the current task has completed, whether it completes due to running to completion successfully, faulting due to an unhandled exception, or exiting out early due to being canceled. - ]]> - - The argument is . - - - - - - - - - - Method - - System.Threading.Tasks - 4.0.0.0 - 4.0.10.0 - - - mscorlib - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Runtime - 4.2.0.0 - 4.2.1.0 - 4.2.2.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - System.Threading.Tasks.Task - - - - - - - - - An action to run according to the specified . When run, the delegate will be passed the completed task as an argument. - The that will be assigned to the new continuation task. - Options for when the continuation is scheduled and how it behaves. This includes criteria, such as , as well as execution options, such as . - The to associate with the continuation task and to use for its execution. - Creates a continuation that executes when the target task competes according to the specified . The continuation receives a cancellation token and uses a specified scheduler. - A new continuation . - + ]]> + + The argument is . + + + + + + + + + + Method + + System.Threading.Tasks + 4.0.0.0 + 4.0.10.0 + + + mscorlib + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Runtime + 4.2.0.0 + 4.2.1.0 + 4.2.2.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + System.Threading.Tasks.Task + + + + + + + + + An action to run according to the specified . When run, the delegate will be passed the completed task as an argument. + The that will be assigned to the new continuation task. + Options for when the continuation is scheduled and how it behaves. This includes criteria, such as , as well as execution options, such as . + The to associate with the continuation task and to use for its execution. + Creates a continuation that executes when the target task competes according to the specified . The continuation receives a cancellation token and uses a specified scheduler. + A new continuation . + will not be scheduled for execution until the current task has completed. If the criteria specified through the `continuationOptions` parameter are not met, the continuation task will be canceled instead of scheduled. - - ## Examples The following is an example of using ContinueWith to run work both in the background and on the user interface threads. @@ -1630,151 +1629,151 @@ End Sub ``` - ]]> - - The that created the token has already been disposed. + ]]> + + The that created the token has already been disposed. The argument is null. -or- - The argument is null. - The argument specifies an invalid value for . - - - - - - - - - - - Method - - System.Threading.Tasks - 4.0.0.0 - 4.0.10.0 - - - mscorlib - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Runtime - 4.2.0.0 - 4.2.1.0 - 4.2.2.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - System.Threading.Tasks.Task - - - - - - [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 1, 1, 2 })] - [<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 1, 1, 2 })>] - - - - - - - [System.Runtime.CompilerServices.Nullable(2)] - [<System.Runtime.CompilerServices.Nullable(2)>] - - - - - - - - - An action to run when the completes. When run, the delegate will be passed the completed task and the caller-supplied state object as arguments. - An object representing data to be used by the continuation action. - The that will be assigned to the new continuation task. - Options for when the continuation is scheduled and how it behaves. This includes criteria, such as , as well as execution options, such as . - The to associate with the continuation task and to use for its execution. - Creates a continuation that receives caller-supplied state information and a cancellation token and that executes when the target completes. The continuation executes based on a set of specified conditions and uses a specified scheduler. - A new continuation . - + The argument is null. + The argument specifies an invalid value for . + + + + + + + + + + + Method + + System.Threading.Tasks + 4.0.0.0 + 4.0.10.0 + + + mscorlib + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Runtime + 4.2.0.0 + 4.2.1.0 + 4.2.2.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + System.Threading.Tasks.Task + + + + + + [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 1, 1, 2 })] + [<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 1, 1, 2 })>] + + + + + + + [System.Runtime.CompilerServices.Nullable(2)] + [<System.Runtime.CompilerServices.Nullable(2)>] + + + + + + + + + An action to run when the completes. When run, the delegate will be passed the completed task and the caller-supplied state object as arguments. + An object representing data to be used by the continuation action. + The that will be assigned to the new continuation task. + Options for when the continuation is scheduled and how it behaves. This includes criteria, such as , as well as execution options, such as . + The to associate with the continuation task and to use for its execution. + Creates a continuation that receives caller-supplied state information and a cancellation token and that executes when the target completes. The continuation executes based on a set of specified conditions and uses a specified scheduler. + A new continuation . + will not be scheduled for execution until the current task has completed. If the criteria specified through the `continuationOptions` parameter are not met, the continuation task will be canceled instead of scheduled. - ]]> - - The argument is . - The argument specifies an invalid value for . - The provided has already been disposed. - - - - - - - - - - Method - - System.Threading.Tasks - 4.0.0.0 - 4.0.10.0 - - - mscorlib - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Runtime - 4.2.0.0 - 4.2.1.0 - 4.2.2.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - System.Threading.Tasks.Task<TResult> - - - - - - [System.Runtime.CompilerServices.Nullable(2)] - [<System.Runtime.CompilerServices.Nullable(2)>] - - - - - - - - - The type of the result produced by the continuation. - A function to run when the completes. When run, the delegate will be passed the completed task as an argument. - Creates a continuation that executes asynchronously when the target completes and returns a value. - A new continuation task. - + ]]> + + The argument is . + The argument specifies an invalid value for . + The provided has already been disposed. + + + + + + + + + + Method + + System.Threading.Tasks + 4.0.0.0 + 4.0.10.0 + + + mscorlib + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Runtime + 4.2.0.0 + 4.2.1.0 + 4.2.2.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + System.Threading.Tasks.Task<TResult> + + + + + + [System.Runtime.CompilerServices.Nullable(2)] + [<System.Runtime.CompilerServices.Nullable(2)>] + + + + + + + + + The type of the result produced by the continuation. + A function to run when the completes. When run, the delegate will be passed the completed task as an argument. + Creates a continuation that executes asynchronously when the target completes and returns a value. + A new continuation task. + - - The has been disposed. - The argument is null. - - - - - - - - - - - Method - - System.Threading.Tasks - 4.0.0.0 - 4.0.10.0 - - - mscorlib - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Runtime - 4.2.0.0 - 4.2.1.0 - 4.2.2.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - - [System.Runtime.CompilerServices.NullableContext(2)] - [<System.Runtime.CompilerServices.NullableContext(2)>] - - - - System.Threading.Tasks.Task<TResult> - - - - - - - - - [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 1, 1, 2, 1 })] - [<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 1, 1, 2, 1 })>] - - - - - - - The type of the result produced by the continuation. - A function to run when the completes. When run, the delegate will be passed the completed task and the caller-supplied state object as arguments. - An object representing data to be used by the continuation function. - Creates a continuation that receives caller-supplied state information and executes asynchronously when the target completes and returns a value. - A new continuation . - + ]]> + + The has been disposed. + The argument is null. + + + + + + + + + + + Method + + System.Threading.Tasks + 4.0.0.0 + 4.0.10.0 + + + mscorlib + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Runtime + 4.2.0.0 + 4.2.1.0 + 4.2.2.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + + [System.Runtime.CompilerServices.NullableContext(2)] + [<System.Runtime.CompilerServices.NullableContext(2)>] + + + + System.Threading.Tasks.Task<TResult> + + + + + + + + + [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 1, 1, 2, 1 })] + [<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 1, 1, 2, 1 })>] + + + + + + + The type of the result produced by the continuation. + A function to run when the completes. When run, the delegate will be passed the completed task and the caller-supplied state object as arguments. + An object representing data to be used by the continuation function. + Creates a continuation that receives caller-supplied state information and executes asynchronously when the target completes and returns a value. + A new continuation . + will not be scheduled for execution until the current task has completed, whether it completes due to running to completion successfully, faulting due to an unhandled exception, or exiting out early due to being canceled. - ]]> - - The argument is . - - - - - - - - - - Method - - System.Threading.Tasks - 4.0.0.0 - 4.0.10.0 - - - mscorlib - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Runtime - 4.2.0.0 - 4.2.1.0 - 4.2.2.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - System.Threading.Tasks.Task<TResult> - - - - - - [System.Runtime.CompilerServices.Nullable(2)] - [<System.Runtime.CompilerServices.Nullable(2)>] - - - - - - - - - - The type of the result produced by the continuation. - A function to run when the completes. When run, the delegate will be passed the completed task as an argument. - The that will be assigned to the new continuation task. - Creates a continuation that executes asynchronously when the target completes and returns a value. The continuation receives a cancellation token. - A new continuation . - + ]]> + + The argument is . + + + + + + + + + + Method + + System.Threading.Tasks + 4.0.0.0 + 4.0.10.0 + + + mscorlib + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Runtime + 4.2.0.0 + 4.2.1.0 + 4.2.2.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + System.Threading.Tasks.Task<TResult> + + + + + + [System.Runtime.CompilerServices.Nullable(2)] + [<System.Runtime.CompilerServices.Nullable(2)>] + + + + + + + + + + The type of the result produced by the continuation. + A function to run when the completes. When run, the delegate will be passed the completed task as an argument. + The that will be assigned to the new continuation task. + Creates a continuation that executes asynchronously when the target completes and returns a value. The continuation receives a cancellation token. + A new continuation . + will not be scheduled for execution until the current task has completed, whether it completes due to running to completion successfully, faulting due to an unhandled exception, or exiting out early due to being canceled. - ]]> - + ]]> + The has been disposed. -or- - The that created the token has already been disposed. - The argument is null. - - - - - - - - - - Method - - System.Threading.Tasks - 4.0.0.0 - 4.0.10.0 - - - mscorlib - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Runtime - 4.2.0.0 - 4.2.1.0 - 4.2.2.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - System.Threading.Tasks.Task<TResult> - - - - - - [System.Runtime.CompilerServices.Nullable(2)] - [<System.Runtime.CompilerServices.Nullable(2)>] - - - - - - - - - - The type of the result produced by the continuation. - A function to run according to the condition specified in . When run, the delegate will be passed the completed task as an argument. - Options for when the continuation is scheduled and how it behaves. This includes criteria, such as , as well as execution options, such as . - Creates a continuation that executes according to the specified continuation options and returns a value. - A new continuation . - + The that created the token has already been disposed. + The argument is null. + + + + + + + + + + Method + + System.Threading.Tasks + 4.0.0.0 + 4.0.10.0 + + + mscorlib + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Runtime + 4.2.0.0 + 4.2.1.0 + 4.2.2.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + System.Threading.Tasks.Task<TResult> + + + + + + [System.Runtime.CompilerServices.Nullable(2)] + [<System.Runtime.CompilerServices.Nullable(2)>] + + + + + + + + + + The type of the result produced by the continuation. + A function to run according to the condition specified in . When run, the delegate will be passed the completed task as an argument. + Options for when the continuation is scheduled and how it behaves. This includes criteria, such as , as well as execution options, such as . + Creates a continuation that executes according to the specified continuation options and returns a value. + A new continuation . + will not be scheduled for execution until the current task has completed. If the continuation criteria specified through the `continuationOptions` parameter are not met, the continuation task will be canceled instead of scheduled. - ]]> - - The has been disposed. - The argument is null. - The argument specifies an invalid value for . - - - - - - - - - - Method - - System.Threading.Tasks - 4.0.0.0 - 4.0.10.0 - - - mscorlib - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Runtime - 4.2.0.0 - 4.2.1.0 - 4.2.2.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - System.Threading.Tasks.Task<TResult> - - - - - - [System.Runtime.CompilerServices.Nullable(2)] - [<System.Runtime.CompilerServices.Nullable(2)>] - - - - - - - - - - The type of the result produced by the continuation. - A function to run when the completes. When run, the delegate will be passed the completed task as an argument. - The to associate with the continuation task and to use for its execution. - Creates a continuation that executes asynchronously when the target completes and returns a value. The continuation uses a specified scheduler. - A new continuation . - + ]]> + + The has been disposed. + The argument is null. + The argument specifies an invalid value for . + + + + + + + + + + Method + + System.Threading.Tasks + 4.0.0.0 + 4.0.10.0 + + + mscorlib + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Runtime + 4.2.0.0 + 4.2.1.0 + 4.2.2.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + System.Threading.Tasks.Task<TResult> + + + + + + [System.Runtime.CompilerServices.Nullable(2)] + [<System.Runtime.CompilerServices.Nullable(2)>] + + + + + + + + + + The type of the result produced by the continuation. + A function to run when the completes. When run, the delegate will be passed the completed task as an argument. + The to associate with the continuation task and to use for its execution. + Creates a continuation that executes asynchronously when the target completes and returns a value. The continuation uses a specified scheduler. + A new continuation . + will not be scheduled for execution until the current task has completed, whether it completes due to running to completion successfully, faulting due to an unhandled exception, or exiting out early due to being canceled. - ]]> - - The has been disposed. + ]]> + + The has been disposed. The argument is null. -or- - The argument is null. - - - - - - - - - - - Method - - System.Threading.Tasks - 4.0.0.0 - 4.0.10.0 - - - mscorlib - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Runtime - 4.2.0.0 - 4.2.1.0 - 4.2.2.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - - [System.Runtime.CompilerServices.NullableContext(2)] - [<System.Runtime.CompilerServices.NullableContext(2)>] - - - - System.Threading.Tasks.Task<TResult> - - - - - - - - - [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 1, 1, 2, 1 })] - [<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 1, 1, 2, 1 })>] - - - - - - - - The type of the result produced by the continuation. - A function to run when the completes. When run, the delegate will be passed the completed task and the caller-supplied state object as arguments. - An object representing data to be used by the continuation function. - The that will be assigned to the new continuation task. - Creates a continuation that executes asynchronously when the target completes and returns a value. The continuation receives caller-supplied state information and a cancellation token. - A new continuation . - + The argument is null. + + + + + + + + + + + Method + + System.Threading.Tasks + 4.0.0.0 + 4.0.10.0 + + + mscorlib + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Runtime + 4.2.0.0 + 4.2.1.0 + 4.2.2.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + + [System.Runtime.CompilerServices.NullableContext(2)] + [<System.Runtime.CompilerServices.NullableContext(2)>] + + + + System.Threading.Tasks.Task<TResult> + + + + + + + + + [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 1, 1, 2, 1 })] + [<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 1, 1, 2, 1 })>] + + + + + + + + The type of the result produced by the continuation. + A function to run when the completes. When run, the delegate will be passed the completed task and the caller-supplied state object as arguments. + An object representing data to be used by the continuation function. + The that will be assigned to the new continuation task. + Creates a continuation that executes asynchronously when the target completes and returns a value. The continuation receives caller-supplied state information and a cancellation token. + A new continuation . + will not be scheduled for execution until the current task has completed, whether it completes due to running to completion successfully, faulting due to an unhandled exception, or exiting out early due to being canceled. - ]]> - - The argument is . - The provided has already been disposed. - - - - - - - - - - - Method - - System.Threading.Tasks - 4.0.0.0 - 4.0.10.0 - - - mscorlib - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Runtime - 4.2.0.0 - 4.2.1.0 - 4.2.2.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - - [System.Runtime.CompilerServices.NullableContext(2)] - [<System.Runtime.CompilerServices.NullableContext(2)>] - - - - System.Threading.Tasks.Task<TResult> - - - - - - - - - [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 1, 1, 2, 1 })] - [<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 1, 1, 2, 1 })>] - - - - - - - - The type of the result produced by the continuation. - A function to run when the completes. When run, the delegate will be passed the completed task and the caller-supplied state object as arguments. - An object representing data to be used by the continuation function. - Options for when the continuation is scheduled and how it behaves. This includes criteria, such as , as well as execution options, such as . - Creates a continuation that executes based on the specified task continuation options when the target completes. The continuation receives caller-supplied state information. - A new continuation . - + ]]> + + The argument is . + The provided has already been disposed. + + + + + + + + + + + Method + + System.Threading.Tasks + 4.0.0.0 + 4.0.10.0 + + + mscorlib + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Runtime + 4.2.0.0 + 4.2.1.0 + 4.2.2.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + + [System.Runtime.CompilerServices.NullableContext(2)] + [<System.Runtime.CompilerServices.NullableContext(2)>] + + + + System.Threading.Tasks.Task<TResult> + + + + + + + + + [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 1, 1, 2, 1 })] + [<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 1, 1, 2, 1 })>] + + + + + + + + The type of the result produced by the continuation. + A function to run when the completes. When run, the delegate will be passed the completed task and the caller-supplied state object as arguments. + An object representing data to be used by the continuation function. + Options for when the continuation is scheduled and how it behaves. This includes criteria, such as , as well as execution options, such as . + Creates a continuation that executes based on the specified task continuation options when the target completes. The continuation receives caller-supplied state information. + A new continuation . + will not be scheduled for execution until the current task has completed. If the continuation criteria specified through the `continuationOptions` parameter are not met, the continuation task will be canceled instead of scheduled. - ]]> - - The argument is . - The argument specifies an invalid value for . - - - - - - - - - - - Method - - System.Threading.Tasks - 4.0.0.0 - 4.0.10.0 - - - mscorlib - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Runtime - 4.2.0.0 - 4.2.1.0 - 4.2.2.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - System.Threading.Tasks.Task<TResult> - - - - - - [System.Runtime.CompilerServices.Nullable(2)] - [<System.Runtime.CompilerServices.Nullable(2)>] - - - - - - - - - [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 1, 1, 2, 1 })] - [<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 1, 1, 2, 1 })>] - - - - - - - [System.Runtime.CompilerServices.Nullable(2)] - [<System.Runtime.CompilerServices.Nullable(2)>] - - - - - - - The type of the result produced by the continuation. - A function to run when the completes. When run, the delegate will be passed the completed task and the caller-supplied state object as arguments. - An object representing data to be used by the continuation function. - The to associate with the continuation task and to use for its execution. - Creates a continuation that executes asynchronously when the target completes. The continuation receives caller-supplied state information and uses a specified scheduler. - A new continuation . - + ]]> + + The argument is . + The argument specifies an invalid value for . + + + + + + + + + + + Method + + System.Threading.Tasks + 4.0.0.0 + 4.0.10.0 + + + mscorlib + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Runtime + 4.2.0.0 + 4.2.1.0 + 4.2.2.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + System.Threading.Tasks.Task<TResult> + + + + + + [System.Runtime.CompilerServices.Nullable(2)] + [<System.Runtime.CompilerServices.Nullable(2)>] + + + + + + + + + [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 1, 1, 2, 1 })] + [<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 1, 1, 2, 1 })>] + + + + + + + [System.Runtime.CompilerServices.Nullable(2)] + [<System.Runtime.CompilerServices.Nullable(2)>] + + + + + + + The type of the result produced by the continuation. + A function to run when the completes. When run, the delegate will be passed the completed task and the caller-supplied state object as arguments. + An object representing data to be used by the continuation function. + The to associate with the continuation task and to use for its execution. + Creates a continuation that executes asynchronously when the target completes. The continuation receives caller-supplied state information and uses a specified scheduler. + A new continuation . + will not be scheduled for execution until the current task has completed, whether it completes due to running to completion successfully, faulting due to an unhandled exception, or exiting out early due to being canceled. - ]]> - - The argument is . - - - - - - - - - - Method - - System.Threading.Tasks - 4.0.0.0 - 4.0.10.0 - - - mscorlib - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Runtime - 4.2.0.0 - 4.2.1.0 - 4.2.2.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - System.Threading.Tasks.Task<TResult> - - - - - - [System.Runtime.CompilerServices.Nullable(2)] - [<System.Runtime.CompilerServices.Nullable(2)>] - - - - - - - - - - - - The type of the result produced by the continuation. - A function to run according to the specified continuationOptions. When run, the delegate will be passed the completed task as an argument. - The that will be assigned to the new continuation task. - Options for when the continuation is scheduled and how it behaves. This includes criteria, such as , as well as execution options, such as . - The to associate with the continuation task and to use for its execution. - Creates a continuation that executes according to the specified continuation options and returns a value. The continuation is passed a cancellation token and uses a specified scheduler. - A new continuation . - + ]]> + + The argument is . + + + + + + + + + + Method + + System.Threading.Tasks + 4.0.0.0 + 4.0.10.0 + + + mscorlib + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Runtime + 4.2.0.0 + 4.2.1.0 + 4.2.2.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + System.Threading.Tasks.Task<TResult> + + + + + + [System.Runtime.CompilerServices.Nullable(2)] + [<System.Runtime.CompilerServices.Nullable(2)>] + + + + + + + + + + + + The type of the result produced by the continuation. + A function to run according to the specified continuationOptions. When run, the delegate will be passed the completed task as an argument. + The that will be assigned to the new continuation task. + Options for when the continuation is scheduled and how it behaves. This includes criteria, such as , as well as execution options, such as . + The to associate with the continuation task and to use for its execution. + Creates a continuation that executes according to the specified continuation options and returns a value. The continuation is passed a cancellation token and uses a specified scheduler. + A new continuation . + will not be scheduled for execution until the current task has completed. If the criteria specified through the `continuationOptions` parameter are not met, the continuation task will be canceled instead of scheduled. - - ## Examples The following example shows how to use the ContinueWith method with continuation options: @@ -2395,193 +2392,193 @@ End Sub :::code language="fsharp" source="~/snippets/fsharp/System.Threading.Tasks/Task/Overview/continuationoptions.fs" id="Snippet04"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.threading.tasks.task/vb/continuationoptions.vb" id="Snippet04"::: - ]]> - + ]]> + The has been disposed. -or- - The that created the token has already been disposed. + The that created the token has already been disposed. The argument is null. -or- - The argument is null. - The argument specifies an invalid value for . - - - - - - - - - - - Method - - System.Threading.Tasks - 4.0.0.0 - 4.0.10.0 - - - mscorlib - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Runtime - 4.2.0.0 - 4.2.1.0 - 4.2.2.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - System.Threading.Tasks.Task<TResult> - - - - - - [System.Runtime.CompilerServices.Nullable(2)] - [<System.Runtime.CompilerServices.Nullable(2)>] - - - - - - - - - [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 1, 1, 2, 1 })] - [<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 1, 1, 2, 1 })>] - - - - - - - [System.Runtime.CompilerServices.Nullable(2)] - [<System.Runtime.CompilerServices.Nullable(2)>] - - - - - - - - - The type of the result produced by the continuation. - A function to run when the completes. When run, the delegate will be passed the completed task and the caller-supplied state object as arguments. - An object representing data to be used by the continuation function. - The that will be assigned to the new continuation task. - Options for when the continuation is scheduled and how it behaves. This includes criteria, such as , as well as execution options, such as . - The to associate with the continuation task and to use for its execution. - Creates a continuation that executes based on the specified task continuation options when the target completes and returns a value. The continuation receives caller-supplied state information and a cancellation token and uses the specified scheduler. - A new continuation . - + The argument is null. + The argument specifies an invalid value for . + + + + + + + + + + + Method + + System.Threading.Tasks + 4.0.0.0 + 4.0.10.0 + + + mscorlib + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Runtime + 4.2.0.0 + 4.2.1.0 + 4.2.2.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + System.Threading.Tasks.Task<TResult> + + + + + + [System.Runtime.CompilerServices.Nullable(2)] + [<System.Runtime.CompilerServices.Nullable(2)>] + + + + + + + + + [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 1, 1, 2, 1 })] + [<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 1, 1, 2, 1 })>] + + + + + + + [System.Runtime.CompilerServices.Nullable(2)] + [<System.Runtime.CompilerServices.Nullable(2)>] + + + + + + + + + The type of the result produced by the continuation. + A function to run when the completes. When run, the delegate will be passed the completed task and the caller-supplied state object as arguments. + An object representing data to be used by the continuation function. + The that will be assigned to the new continuation task. + Options for when the continuation is scheduled and how it behaves. This includes criteria, such as , as well as execution options, such as . + The to associate with the continuation task and to use for its execution. + Creates a continuation that executes based on the specified task continuation options when the target completes and returns a value. The continuation receives caller-supplied state information and a cancellation token and uses the specified scheduler. + A new continuation . + will not be scheduled for execution until the current task has completed. If the criteria specified through the `continuationOptions` parameter are not met, the continuation task will be canceled instead of scheduled. - ]]> - - The argument is . - The argument specifies an invalid value for . - The provided has already been disposed. - - - - - - - - - - Property - - System.Threading.Tasks - 4.0.0.0 - 4.0.10.0 - - - mscorlib - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Runtime - 4.2.0.0 - 4.2.1.0 - 4.2.2.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - System.Threading.Tasks.TaskCreationOptions - - - Gets the used to create this task. - The used to create this task. - To be added. - - - - - - - - - - Property - - System.Threading.Tasks - 4.0.0.0 - 4.0.10.0 - - - mscorlib - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Runtime - 4.2.0.0 - 4.2.1.0 - 4.2.2.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - System.Nullable<System.Int32> - - - Returns the ID of the currently executing . - An integer that was assigned by the system to the currently-executing task. - + ]]> + + The argument is . + The argument specifies an invalid value for . + The provided has already been disposed. + + + + + + + + + + Property + + System.Threading.Tasks + 4.0.0.0 + 4.0.10.0 + + + mscorlib + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Runtime + 4.2.0.0 + 4.2.1.0 + 4.2.2.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + System.Threading.Tasks.TaskCreationOptions + + + Gets the used to create this task. + The used to create this task. + To be added. + + + + + + + + + + Property + + System.Threading.Tasks + 4.0.0.0 + 4.0.10.0 + + + mscorlib + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Runtime + 4.2.0.0 + 4.2.1.0 + 4.2.2.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + System.Nullable<System.Int32> + + + Returns the ID of the currently executing . + An integer that was assigned by the system to the currently-executing task. + - - - - - - - System.Threading.Tasks - 4.0.0.0 - 4.0.10.0 - - - Creates a task that will complete after a time delay. - - - - - - - - - - Method - - System.Threading.Tasks - 4.0.0.0 - 4.0.10.0 - - - mscorlib - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Runtime - 4.2.0.0 - 4.2.1.0 - 4.2.2.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - System.Threading.Tasks.Task - - - - - - The number of milliseconds to wait before completing the returned task, or -1 to wait indefinitely. - Creates a task that completes after a specified number of milliseconds. - A task that represents the time delay. - + ]]> + + + + + + + System.Threading.Tasks + 4.0.0.0 + 4.0.10.0 + + + Creates a task that will complete after a time delay. + + + + + + + + + + Method + + System.Threading.Tasks + 4.0.0.0 + 4.0.10.0 + + + mscorlib + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Runtime + 4.2.0.0 + 4.2.1.0 + 4.2.2.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + System.Threading.Tasks.Task + + + + + + The number of milliseconds to wait before completing the returned task, or -1 to wait indefinitely. + Creates a task that completes after a specified number of milliseconds. + A task that represents the time delay. + - - The argument is less than -1. - - - - - - - - - - Method - - System.Threading.Tasks - 4.0.0.0 - 4.0.10.0 - - - mscorlib - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Runtime - 4.2.0.0 - 4.2.1.0 - 4.2.2.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - System.Threading.Tasks.Task - - - - - - The time span to wait before completing the returned task, or to wait indefinitely. - Creates a task that completes after a specified time interval. - A task that represents the time delay. - + ]]> + + The argument is less than -1. + + + + + + + + + + Method + + System.Threading.Tasks + 4.0.0.0 + 4.0.10.0 + + + mscorlib + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Runtime + 4.2.0.0 + 4.2.1.0 + 4.2.2.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + System.Threading.Tasks.Task + + + + + + The time span to wait before completing the returned task, or to wait indefinitely. + Creates a task that completes after a specified time interval. + A task that represents the time delay. + - - + ]]> + + represents a negative time interval other than . -or- - The argument's property is greater than 4294967294 on .NET 6 and later versions, or Int32.MaxValue on all previous versions. - - - - - - - - - - Method - - System.Threading.Tasks - 4.0.0.0 - 4.0.10.0 - - - mscorlib - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Runtime - 4.2.0.0 - 4.2.1.0 - 4.2.2.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - System.Threading.Tasks.Task - - - - - - - The number of milliseconds to wait before completing the returned task, or -1 to wait indefinitely. - A cancellation token to observe while waiting for the task to complete. - Creates a cancellable task that completes after a specified number of milliseconds. - A task that represents the time delay. - + The argument's property is greater than 4294967294 on .NET 6 and later versions, or Int32.MaxValue on all previous versions. + + + + + + + + + + Method + + System.Threading.Tasks + 4.0.0.0 + 4.0.10.0 + + + mscorlib + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Runtime + 4.2.0.0 + 4.2.1.0 + 4.2.2.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + System.Threading.Tasks.Task + + + + + + + The number of milliseconds to wait before completing the returned task, or -1 to wait indefinitely. + A cancellation token to observe while waiting for the task to complete. + Creates a cancellable task that completes after a specified number of milliseconds. + A task that represents the time delay. + [!NOTE] > The system clock that is used is the same clock used by [GetTickCount](/windows/win32/api/sysinfoapi/nf-sysinfoapi-gettickcount), which is not affected by changes made with [timeBeginPeriod](/windows/win32/api/timeapi/nf-timeapi-timebeginperiod) and [timeEndPeriod](/windows/win32/api/timeapi/nf-timeapi-timeendperiod). - - ## Examples The following example launches a task that includes a call to the method with a one second delay. Before the delay interval elapses, the token is cancelled. The output from the example shows that, as a result, a is thrown, and the tasks' property is set to . @@ -2828,59 +2823,59 @@ End Sub :::code language="fsharp" source="~/snippets/fsharp/System.Threading.Tasks/Task/Delay/delay3.fs" id="Snippet3"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.threading.tasks.task.delay/vb/delay3.vb" id="Snippet3"::: - ]]> - - The argument is less than -1. - The task has been canceled. - The provided has already been disposed. - - - - - - - - - - Method - - System.Threading.Tasks - 4.0.0.0 - 4.0.10.0 - - - mscorlib - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Runtime - 4.2.0.0 - 4.2.1.0 - 4.2.2.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - System.Threading.Tasks.Task - - - - - - - The time span to wait before completing the returned task, or to wait indefinitely. - A cancellation token to observe while waiting for the task to complete. - Creates a cancellable task that completes after a specified time interval. - A task that represents the time delay. - + ]]> + + The argument is less than -1. + The task has been canceled. + The provided has already been disposed. + + + + + + + + + + Method + + System.Threading.Tasks + 4.0.0.0 + 4.0.10.0 + + + mscorlib + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Runtime + 4.2.0.0 + 4.2.1.0 + 4.2.2.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + System.Threading.Tasks.Task + + + + + + + The time span to wait before completing the returned task, or to wait indefinitely. + A cancellation token to observe while waiting for the task to complete. + Creates a cancellable task that completes after a specified time interval. + A task that represents the time delay. + - - + ]]> + + represents a negative time interval other than . -or- - The argument's property is greater than 4294967294 on .NET 6 and later versions, or Int32.MaxValue on all previous versions. - The task has been canceled. - The provided has already been disposed. - - - - - - - - - - Method - - System.Runtime - 8.0.0.0 - - - System.Threading.Tasks - - - mscorlib - - - netstandard - - - System.Threading.Tasks.Task - - - - - - - The to wait before completing the returned task, or to wait indefinitely. - The with which to interpret . - Creates a task that completes after a specified time interval. - A task that represents the time delay. - To be added. - - - represents a negative time interval other than . - -or- - - 's property is greater than 4294967294. - - The argument is . - - - - - - - - - - Method - - System.Runtime - 8.0.0.0 - - - System.Threading.Tasks - - - mscorlib - - - netstandard - - - System.Threading.Tasks.Task - - - - - - - - The to wait before completing the returned task, or to wait indefinitely. - The with which to interpret . - A cancellation token to observe while waiting for the task to complete. - Creates a cancellable task that completes after a specified time interval. - A task that represents the time delay. - To be added. - - - represents a negative time interval other than . - -or- - - 's property is greater than 4294967294. - - The argument is . - - - - - mscorlib - 2.0.5.0 - 4.0.0.0 - - - Releases all resources used by the current instance of the class. - - - - - - - - - - Method - - M:System.IDisposable.Dispose - - - mscorlib - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Runtime - 4.2.0.0 - 4.2.1.0 - 4.2.2.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - System.Threading.Tasks - - - System.Void - - - - Releases all resources used by the current instance of the class. - + The argument's property is greater than 4294967294 on .NET 6 and later versions, or Int32.MaxValue on all previous versions. + The task has been canceled. + The provided has already been disposed. + + + + + + + + + + Method + + System.Runtime + 8.0.0.0 + + + System.Threading.Tasks + + + mscorlib + + + netstandard + + + System.Threading.Tasks.Task + + + + + + + The to wait before completing the returned task, or to wait indefinitely. + The with which to interpret . + Creates a task that completes after a specified time interval. + A task that represents the time delay. + To be added. + + + represents a negative time interval other than . + -or- + + 's property is greater than 4294967294. + + The argument is . + + + + + + + + + + Method + + System.Runtime + 8.0.0.0 + + + System.Threading.Tasks + + + mscorlib + + + netstandard + + + System.Threading.Tasks.Task + + + + + + + + The to wait before completing the returned task, or to wait indefinitely. + The with which to interpret . + A cancellation token to observe while waiting for the task to complete. + Creates a cancellable task that completes after a specified time interval. + A task that represents the time delay. + To be added. + + + represents a negative time interval other than . + -or- + + 's property is greater than 4294967294. + + The argument is . + The cancellation token was canceled. This exception is stored into the returned task. + + + + + mscorlib + 2.0.5.0 + 4.0.0.0 + + + Releases all resources used by the current instance of the class. + + + + + + + + + + Method + + M:System.IDisposable.Dispose + + + mscorlib + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Runtime + 4.2.0.0 + 4.2.1.0 + 4.2.2.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + System.Threading.Tasks + + + System.Void + + + + Releases all resources used by the current instance of the class. + class implements the interface because internally it uses resources that also implement . However, particularly if your app targets the .NET Framework 4.5 or later, there is no need to call unless performance or scalability testing indicates that, based on your usage patterns, your app's performance would be improved by disposing of tasks. For more information, see [Do I need to dispose of Tasks?](https://devblogs.microsoft.com/pfxteam/do-i-need-to-dispose-of-tasks/) in the Parallel Programming with .NET blog. - ]]> - - The task is not in one of the final states: , , or . - - - - - - - - - - Method - - mscorlib - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Runtime - 4.2.0.0 - 4.2.1.0 - 4.2.2.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - System.Threading.Tasks - - - System.Void - - - - - - A Boolean value that indicates whether this method is being called due to a call to . - Disposes the , releasing all of its unmanaged resources. - + ]]> + + The task is not in one of the final states: , , or . + + + + + + + + + + Method + + mscorlib + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Runtime + 4.2.0.0 + 4.2.1.0 + 4.2.2.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + System.Threading.Tasks + + + System.Void + + + + + + A Boolean value that indicates whether this method is being called due to a call to . + Disposes the , releasing all of its unmanaged resources. + class implements the interface because internally it uses resources that also implement . However, particularly if your app targets the .NET Framework 4.5 or later, there is no need to call unless performance or scalability testing indicates that, based on your usage patterns, your app's performance would be improved by disposing of tasks. For more information, see [Do I need to dispose of Tasks?](https://devblogs.microsoft.com/pfxteam/do-i-need-to-dispose-of-tasks/) in the Parallel Programming with .NET blog. - ]]> - - The task is not in one of the final states: , , or . - Unlike most of the members of the class, this method is not thread-safe. - - - - - - - - - - - Property - - System.Threading.Tasks - 4.0.0.0 - 4.0.10.0 - - - mscorlib - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Runtime - 4.2.0.0 - 4.2.1.0 - 4.2.2.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - - [System.Runtime.CompilerServices.Nullable(2)] - [<System.Runtime.CompilerServices.Nullable(2)>] - - - [get: System.Runtime.CompilerServices.NullableContext(2)] - [<get: System.Runtime.CompilerServices.NullableContext(2)>] - - - - System.AggregateException - - - Gets the that caused the to end prematurely. If the completed successfully or has not yet thrown any exceptions, this will return . - The that caused the to end prematurely. - + ]]> + + The task is not in one of the final states: , , or . + Unlike most of the members of the class, this method is not thread-safe. + + + + + + + + + + + Property + + System.Threading.Tasks + 4.0.0.0 + 4.0.10.0 + + + mscorlib + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Runtime + 4.2.0.0 + 4.2.1.0 + 4.2.2.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + + [System.Runtime.CompilerServices.Nullable(2)] + [<System.Runtime.CompilerServices.Nullable(2)>] + + + [get: System.Runtime.CompilerServices.NullableContext(2)] + [<get: System.Runtime.CompilerServices.NullableContext(2)>] + + + + System.AggregateException + + + Gets the that caused the to end prematurely. If the completed successfully or has not yet thrown any exceptions, this will return . + The that caused the to end prematurely. + in calls to or in accesses to the property. On .NET Framework 4.0, any exceptions not observed by the time the task instance is garbage collected will be propagated on the finalizer thread, which crashes the process. On .NET Framework 4.5 and later the default behavior changed so unobserved exceptions are not rethrown from the Finalizer. .NET Core does not rethrow the exception on the Finalizer. For more information and an example, see [Exception Handling (Task Parallel Library)](/dotnet/standard/parallel-programming/exception-handling-task-parallel-library). - ]]> - - - - - - - - - - - Property - - System.Threading.Tasks - 4.0.0.0 - 4.0.10.0 - - - mscorlib - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Runtime - 4.2.0.0 - 4.2.1.0 - 4.2.2.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - System.Threading.Tasks.TaskFactory - - - Provides access to factory methods for creating and configuring and instances. - A factory object that can create a variety of and objects. - + ]]> + + + + + + + + + + + Property + + System.Threading.Tasks + 4.0.0.0 + 4.0.10.0 + + + mscorlib + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Runtime + 4.2.0.0 + 4.2.1.0 + 4.2.2.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + System.Threading.Tasks.TaskFactory + + + Provides access to factory methods for creating and configuring and instances. + A factory object that can create a variety of and objects. + - - - - - - - - - - - - Method - - System.Threading.Tasks - 4.0.10.0 - - - mscorlib - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Runtime - 4.2.0.0 - 4.2.1.0 - 4.2.2.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - System.Threading.Tasks.Task - - - - - - The cancellation token with which to complete the task. - Creates a that's completed due to cancellation with a specified cancellation token. - The canceled task. - To be added. - Cancellation has not been requested for ; its property is . - - - - - - - - - - Method - - System.Threading.Tasks - 4.0.10.0 - - - mscorlib - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Runtime - 4.2.0.0 - 4.2.1.0 - 4.2.2.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - System.Threading.Tasks.Task<TResult> - - - - - - [System.Runtime.CompilerServices.Nullable(2)] - [<System.Runtime.CompilerServices.Nullable(2)>] - - - - - - - - - The type of the result returned by the task. - The cancellation token with which to complete the task. - Creates a that's completed due to cancellation with a specified cancellation token. - The canceled task. - To be added. - Cancellation has not been requested for ; its property is . - - - - - - - - - - Method - - System.Threading.Tasks - 4.0.10.0 - - - mscorlib - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Runtime - 4.2.0.0 - 4.2.1.0 - 4.2.2.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - System.Threading.Tasks.Task - - - - - - The exception with which to complete the task. - Creates a that has completed with a specified exception. - The faulted task. - + ]]> + + + + + + + + + + + + Method + + System.Threading.Tasks + 4.0.10.0 + + + mscorlib + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Runtime + 4.2.0.0 + 4.2.1.0 + 4.2.2.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + System.Threading.Tasks.Task + + + + + + The cancellation token with which to complete the task. + Creates a that's completed due to cancellation with a specified cancellation token. + The canceled task. + To be added. + Cancellation has not been requested for ; its property is . + + + + + + + + + + Method + + System.Threading.Tasks + 4.0.10.0 + + + mscorlib + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Runtime + 4.2.0.0 + 4.2.1.0 + 4.2.2.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + System.Threading.Tasks.Task<TResult> + + + + + + [System.Runtime.CompilerServices.Nullable(2)] + [<System.Runtime.CompilerServices.Nullable(2)>] + + + + + + + + + The type of the result returned by the task. + The cancellation token with which to complete the task. + Creates a that's completed due to cancellation with a specified cancellation token. + The canceled task. + To be added. + Cancellation has not been requested for ; its property is . + + + + + + + + + + Method + + System.Threading.Tasks + 4.0.10.0 + + + mscorlib + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Runtime + 4.2.0.0 + 4.2.1.0 + 4.2.2.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + System.Threading.Tasks.Task + + + + + + The exception with which to complete the task. + Creates a that has completed with a specified exception. + The faulted task. + object whose property is and whose property contains `exception`. The method is commonly used when you immediately know that the work that a task performs will throw an exception before executing a longer code path. For an example, see the overload. - ]]> - - - - - - - - - - - Method - - System.Threading.Tasks - 4.0.10.0 - - - mscorlib - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Runtime - 4.2.0.0 - 4.2.1.0 - 4.2.2.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - System.Threading.Tasks.Task<TResult> - - - - - - [System.Runtime.CompilerServices.Nullable(2)] - [<System.Runtime.CompilerServices.Nullable(2)>] - - - - - - - - - The type of the result returned by the task. - The exception with which to complete the task. - Creates a that's completed with a specified exception. - The faulted task. - + ]]> + + + + + + + + + + + Method + + System.Threading.Tasks + 4.0.10.0 + + + mscorlib + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Runtime + 4.2.0.0 + 4.2.1.0 + 4.2.2.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + System.Threading.Tasks.Task<TResult> + + + + + + [System.Runtime.CompilerServices.Nullable(2)] + [<System.Runtime.CompilerServices.Nullable(2)>] + + + + + + + + + The type of the result returned by the task. + The exception with which to complete the task. + Creates a that's completed with a specified exception. + The faulted task. + - - - - - - - - - - - Method - - System.Threading.Tasks - 4.0.0.0 - 4.0.10.0 - - - mscorlib - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Runtime - 4.2.0.0 - 4.2.1.0 - 4.2.2.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - System.Threading.Tasks.Task<TResult> - - - - - - [System.Runtime.CompilerServices.Nullable(2)] - [<System.Runtime.CompilerServices.Nullable(2)>] - - - - - - - - - The type of the result returned by the task. - The result to store into the completed task. - Creates a that's completed successfully with the specified result. - The successfully completed task. - + ]]> + + + + + + + + + + + Method + + System.Threading.Tasks + 4.0.0.0 + 4.0.10.0 + + + mscorlib + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Runtime + 4.2.0.0 + 4.2.1.0 + 4.2.2.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + System.Threading.Tasks.Task<TResult> + + + + + + [System.Runtime.CompilerServices.Nullable(2)] + [<System.Runtime.CompilerServices.Nullable(2)>] + + + + + + + + + The type of the result returned by the task. + The result to store into the completed task. + Creates a that's completed successfully with the specified result. + The successfully completed task. + - - - - - - - - - - - - Method - - System.Threading.Tasks - 4.0.0.0 - 4.0.10.0 - - - mscorlib - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Runtime - 4.2.0.0 - 4.2.1.0 - 4.2.2.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - - [System.Runtime.TargetedPatchingOptOut("Performance critical to inline across NGen image boundaries")] - [<System.Runtime.TargetedPatchingOptOut("Performance critical to inline across NGen image boundaries")>] - - - - System.Runtime.CompilerServices.TaskAwaiter - - - - Gets an awaiter used to await this . - An awaiter instance. - + ]]> + + + + + + + + + + + + Method + + System.Threading.Tasks + 4.0.0.0 + 4.0.10.0 + + + mscorlib + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Runtime + 4.2.0.0 + 4.2.1.0 + 4.2.2.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + + [System.Runtime.TargetedPatchingOptOut("Performance critical to inline across NGen image boundaries")] + [<System.Runtime.TargetedPatchingOptOut("Performance critical to inline across NGen image boundaries")>] + + + + System.Runtime.CompilerServices.TaskAwaiter + + + + Gets an awaiter used to await this . + An awaiter instance. + - - - - - - - - - - - Property - - System.Threading.Tasks - 4.0.0.0 - 4.0.10.0 - - - mscorlib - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Runtime - 4.2.0.0 - 4.2.1.0 - 4.2.2.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - System.Int32 - - - Gets an ID for this instance. - The identifier that is assigned by the system to this instance. - + ]]> + + + + + + + + + + + Property + + System.Threading.Tasks + 4.0.0.0 + 4.0.10.0 + + + mscorlib + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Runtime + 4.2.0.0 + 4.2.1.0 + 4.2.2.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + System.Int32 + + + Gets an ID for this instance. + The identifier that is assigned by the system to this instance. + property. - ]]> - - - - - - - - - - - - Property - - System.Threading.Tasks - 4.0.0.0 - 4.0.10.0 - - - mscorlib - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Runtime - 4.2.0.0 - 4.2.1.0 - 4.2.2.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - System.Boolean - - - Gets whether this instance has completed execution due to being canceled. - - if the task has completed due to being canceled; otherwise . - + ]]> + + + + + + + + + + + + Property + + System.Threading.Tasks + 4.0.0.0 + 4.0.10.0 + + + mscorlib + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Runtime + 4.2.0.0 + 4.2.1.0 + 4.2.2.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + System.Boolean + + + Gets whether this instance has completed execution due to being canceled. + + if the task has completed due to being canceled; otherwise . + [!IMPORTANT] > Retrieving the value of the property does not block the calling thread until the task has completed. - ]]> - - - - - - - - - - - Property - - P:System.IAsyncResult.IsCompleted - - - System.Threading.Tasks - 4.0.0.0 - 4.0.10.0 - - - mscorlib - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Runtime - 4.2.0.0 - 4.2.1.0 - 4.2.2.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - - [get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline across NGen image boundaries")] - [<get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline across NGen image boundaries")>] - - - - System.Boolean - - - Gets a value that indicates whether the task has completed. - - if the task has completed (that is, the task is in one of the three final states: , , or ); otherwise, . - + ]]> + + + + + + + + + + + Property + + P:System.IAsyncResult.IsCompleted + + + System.Threading.Tasks + 4.0.0.0 + 4.0.10.0 + + + mscorlib + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Runtime + 4.2.0.0 + 4.2.1.0 + 4.2.2.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + + [get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline across NGen image boundaries")] + [<get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline across NGen image boundaries")>] + + + + System.Boolean + + + Gets a value that indicates whether the task has completed. + + if the task has completed (that is, the task is in one of the three final states: , , or ); otherwise, . + [!IMPORTANT] > Retrieving the value of the property does not block the calling thread until the task has completed. - ]]> - - - - - - - - - - - Property - - System.Runtime - 4.2.0.0 - 4.2.1.0 - 4.2.2.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - mscorlib - - - netstandard - 2.1.0.0 - - - System.Threading.Tasks - - - System.Boolean - - - Gets whether the task ran to completion. - - if the task ran to completion; otherwise . - To be added. - - - - - - - - - - Property - - System.Threading.Tasks - 4.0.0.0 - 4.0.10.0 - - - mscorlib - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Runtime - 4.2.0.0 - 4.2.1.0 - 4.2.2.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - - [System.Diagnostics.CodeAnalysis.MemberNotNullWhen(true, "Exception")] - [<System.Diagnostics.CodeAnalysis.MemberNotNullWhen(true, "Exception")>] - - - [get: System.Diagnostics.CodeAnalysis.MemberNotNullWhen(true, "Exception")] - [<get: System.Diagnostics.CodeAnalysis.MemberNotNullWhen(true, "Exception")>] - - - - System.Boolean - - - Gets whether the completed due to an unhandled exception. - - if the task has thrown an unhandled exception; otherwise . - + ]]> + + + + + + + + + + + Property + + System.Runtime + 4.2.0.0 + 4.2.1.0 + 4.2.2.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + mscorlib + + + netstandard + 2.1.0.0 + + + System.Threading.Tasks + + + System.Boolean + + + Gets whether the task ran to completion. + + if the task ran to completion; otherwise . + To be added. + + + + + + + + + + Property + + System.Threading.Tasks + 4.0.0.0 + 4.0.10.0 + + + mscorlib + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Runtime + 4.2.0.0 + 4.2.1.0 + 4.2.2.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + + [System.Diagnostics.CodeAnalysis.MemberNotNullWhen(true, "Exception")] + [<System.Diagnostics.CodeAnalysis.MemberNotNullWhen(true, "Exception")>] + + + [get: System.Diagnostics.CodeAnalysis.MemberNotNullWhen(true, "Exception")] + [<get: System.Diagnostics.CodeAnalysis.MemberNotNullWhen(true, "Exception")>] + + + + System.Boolean + + + Gets whether the completed due to an unhandled exception. + + if the task has thrown an unhandled exception; otherwise . + [!IMPORTANT] > Retrieving the value of the property does not block the calling thread until the task has completed. - ]]> - - - - - - System.Threading.Tasks - 4.0.0.0 - 4.0.10.0 - - - Queues the specified work to run on the ThreadPool and returns a task or handle for that work. - + ]]> + + + + + + System.Threading.Tasks + 4.0.0.0 + 4.0.10.0 + + + Queues the specified work to run on the ThreadPool and returns a task or handle for that work. + method provides a set of overloads that make it easy to start a task by using default values. It is a lightweight alternative to the overloads. - ]]> - - - - - - - - - - - Method - - System.Threading.Tasks - 4.0.0.0 - 4.0.10.0 - - - mscorlib - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Runtime - 4.2.0.0 - 4.2.1.0 - 4.2.2.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - System.Threading.Tasks.Task - - - - - - The work to execute asynchronously. - Queues the specified work to run on the thread pool and returns a object that represents that work. - A task that represents the work queued to execute in the ThreadPool. - + ]]> + + + + + + + + + + + Method + + System.Threading.Tasks + 4.0.0.0 + 4.0.10.0 + + + mscorlib + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Runtime + 4.2.0.0 + 4.2.1.0 + 4.2.2.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + System.Threading.Tasks.Task + + + + + + The work to execute asynchronously. + Queues the specified work to run on the thread pool and returns a object that represents that work. + A task that represents the work queued to execute in the ThreadPool. + - - The parameter was . - Exception Handling (Task Parallel Library) - - - - - - - - - - - Method - - System.Threading.Tasks - 4.0.0.0 - 4.0.10.0 - - - mscorlib - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Runtime - 4.2.0.0 - 4.2.1.0 - 4.2.2.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - System.Threading.Tasks.Task - - - - - - [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 1, 2 })] - [<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 1, 2 })>] - - - - - - The work to execute asynchronously. - Queues the specified work to run on the thread pool and returns a proxy for the task returned by . - A task that represents a proxy for the task returned by . - + ]]> + + The parameter was . + Exception Handling (Task Parallel Library) + + + + + + + + + + + Method + + System.Threading.Tasks + 4.0.0.0 + 4.0.10.0 + + + mscorlib + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Runtime + 4.2.0.0 + 4.2.1.0 + 4.2.2.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + System.Threading.Tasks.Task + + + + + + [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 1, 2 })] + [<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 1, 2 })>] + + + + + + The work to execute asynchronously. + Queues the specified work to run on the thread pool and returns a proxy for the task returned by . + A task that represents a proxy for the task returned by . + - - The parameter was . - Exception Handling (Task Parallel Library) - - - - - - - - - - Method - - System.Threading.Tasks - 4.0.0.0 - 4.0.10.0 - - - mscorlib - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Runtime - 4.2.0.0 - 4.2.1.0 - 4.2.2.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - System.Threading.Tasks.Task - - - - - - - The work to execute asynchronously. - A cancellation token that can be used to cancel the work if it has not yet started. does not pass to . - Queues the specified work to run on the thread pool and returns a object that represents that work. A cancellation token allows the work to be cancelled if it has not yet started. - A task that represents the work queued to execute in the thread pool. - + ]]> + + The parameter was . + Exception Handling (Task Parallel Library) + + + + + + + + + + Method + + System.Threading.Tasks + 4.0.0.0 + 4.0.10.0 + + + mscorlib + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Runtime + 4.2.0.0 + 4.2.1.0 + 4.2.2.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + System.Threading.Tasks.Task + + + + + + + The work to execute asynchronously. + A cancellation token that can be used to cancel the work if it has not yet started. does not pass to . + Queues the specified work to run on the thread pool and returns a object that represents that work. A cancellation token allows the work to be cancelled if it has not yet started. + A task that represents the work queued to execute in the thread pool. + - - The parameter was . - The task has been canceled. - The associated with was disposed. - Exception Handling (Task Parallel Library) - - - - - - - - - - - Method - - System.Threading.Tasks - 4.0.0.0 - 4.0.10.0 - - - mscorlib - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Runtime - 4.2.0.0 - 4.2.1.0 - 4.2.2.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - System.Threading.Tasks.Task - - - - - - [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 1, 2 })] - [<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 1, 2 })>] - - - - - - - The work to execute asynchronously. - A cancellation token that can be used to cancel the work if it has not yet started. does not pass to . - Queues the specified work to run on the thread pool and returns a proxy for the task returned by . A cancellation token allows the work to be cancelled if it has not yet started. - A task that represents a proxy for the task returned by . - + ]]> + + The parameter was . + The task has been canceled. + The associated with was disposed. + Exception Handling (Task Parallel Library) + + + + + + + + + + + Method + + System.Threading.Tasks + 4.0.0.0 + 4.0.10.0 + + + mscorlib + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Runtime + 4.2.0.0 + 4.2.1.0 + 4.2.2.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + System.Threading.Tasks.Task + + + + + + [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 1, 2 })] + [<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 1, 2 })>] + + + + + + + The work to execute asynchronously. + A cancellation token that can be used to cancel the work if it has not yet started. does not pass to . + Queues the specified work to run on the thread pool and returns a proxy for the task returned by . A cancellation token allows the work to be cancelled if it has not yet started. + A task that represents a proxy for the task returned by . + - - The parameter was . - The task has been canceled. - The associated with was disposed. - Task Cancellation - Exception Handling (Task Parallel Library) - - - - - - - - - - - Method - - System.Threading.Tasks - 4.0.0.0 - 4.0.10.0 - - - mscorlib - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Runtime - 4.2.0.0 - 4.2.1.0 - 4.2.2.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - System.Threading.Tasks.Task<TResult> - - - - - - [System.Runtime.CompilerServices.Nullable(2)] - [<System.Runtime.CompilerServices.Nullable(2)>] - - - - - - - - - [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 1, 2, 1 })] - [<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 1, 2, 1 })>] - - - - - - The type of the result returned by the proxy task. - The work to execute asynchronously. - Queues the specified work to run on the thread pool and returns a proxy for the returned by . A cancellation token allows the work to be cancelled if it has not yet started. - A that represents a proxy for the returned by . - + ]]> + + The parameter was . + The task has been canceled. + The associated with was disposed. + Task Cancellation + Exception Handling (Task Parallel Library) + + + + + + + + + + + Method + + System.Threading.Tasks + 4.0.0.0 + 4.0.10.0 + + + mscorlib + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Runtime + 4.2.0.0 + 4.2.1.0 + 4.2.2.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + System.Threading.Tasks.Task<TResult> + + + + + + [System.Runtime.CompilerServices.Nullable(2)] + [<System.Runtime.CompilerServices.Nullable(2)>] + + + + + + + + + [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 1, 2, 1 })] + [<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 1, 2, 1 })>] + + + + + + The type of the result returned by the proxy task. + The work to execute asynchronously. + Queues the specified work to run on the thread pool and returns a proxy for the returned by . A cancellation token allows the work to be cancelled if it has not yet started. + A that represents a proxy for the returned by . + - - The parameter was . - Exception Handling (Task Parallel Library) - - - - - - - - - - Method - - System.Threading.Tasks - 4.0.0.0 - 4.0.10.0 - - - mscorlib - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Runtime - 4.2.0.0 - 4.2.1.0 - 4.2.2.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - System.Threading.Tasks.Task<TResult> - - - - - - [System.Runtime.CompilerServices.Nullable(2)] - [<System.Runtime.CompilerServices.Nullable(2)>] - - - - - - - - - The return type of the task. - The work to execute asynchronously. - Queues the specified work to run on the thread pool and returns a object that represents that work. A cancellation token allows the work to be cancelled if it has not yet started. - A task object that represents the work queued to execute in the thread pool. - + ]]> + + The parameter was . + Exception Handling (Task Parallel Library) + + + + + + + + + + Method + + System.Threading.Tasks + 4.0.0.0 + 4.0.10.0 + + + mscorlib + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Runtime + 4.2.0.0 + 4.2.1.0 + 4.2.2.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + System.Threading.Tasks.Task<TResult> + + + + + + [System.Runtime.CompilerServices.Nullable(2)] + [<System.Runtime.CompilerServices.Nullable(2)>] + + + + + + + + + The return type of the task. + The work to execute asynchronously. + Queues the specified work to run on the thread pool and returns a object that represents that work. A cancellation token allows the work to be cancelled if it has not yet started. + A task object that represents the work queued to execute in the thread pool. + - - The parameter is . - Exception Handling (Task Parallel Library) - - - - - - - - - - - Method - - System.Threading.Tasks - 4.0.0.0 - 4.0.10.0 - - - mscorlib - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Runtime - 4.2.0.0 - 4.2.1.0 - 4.2.2.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - System.Threading.Tasks.Task<TResult> - - - - - - [System.Runtime.CompilerServices.Nullable(2)] - [<System.Runtime.CompilerServices.Nullable(2)>] - - - - - - - - - [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 1, 2, 1 })] - [<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 1, 2, 1 })>] - - - - - - - The type of the result returned by the proxy task. - The work to execute asynchronously. - A cancellation token that can be used to cancel the work if it has not yet started. does not pass to . - Queues the specified work to run on the thread pool and returns a proxy for the returned by . - A that represents a proxy for the returned by . - + ]]> + + The parameter is . + Exception Handling (Task Parallel Library) + + + + + + + + + + + Method + + System.Threading.Tasks + 4.0.0.0 + 4.0.10.0 + + + mscorlib + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Runtime + 4.2.0.0 + 4.2.1.0 + 4.2.2.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + System.Threading.Tasks.Task<TResult> + + + + + + [System.Runtime.CompilerServices.Nullable(2)] + [<System.Runtime.CompilerServices.Nullable(2)>] + + + + + + + + + [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 1, 2, 1 })] + [<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 1, 2, 1 })>] + + + + + + + The type of the result returned by the proxy task. + The work to execute asynchronously. + A cancellation token that can be used to cancel the work if it has not yet started. does not pass to . + Queues the specified work to run on the thread pool and returns a proxy for the returned by . + A that represents a proxy for the returned by . + - - The parameter was . - The task has been canceled. - The associated with was disposed. - Task Cancellation - Exception Handling (Task Parallel Library) - - - - - - - - - - Method - - System.Threading.Tasks - 4.0.0.0 - 4.0.10.0 - - - mscorlib - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Runtime - 4.2.0.0 - 4.2.1.0 - 4.2.2.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - System.Threading.Tasks.Task<TResult> - - - - - - [System.Runtime.CompilerServices.Nullable(2)] - [<System.Runtime.CompilerServices.Nullable(2)>] - - - - - - - - - - The result type of the task. - The work to execute asynchronously. - A cancellation token that can be used to cancel the work if it has not yet started. does not pass to . - Queues the specified work to run on the thread pool and returns a object that represents that work. - A that represents the work queued to execute in the thread pool. - + ]]> + + The parameter was . + The task has been canceled. + The associated with was disposed. + Task Cancellation + Exception Handling (Task Parallel Library) + + + + + + + + + + Method + + System.Threading.Tasks + 4.0.0.0 + 4.0.10.0 + + + mscorlib + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Runtime + 4.2.0.0 + 4.2.1.0 + 4.2.2.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + System.Threading.Tasks.Task<TResult> + + + + + + [System.Runtime.CompilerServices.Nullable(2)] + [<System.Runtime.CompilerServices.Nullable(2)>] + + + + + + + + + + The result type of the task. + The work to execute asynchronously. + A cancellation token that can be used to cancel the work if it has not yet started. does not pass to . + Queues the specified work to run on the thread pool and returns a object that represents that work. + A that represents the work queued to execute in the thread pool. + exception, since any tasks that have not started when cancellation is requested still throw an exception. - ]]> - - The parameter is . - The task has been canceled. - The associated with was disposed. - Task Cancellation - Exception Handling (Task Parallel Library) - - - - - System.Threading.Tasks - 4.0.0.0 - 4.0.10.0 - - - Runs the synchronously on the current . - - - - - - - - - - Method - - System.Threading.Tasks - 4.0.0.0 - 4.0.10.0 - - - mscorlib - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Runtime - 4.2.0.0 - 4.2.1.0 - 4.2.2.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - System.Void - - - - Runs the synchronously on the current . - + ]]> + + The parameter is . + The task has been canceled. + The associated with was disposed. + Task Cancellation + Exception Handling (Task Parallel Library) + + + + + System.Threading.Tasks + 4.0.0.0 + 4.0.10.0 + + + Runs the synchronously on the current . + + + + + + + + + + Method + + System.Threading.Tasks + 4.0.0.0 + 4.0.10.0 + + + mscorlib + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Runtime + 4.2.0.0 + 4.2.1.0 + 4.2.2.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + System.Void + + + + Runs the synchronously on the current . + - - The instance has been disposed. - The is not in a valid state to be started. It may have already been started, executed, or canceled, or it may have been created in a manner that doesn't support direct scheduling. - Exception Handling (Task Parallel Library) - - - - - - - - - - Method - - System.Threading.Tasks - 4.0.0.0 - 4.0.10.0 - - - mscorlib - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Runtime - 4.2.0.0 - 4.2.1.0 - 4.2.2.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - System.Void - - - - - - The scheduler on which to attempt to run this task inline. - Runs the synchronously on the provided. - + ]]> + + The instance has been disposed. + The is not in a valid state to be started. It may have already been started, executed, or canceled, or it may have been created in a manner that doesn't support direct scheduling. + Exception Handling (Task Parallel Library) + + + + + + + + + + Method + + System.Threading.Tasks + 4.0.0.0 + 4.0.10.0 + + + mscorlib + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Runtime + 4.2.0.0 + 4.2.1.0 + 4.2.2.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + System.Void + + + + + + The scheduler on which to attempt to run this task inline. + Runs the synchronously on the provided. + to ensure that the task has completed execution. For more information on exception handling for task operations, see [Exception Handling](/dotnet/standard/parallel-programming/exception-handling-task-parallel-library). - ]]> - - The instance has been disposed. - The argument is . - The is not in a valid state to be started. It may have already been started, executed, or canceled, or it may have been created in a manner that doesn't support direct scheduling. - - Exception Handling (Task Parallel Library) - - - - - System.Threading.Tasks - 4.0.0.0 - 4.0.10.0 - - - Starts the . - - - - - - - - - - Method - - System.Threading.Tasks - 4.0.0.0 - 4.0.10.0 - - - mscorlib - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Runtime - 4.2.0.0 - 4.2.1.0 - 4.2.2.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - System.Void - - - - Starts the , scheduling it for execution to the current . - + ]]> + + The instance has been disposed. + The argument is . + The is not in a valid state to be started. It may have already been started, executed, or canceled, or it may have been created in a manner that doesn't support direct scheduling. + + Exception Handling (Task Parallel Library) + + + + + System.Threading.Tasks + 4.0.0.0 + 4.0.10.0 + + + Starts the . + + + + + + + + + + Method + + System.Threading.Tasks + 4.0.0.0 + 4.0.10.0 + + + mscorlib + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Runtime + 4.2.0.0 + 4.2.1.0 + 4.2.2.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + System.Void + + + + Starts the , scheduling it for execution to the current . + - - The instance has been disposed. - The is not in a valid state to be started. It may have already been started, executed, or canceled, or it may have been created in a manner that doesn't support direct scheduling. - Exception Handling (Task Parallel Library) - - - - - - - - - - Method - - System.Threading.Tasks - 4.0.0.0 - 4.0.10.0 - - - mscorlib - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Runtime - 4.2.0.0 - 4.2.1.0 - 4.2.2.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - System.Void - - - - - - The with which to associate and execute this task. - Starts the , scheduling it for execution to the specified . - + ]]> + + The instance has been disposed. + The is not in a valid state to be started. It may have already been started, executed, or canceled, or it may have been created in a manner that doesn't support direct scheduling. + Exception Handling (Task Parallel Library) + + + + + + + + + + Method + + System.Threading.Tasks + 4.0.0.0 + 4.0.10.0 + + + mscorlib + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Runtime + 4.2.0.0 + 4.2.1.0 + 4.2.2.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + System.Void + + + + + + The with which to associate and execute this task. + Starts the , scheduling it for execution to the specified . + - - The argument is . - The is not in a valid state to be started. It may have already been started, executed, or canceled, or it may have been created in a manner that doesn't support direct scheduling. - The instance has been disposed. - The scheduler was unable to queue this task. - Exception Handling (Task Parallel Library) - - - - - - - - - - Property - - System.Threading.Tasks - 4.0.0.0 - 4.0.10.0 - - - mscorlib - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Runtime - 4.2.0.0 - 4.2.1.0 - 4.2.2.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - System.Threading.Tasks.TaskStatus - - - Gets the of this task. - The current of this task instance. - + ]]> + + The argument is . + The is not in a valid state to be started. It may have already been started, executed, or canceled, or it may have been created in a manner that doesn't support direct scheduling. + The instance has been disposed. + The scheduler was unable to queue this task. + Exception Handling (Task Parallel Library) + + + + + + + + + + Property + + System.Threading.Tasks + 4.0.0.0 + 4.0.10.0 + + + mscorlib + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Runtime + 4.2.0.0 + 4.2.1.0 + 4.2.2.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + System.Threading.Tasks.TaskStatus + + + Gets the of this task. + The current of this task instance. + - - - - - - - - - - - Property - - P:System.IAsyncResult.AsyncWaitHandle - - - System.Threading.Tasks - 4.0.0.0 - 4.0.10.0 - - - mscorlib - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Runtime - 4.2.0.0 - 4.2.1.0 - 4.2.2.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - System.Threading.WaitHandle - - - Gets a that can be used to wait for the task to complete. - A that can be used to wait for the task to complete. - + ]]> + + + + + + + + + + + Property + + P:System.IAsyncResult.AsyncWaitHandle + + + System.Threading.Tasks + 4.0.0.0 + 4.0.10.0 + + + mscorlib + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Runtime + 4.2.0.0 + 4.2.1.0 + 4.2.2.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + System.Threading.WaitHandle + + + Gets a that can be used to wait for the task to complete. + A that can be used to wait for the task to complete. + is preferable to using for similar functionality. For more information, see the "Waiting on Tasks" section in [Task-based Asynchronous Programming](/dotnet/standard/parallel-programming/task-based-asynchronous-programming) and [Using TPL with Other Asynchronous Patterns](/dotnet/standard/parallel-programming/using-tpl-with-other-asynchronous-patterns). - ]]> - - The has been disposed. - - - - - - - - - - Property - - P:System.IAsyncResult.CompletedSynchronously - - - System.Threading.Tasks - 4.0.0.0 - 4.0.10.0 - - - mscorlib - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Runtime - 4.2.0.0 - 4.2.1.0 - 4.2.2.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - System.Boolean - - - Gets an indication of whether the operation completed synchronously. - - if the operation completed synchronously; otherwise, . - + ]]> + + The has been disposed. + + + + + + + + + + Property + + P:System.IAsyncResult.CompletedSynchronously + + + System.Threading.Tasks + 4.0.0.0 + 4.0.10.0 + + + mscorlib + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Runtime + 4.2.0.0 + 4.2.1.0 + 4.2.2.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + System.Boolean + + + Gets an indication of whether the operation completed synchronously. + + if the operation completed synchronously; otherwise, . + instance is cast to an interface. - ]]> - - - - - - System.Threading.Tasks - 4.0.0.0 - 4.0.10.0 - - - Waits for the to complete execution. - - - - - - - - - - Method - - System.Threading.Tasks - 4.0.0.0 - 4.0.10.0 - - - mscorlib - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Runtime - 4.2.0.0 - 4.2.1.0 - 4.2.2.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - System.Void - - - - Waits for the to complete execution. - + ]]> + + + + + + System.Threading.Tasks + 4.0.0.0 + 4.0.10.0 + + + Waits for the to complete execution. + + + + + + + + + + Method + + System.Threading.Tasks + 4.0.0.0 + 4.0.10.0 + + + mscorlib + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Runtime + 4.2.0.0 + 4.2.1.0 + 4.2.2.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + System.Void + + + + Waits for the to complete execution. + - - The has been disposed. + ]]> + + The has been disposed. The task was canceled. The collection contains a object. -or- - An exception was thrown during the execution of the task. The collection contains information about the exception or exceptions. - Task.Wait and "Inlining" - - - - - - - - - - Method - - System.Threading.Tasks - 4.0.0.0 - 4.0.10.0 - - - mscorlib - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Runtime - 4.2.0.0 - 4.2.1.0 - 4.2.2.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - System.Boolean - - - - - - The number of milliseconds to wait, or (-1) to wait indefinitely. - Waits for the to complete execution within a specified number of milliseconds. - - if the completed execution within the allotted time; otherwise, . - + An exception was thrown during the execution of the task. The collection contains information about the exception or exceptions. + Task.Wait and "Inlining" + + + + + + + + + + Method + + System.Threading.Tasks + 4.0.0.0 + 4.0.10.0 + + + mscorlib + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Runtime + 4.2.0.0 + 4.2.1.0 + 4.2.2.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + System.Boolean + + + + + + The number of milliseconds to wait, or (-1) to wait indefinitely. + Waits for the to complete execution within a specified number of milliseconds. + + if the completed execution within the allotted time; otherwise, . + - - The has been disposed. - - is a negative number other than -1, which represents an infinite time-out. + ]]> + + The has been disposed. + + is a negative number other than -1, which represents an infinite time-out. The task was canceled. The collection contains a object. -or- - An exception was thrown during the execution of the task. The collection contains information about the exception or exceptions. - - - - - - - - - - Method - - System.Threading.Tasks - 4.0.0.0 - 4.0.10.0 - - - mscorlib - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Runtime - 4.2.0.0 - 4.2.1.0 - 4.2.2.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - System.Void - - - - - - A cancellation token to observe while waiting for the task to complete. - Waits for the to complete execution. The wait terminates if a cancellation token is canceled before the task completes. - + An exception was thrown during the execution of the task. The collection contains information about the exception or exceptions. + + + + + + + + + + Method + + System.Threading.Tasks + 4.0.0.0 + 4.0.10.0 + + + mscorlib + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Runtime + 4.2.0.0 + 4.2.1.0 + 4.2.2.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + System.Void + + + + + + A cancellation token to observe while waiting for the task to complete. + Waits for the to complete execution. The wait terminates if a cancellation token is canceled before the task completes. + [!NOTE] > Canceling the `cancellationToken` cancellation token has no effect on the running task unless it has also been passed the cancellation token and is prepared to handle cancellation. Passing the `cancellationToken` object to this method simply allows the wait to be canceled. - - ## Examples The following example illustrates the simple use of a cancellation token to cancel waiting for a task's completion. A task is launched, calls the method to cancel any of the token source's cancellation tokens, and then delays for five seconds. Note that the task itself has not been passed the cancellation token and is not cancelable. The application thread calls the task's method to wait for the task to complete, but the wait is canceled once the cancellation token is cancelled and an is thrown. The exception handler reports the exception and then sleeps for six seconds. As the output from the example shows, that delay allows the task to complete in the state. @@ -5181,62 +5175,62 @@ This member is an explicit interface member implementation. It can be used only :::code language="fsharp" source="~/snippets/fsharp/System.Threading.Tasks/Task/Wait/wait3.fs" id="Snippet3"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.threading.tasks.task.wait/vb/wait3.vb" id="Snippet3"::: - ]]> - - The was canceled. - The task has been disposed. + ]]> + + The was canceled. + The task has been disposed. The task was canceled. The collection contains a object. -or- - An exception was thrown during the execution of the task. The collection contains information about the exception or exceptions. - - - - - - - - - - Method - - System.Threading.Tasks - 4.0.0.0 - 4.0.10.0 - - - mscorlib - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Runtime - 4.2.0.0 - 4.2.1.0 - 4.2.2.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - System.Boolean - - - - - - A that represents the number of milliseconds to wait, or a that represents -1 milliseconds to wait indefinitely. - Waits for the to complete execution within a specified time interval. - - if the completed execution within the allotted time; otherwise, . - + An exception was thrown during the execution of the task. The collection contains information about the exception or exceptions. + + + + + + + + + + Method + + System.Threading.Tasks + 4.0.0.0 + 4.0.10.0 + + + mscorlib + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Runtime + 4.2.0.0 + 4.2.1.0 + 4.2.2.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + System.Boolean + + + + + + A that represents the number of milliseconds to wait, or a that represents -1 milliseconds to wait indefinitely. + Waits for the to complete execution within a specified time interval. + + if the completed execution within the allotted time; otherwise, . + - - The has been disposed. - + ]]> + + The has been disposed. + is a negative number other than -1 milliseconds, which represents an infinite time-out. -or- - is greater than Int32.MaxValue. + is greater than Int32.MaxValue. The task was canceled. The collection contains a object. -or- - An exception was thrown during the execution of the task. The collection contains information about the exception or exceptions. - - - - - - - - - - Method - - System.Threading.Tasks - 4.0.0.0 - 4.0.10.0 - - - mscorlib - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Runtime - 4.2.0.0 - 4.2.1.0 - 4.2.2.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - System.Boolean - - - - - - - The number of milliseconds to wait, or (-1) to wait indefinitely. - A cancellation token to observe while waiting for the task to complete. - Waits for the to complete execution. The wait terminates if a timeout interval elapses or a cancellation token is canceled before the task completes. - - if the completed execution within the allotted time; otherwise, . - + An exception was thrown during the execution of the task. The collection contains information about the exception or exceptions. + + + + + + + + + + Method + + System.Threading.Tasks + 4.0.0.0 + 4.0.10.0 + + + mscorlib + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Runtime + 4.2.0.0 + 4.2.1.0 + 4.2.2.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + System.Boolean + + + + + + + The number of milliseconds to wait, or (-1) to wait indefinitely. + A cancellation token to observe while waiting for the task to complete. + Waits for the to complete execution. The wait terminates if a timeout interval elapses or a cancellation token is canceled before the task completes. + + if the completed execution within the allotted time; otherwise, . + - - The was canceled. - The has been disposed. - - is a negative number other than -1, which represents an infinite time-out. + ]]> + + The was canceled. + The has been disposed. + + is a negative number other than -1, which represents an infinite time-out. The task was canceled. The collection contains a object. -or- - An exception was thrown during the execution of the task. The collection contains information about the exception or exceptions. - - - - - - - - - - Method - - System.Runtime - 7.0.0.0 - 8.0.0.0 - - - System.Threading.Tasks - - - mscorlib - - - netstandard - - - System.Boolean - - - - - - - The time to wait, or to wait indefinitely - A to observe while waiting for the task to complete. - Waits for the to complete execution. - - if the completed execution within the allotted time; otherwise, . - To be added. + An exception was thrown during the execution of the task. The collection contains information about the exception or exceptions. + + + + + + + + + + Method + + System.Runtime + 7.0.0.0 + 8.0.0.0 + + + System.Threading.Tasks + + + mscorlib + + + netstandard + + + System.Boolean + + + + + + + The time to wait, or to wait indefinitely + A to observe while waiting for the task to complete. + Waits for the to complete execution. + + if the completed execution within the allotted time; otherwise, . + To be added. The was canceled -or- -an exception was thrown during the execution of the . - +an exception was thrown during the execution of the . + is a negative number other than -1 milliseconds, which represents an infinite time-out -or- timeout is greater than - . - The was canceled. - - - - - System.Threading.Tasks - 4.0.0.0 - 4.0.10.0 - - - Waits for all of the provided objects to complete execution. - - - - - - - - - - Method - - System.Threading.Tasks - 4.0.0.0 - 4.0.10.0 - - - mscorlib - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Runtime - 4.2.0.0 - 4.2.1.0 - 4.2.2.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - - [System.Runtime.Versioning.UnsupportedOSPlatform("browser")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("browser")>] - - - - System.Void - - - - - - [System.ParamArray] - [<System.ParamArray>] - - - - - - An array of instances on which to wait. - Waits for all of the provided objects to complete execution. - + . + The was canceled. + + + + + System.Threading.Tasks + 4.0.0.0 + 4.0.10.0 + + + Waits for all of the provided objects to complete execution. + + + + + + + + + + Method + + System.Threading.Tasks + 4.0.0.0 + 4.0.10.0 + + + mscorlib + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Runtime + 4.2.0.0 + 4.2.1.0 + 4.2.2.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + + [System.Runtime.Versioning.UnsupportedOSPlatform("browser")] + [<System.Runtime.Versioning.UnsupportedOSPlatform("browser")>] + + + + System.Void + + + + + + [System.ParamArray] + [<System.ParamArray>] + + + + + + An array of instances on which to wait. + Waits for all of the provided objects to complete execution. + - - One or more of the objects in has been disposed. - The argument is . - The argument contains a null element. + ]]> + + One or more of the objects in has been disposed. + The argument is . + The argument contains a null element. At least one of the instances was canceled. If a task was canceled, the exception contains an exception in its collection. -or- - An exception was thrown during the execution of at least one of the instances. - - - - - - - - - - Method - - System.Threading.Tasks - 4.0.0.0 - 4.0.10.0 - - - mscorlib - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Runtime - 4.2.0.0 - 4.2.1.0 - 4.2.2.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - - [System.Runtime.Versioning.UnsupportedOSPlatform("browser")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("browser")>] - - - - System.Boolean - - - - - - - An array of instances on which to wait. - The number of milliseconds to wait, or (-1) to wait indefinitely. - Waits for all of the provided objects to complete execution within a specified number of milliseconds. - - if all of the instances completed execution within the allotted time; otherwise, . - To be added. - One or more of the objects in has been disposed. - The argument is . + An exception was thrown during the execution of at least one of the instances. + + + + + + + + + + Method + + System.Threading.Tasks + 4.0.0.0 + 4.0.10.0 + + + mscorlib + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Runtime + 4.2.0.0 + 4.2.1.0 + 4.2.2.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + + [System.Runtime.Versioning.UnsupportedOSPlatform("browser")] + [<System.Runtime.Versioning.UnsupportedOSPlatform("browser")>] + + + + System.Boolean + + + + + + + An array of instances on which to wait. + The number of milliseconds to wait, or (-1) to wait indefinitely. + Waits for all of the provided objects to complete execution within a specified number of milliseconds. + + if all of the instances completed execution within the allotted time; otherwise, . + To be added. + One or more of the objects in has been disposed. + The argument is . At least one of the instances was canceled. If a task was canceled, the contains an in its collection. -or- - An exception was thrown during the execution of at least one of the instances. - - is a negative number other than -1, which represents an infinite time-out. - The argument contains a null element. - - - - - - - - - - Method - - System.Threading.Tasks - 4.0.0.0 - 4.0.10.0 - - - mscorlib - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Runtime - 4.2.0.0 - 4.2.1.0 - 4.2.2.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - - [System.Runtime.Versioning.UnsupportedOSPlatform("browser")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("browser")>] - - - - System.Void - - - - - - - An array of instances on which to wait. - A to observe while waiting for the tasks to complete. - Waits for all of the provided objects to complete execution unless the wait is cancelled. - + An exception was thrown during the execution of at least one of the instances. + + is a negative number other than -1, which represents an infinite time-out. + The argument contains a null element. + + + + + + + + + + Method + + System.Threading.Tasks + 4.0.0.0 + 4.0.10.0 + + + mscorlib + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Runtime + 4.2.0.0 + 4.2.1.0 + 4.2.2.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + + [System.Runtime.Versioning.UnsupportedOSPlatform("browser")] + [<System.Runtime.Versioning.UnsupportedOSPlatform("browser")>] + + + + System.Void + + + + + + + An array of instances on which to wait. + A to observe while waiting for the tasks to complete. + Waits for all of the provided objects to complete execution unless the wait is cancelled. + as noted above. - ]]> - - The was canceled. - The argument is . + ]]> + + The was canceled. + The argument is . At least one of the instances was canceled. If a task was canceled, the contains an in its collection. -or- - An exception was thrown during the execution of at least one of the instances. - The argument contains a null element. - One or more of the objects in has been disposed. - - - - - - - - - - Method - - System.Threading.Tasks - 4.0.0.0 - 4.0.10.0 - - - mscorlib - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Runtime - 4.2.0.0 - 4.2.1.0 - 4.2.2.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - - [System.Runtime.Versioning.UnsupportedOSPlatform("browser")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("browser")>] - - - - System.Boolean - - - - - - - An array of instances on which to wait. - A that represents the number of milliseconds to wait, or a that represents -1 milliseconds to wait indefinitely. - Waits for all of the provided cancellable objects to complete execution within a specified time interval. - - if all of the instances completed execution within the allotted time; otherwise, . - To be added. - One or more of the objects in has been disposed. - The argument is . + An exception was thrown during the execution of at least one of the instances. + The argument contains a null element. + One or more of the objects in has been disposed. + + + + + + + + + + Method + + System.Threading.Tasks + 4.0.0.0 + 4.0.10.0 + + + mscorlib + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Runtime + 4.2.0.0 + 4.2.1.0 + 4.2.2.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + + [System.Runtime.Versioning.UnsupportedOSPlatform("browser")] + [<System.Runtime.Versioning.UnsupportedOSPlatform("browser")>] + + + + System.Boolean + + + + + + + An array of instances on which to wait. + A that represents the number of milliseconds to wait, or a that represents -1 milliseconds to wait indefinitely. + Waits for all of the provided cancellable objects to complete execution within a specified time interval. + + if all of the instances completed execution within the allotted time; otherwise, . + To be added. + One or more of the objects in has been disposed. + The argument is . At least one of the instances was canceled. If a task was canceled, the contains an in its collection. -or- - An exception was thrown during the execution of at least one of the instances. - + An exception was thrown during the execution of at least one of the instances. + is a negative number other than -1 milliseconds, which represents an infinite time-out. -or- - is greater than Int32.MaxValue. - The argument contains a null element. - - - - - - - - - - Method - - System.Threading.Tasks - 4.0.0.0 - 4.0.10.0 - - - mscorlib - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Runtime - 4.2.0.0 - 4.2.1.0 - 4.2.2.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - - [System.Runtime.Versioning.UnsupportedOSPlatform("browser")] - [<System.Runtime.Versioning.UnsupportedOSPlatform("browser")>] - - - - System.Boolean - - - - - - - - An array of instances on which to wait. - The number of milliseconds to wait, or (-1) to wait indefinitely. - A to observe while waiting for the tasks to complete. - Waits for all of the provided objects to complete execution within a specified number of milliseconds or until the wait is cancelled. - - if all of the instances completed execution within the allotted time; otherwise, . - + is greater than Int32.MaxValue. + The argument contains a null element. + + + + + + + + + + Method + + System.Threading.Tasks + 4.0.0.0 + 4.0.10.0 + + + mscorlib + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Runtime + 4.2.0.0 + 4.2.1.0 + 4.2.2.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + + [System.Runtime.Versioning.UnsupportedOSPlatform("browser")] + [<System.Runtime.Versioning.UnsupportedOSPlatform("browser")>] + + + + System.Boolean + + + + + + + + An array of instances on which to wait. + The number of milliseconds to wait, or (-1) to wait indefinitely. + A to observe while waiting for the tasks to complete. + Waits for all of the provided objects to complete execution within a specified number of milliseconds or until the wait is cancelled. + + if all of the instances completed execution within the allotted time; otherwise, . + noted above. - ]]> - - One or more of the objects in has been disposed. - The argument is . + ]]> + + One or more of the objects in has been disposed. + The argument is . At least one of the instances was canceled. If a task was canceled, the contains an in its collection. -or- - An exception was thrown during the execution of at least one of the instances. - - is a negative number other than -1, which represents an infinite time-out. - The argument contains a null element. - The was canceled. - - - - - System.Threading.Tasks - 4.0.0.0 - 4.0.10.0 - - - Waits for any of the provided objects to complete execution. - - - - - - - - - - Method - - System.Threading.Tasks - 4.0.0.0 - 4.0.10.0 - - - mscorlib - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Runtime - 4.2.0.0 - 4.2.1.0 - 4.2.2.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - System.Int32 - - - - - - [System.ParamArray] - [<System.ParamArray>] - - - - - - An array of instances on which to wait. - Waits for any of the provided objects to complete execution. - The index of the completed object in the array. - + An exception was thrown during the execution of at least one of the instances. + + is a negative number other than -1, which represents an infinite time-out. + The argument contains a null element. + The was canceled. + + + + + System.Threading.Tasks + 4.0.0.0 + 4.0.10.0 + + + Waits for any of the provided objects to complete execution. + + + + + + + + + + Method + + System.Threading.Tasks + 4.0.0.0 + 4.0.10.0 + + + mscorlib + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Runtime + 4.2.0.0 + 4.2.1.0 + 4.2.2.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + System.Int32 + + + + + + [System.ParamArray] + [<System.ParamArray>] + + + + + + An array of instances on which to wait. + Waits for any of the provided objects to complete execution. + The index of the completed object in the array. + - - The has been disposed. - The argument is . - The argument contains a null element. - - - - - - - - - - Method - - System.Threading.Tasks - 4.0.0.0 - 4.0.10.0 - - - mscorlib - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Runtime - 4.2.0.0 - 4.2.1.0 - 4.2.2.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - System.Int32 - - - - - - - An array of instances on which to wait. - The number of milliseconds to wait, or (-1) to wait indefinitely. - Waits for any of the provided objects to complete execution within a specified number of milliseconds. - The index of the completed task in the array argument, or -1 if the timeout occurred. - To be added. - The has been disposed. - The argument is . - - is a negative number other than -1, which represents an infinite time-out. - The argument contains a null element. - - - - - - - - - - Method - - System.Threading.Tasks - 4.0.0.0 - 4.0.10.0 - - - mscorlib - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Runtime - 4.2.0.0 - 4.2.1.0 - 4.2.2.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - System.Int32 - - - - - - - An array of instances on which to wait. - A to observe while waiting for a task to complete. - Waits for any of the provided objects to complete execution unless the wait is cancelled. - The index of the completed task in the array argument. - To be added. - The has been disposed. - The argument is . - The argument contains a null element. - The was canceled. - - - - - - - - - - Method - - System.Threading.Tasks - 4.0.0.0 - 4.0.10.0 - - - mscorlib - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Runtime - 4.2.0.0 - 4.2.1.0 - 4.2.2.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - System.Int32 - - - - - - - An array of instances on which to wait. - A that represents the number of milliseconds to wait, or a that represents -1 milliseconds to wait indefinitely. - Waits for any of the provided objects to complete execution within a specified time interval. - The index of the completed task in the array argument, or -1 if the timeout occurred. - To be added. - The has been disposed. - The argument is . + ]]> + + The has been disposed. + The argument is . + The argument contains a null element. + + + + + + + + + + Method + + System.Threading.Tasks + 4.0.0.0 + 4.0.10.0 + + + mscorlib + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Runtime + 4.2.0.0 + 4.2.1.0 + 4.2.2.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + System.Int32 + + + + + + + An array of instances on which to wait. + The number of milliseconds to wait, or (-1) to wait indefinitely. + Waits for any of the provided objects to complete execution within a specified number of milliseconds. + The index of the completed task in the array argument, or -1 if the timeout occurred. + To be added. + The has been disposed. + The argument is . + + is a negative number other than -1, which represents an infinite time-out. + The argument contains a null element. + + + + + + + + + + Method + + System.Threading.Tasks + 4.0.0.0 + 4.0.10.0 + + + mscorlib + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Runtime + 4.2.0.0 + 4.2.1.0 + 4.2.2.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + System.Int32 + + + + + + + An array of instances on which to wait. + A to observe while waiting for a task to complete. + Waits for any of the provided objects to complete execution unless the wait is cancelled. + The index of the completed task in the array argument. + To be added. + The has been disposed. + The argument is . + The argument contains a null element. + The was canceled. + + + + + + + + + + Method + + System.Threading.Tasks + 4.0.0.0 + 4.0.10.0 + + + mscorlib + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Runtime + 4.2.0.0 + 4.2.1.0 + 4.2.2.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + System.Int32 + + + + + + + An array of instances on which to wait. + A that represents the number of milliseconds to wait, or a that represents -1 milliseconds to wait indefinitely. + Waits for any of the provided objects to complete execution within a specified time interval. + The index of the completed task in the array argument, or -1 if the timeout occurred. + To be added. + The has been disposed. + The argument is . The property of the argument is a negative number other than -1, which represents an infinite time-out. -or- - The property of the argument is greater than Int32.MaxValue. - The argument contains a null element. - - - - - - - - - - Method - - System.Threading.Tasks - 4.0.0.0 - 4.0.10.0 - - - mscorlib - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Runtime - 4.2.0.0 - 4.2.1.0 - 4.2.2.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - System.Int32 - - - - - - - - An array of instances on which to wait. - The number of milliseconds to wait, or (-1) to wait indefinitely. - A to observe while waiting for a task to complete. - Waits for any of the provided objects to complete execution within a specified number of milliseconds or until a cancellation token is cancelled. - The index of the completed task in the array argument, or -1 if the timeout occurred. - To be added. - The has been disposed. - The argument is . - - is a negative number other than -1, which represents an infinite time-out. - The argument contains a null element. - The was canceled. - - - - - - - - - - Method - - System.Runtime - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - System.Threading.Tasks - - - mscorlib - - - netstandard - - - System.Threading.Tasks.Task - - - - - - The to monitor for a cancellation request. - Gets a that will complete when this completes or when the specified has cancellation requested. - The representing the asynchronous wait. It may or may not be the same instance as the current instance. - 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 . - - - - - - - - - - Method - - System.Runtime - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - System.Threading.Tasks - - - mscorlib - - - netstandard - - - System.Threading.Tasks.Task - - - - - - The timeout after which the should be faulted with a if it hasn't otherwise completed. - Gets a that will complete when this completes or when the specified timeout expires. - The representing the asynchronous wait. It may or may not be the same instance as the current instance. - 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 . - - - - - - - - - - Method - - System.Runtime - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - System.Threading.Tasks - - - mscorlib - - - netstandard - - - System.Threading.Tasks.Task - - - - - - - The timeout after which the should be faulted with a if it hasn't otherwise completed. - The to monitor for a cancellation request. - Gets a that will complete when this completes, when the specified timeout expires, or when the specified has cancellation requested. - The representing the asynchronous wait. It may or may not be the same instance as the current instance. - 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 . - - - - - - - - - - Method - - System.Runtime - 8.0.0.0 - - - System.Threading.Tasks - - - mscorlib - - - netstandard - - - System.Threading.Tasks.Task - - - - - - - The timeout after which the should be faulted with a if it hasn't otherwise completed. - The with which to interpret . - Gets a that will complete when this completes or when the specified timeout expires. - The representing the asynchronous wait. It may or may not be the same instance as the current instance. - To be added. - The argument is . - - - - - - - - - - Method - - System.Runtime - 8.0.0.0 - - - System.Threading.Tasks - - - mscorlib - - - netstandard - - - System.Threading.Tasks.Task - - - - - - - - The timeout after which the should be faulted with a if it hasn't otherwise completed. - The with which to interpret . - The to monitor for a cancellation request. - Gets a that will complete when this completes, when the specified timeout expires, or when the specified has cancellation requested. - The representing the asynchronous wait. It may or may not be the same instance as the current instance. - To be added. - The argument is . - - - - - System.Threading.Tasks - 4.0.0.0 - 4.0.10.0 - - - Creates a task that will complete when all of the supplied tasks have completed. - - - - - - - - - - Method - - System.Threading.Tasks - 4.0.0.0 - 4.0.10.0 - - - mscorlib - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Runtime - 4.2.0.0 - 4.2.1.0 - 4.2.2.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - System.Threading.Tasks.Task - - - - - - The tasks to wait on for completion. - Creates a task that will complete when all of the objects in an enumerable collection have completed. - A task that represents the completion of all of the supplied tasks. - + The property of the argument is greater than Int32.MaxValue. + The argument contains a null element. + + + + + + + + + + Method + + System.Threading.Tasks + 4.0.0.0 + 4.0.10.0 + + + mscorlib + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Runtime + 4.2.0.0 + 4.2.1.0 + 4.2.2.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + System.Int32 + + + + + + + + An array of instances on which to wait. + The number of milliseconds to wait, or (-1) to wait indefinitely. + A to observe while waiting for a task to complete. + Waits for any of the provided objects to complete execution within a specified number of milliseconds or until a cancellation token is cancelled. + The index of the completed task in the array argument, or -1 if the timeout occurred. + To be added. + The has been disposed. + The argument is . + + is a negative number other than -1, which represents an infinite time-out. + The argument contains a null element. + The was canceled. + + + + + + + + + + Method + + System.Runtime + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + System.Threading.Tasks + + + mscorlib + + + netstandard + + + System.Threading.Tasks.Task + + + + + + The to monitor for a cancellation request. + Gets a that will complete when this completes or when the specified has cancellation requested. + The representing the asynchronous wait. It may or may not be the same instance as the current instance. + 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 . + The cancellation token was canceled. This exception is stored into the returned task. + + + + + + + + + + Method + + System.Runtime + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + System.Threading.Tasks + + + mscorlib + + + netstandard + + + System.Threading.Tasks.Task + + + + + + The timeout after which the should be faulted with a if it hasn't otherwise completed. + Gets a that will complete when this completes or when the specified timeout expires. + The representing the asynchronous wait. It may or may not be the same instance as the current instance. + 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 . + + + + + + + + + + Method + + System.Runtime + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + System.Threading.Tasks + + + mscorlib + + + netstandard + + + System.Threading.Tasks.Task + + + + + + + The timeout after which the should be faulted with a if it hasn't otherwise completed. + The to monitor for a cancellation request. + Gets a that will complete when this completes, when the specified timeout expires, or when the specified has cancellation requested. + The representing the asynchronous wait. It may or may not be the same instance as the current instance. + 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 . + The cancellation token was canceled. This exception is stored into the returned task. + + + + + + + + + + Method + + System.Runtime + 8.0.0.0 + + + System.Threading.Tasks + + + mscorlib + + + netstandard + + + System.Threading.Tasks.Task + + + + + + + The timeout after which the should be faulted with a if it hasn't otherwise completed. + The with which to interpret . + Gets a that will complete when this completes or when the specified timeout expires. + The representing the asynchronous wait. It may or may not be the same instance as the current instance. + To be added. + The argument is . + + + + + + + + + + Method + + System.Runtime + 8.0.0.0 + + + System.Threading.Tasks + + + mscorlib + + + netstandard + + + System.Threading.Tasks.Task + + + + + + + + The timeout after which the should be faulted with a if it hasn't otherwise completed. + The with which to interpret . + The to monitor for a cancellation request. + Gets a that will complete when this completes, when the specified timeout expires, or when the specified has cancellation requested. + The representing the asynchronous wait. It may or may not be the same instance as the current instance. + To be added. + The argument is . + The cancellation token was canceled. This exception is stored into the returned task. + + + + + System.Threading.Tasks + 4.0.0.0 + 4.0.10.0 + + + Creates a task that will complete when all of the supplied tasks have completed. + + + + + + + + + + Method + + System.Threading.Tasks + 4.0.0.0 + 4.0.10.0 + + + mscorlib + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Runtime + 4.2.0.0 + 4.2.1.0 + 4.2.2.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + System.Threading.Tasks.Task + + + + + + The tasks to wait on for completion. + Creates a task that will complete when all of the objects in an enumerable collection have completed. + A task that represents the completion of all of the supplied tasks. + - - The argument was . - The collection contained a task. - - - - - - - - - - Method - - System.Threading.Tasks - 4.0.0.0 - 4.0.10.0 - - - mscorlib - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Runtime - 4.2.0.0 - 4.2.1.0 - 4.2.2.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - System.Threading.Tasks.Task - - - - - - [System.ParamArray] - [<System.ParamArray>] - - - - - - The tasks to wait on for completion. - Creates a task that will complete when all of the objects in an array have completed. - A task that represents the completion of all of the supplied tasks. - + ]]> + + The argument was . + The collection contained a task. + + + + + + + + + + Method + + System.Threading.Tasks + 4.0.0.0 + 4.0.10.0 + + + mscorlib + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Runtime + 4.2.0.0 + 4.2.1.0 + 4.2.2.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + System.Threading.Tasks.Task + + + + + + [System.ParamArray] + [<System.ParamArray>] + + + + + + The tasks to wait on for completion. + Creates a task that will complete when all of the objects in an array have completed. + A task that represents the completion of all of the supplied tasks. + - - The argument was . - The array contained a task. - - - - - - - - - - Method - - System.Threading.Tasks - 4.0.0.0 - 4.0.10.0 - - - mscorlib - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Runtime - 4.2.0.0 - 4.2.1.0 - 4.2.2.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - System.Threading.Tasks.Task<TResult[]> - - - - - - [System.Runtime.CompilerServices.Nullable(2)] - [<System.Runtime.CompilerServices.Nullable(2)>] - - - - - - - - - The type of the completed task. - The tasks to wait on for completion. - Creates a task that will complete when all of the objects in an enumerable collection have completed. - A task that represents the completion of all of the supplied tasks. - + ]]> + + The argument was . + The array contained a task. + + + + + + + + + + Method + + System.Threading.Tasks + 4.0.0.0 + 4.0.10.0 + + + mscorlib + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Runtime + 4.2.0.0 + 4.2.1.0 + 4.2.2.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + System.Threading.Tasks.Task<TResult[]> + + + + + + [System.Runtime.CompilerServices.Nullable(2)] + [<System.Runtime.CompilerServices.Nullable(2)>] + + + + + + + + + The type of the completed task. + The tasks to wait on for completion. + Creates a task that will complete when all of the objects in an enumerable collection have completed. + A task that represents the completion of all of the supplied tasks. + object. implements the interface. - ]]> - - The argument was . - The collection contained a task. - - - - - - - - - - Method - - System.Threading.Tasks - 4.0.0.0 - 4.0.10.0 - - - mscorlib - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Runtime - 4.2.0.0 - 4.2.1.0 - 4.2.2.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - System.Threading.Tasks.Task<TResult[]> - - - - - - [System.Runtime.CompilerServices.Nullable(2)] - [<System.Runtime.CompilerServices.Nullable(2)>] - - - - - - - - - [System.ParamArray] - [<System.ParamArray>] - - - - - - The type of the completed task. - The tasks to wait on for completion. - Creates a task that will complete when all of the objects in an array have completed. - A task that represents the completion of all of the supplied tasks. - + ]]> + + The argument was . + The collection contained a task. + + + + + + + + + + Method + + System.Threading.Tasks + 4.0.0.0 + 4.0.10.0 + + + mscorlib + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Runtime + 4.2.0.0 + 4.2.1.0 + 4.2.2.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + System.Threading.Tasks.Task<TResult[]> + + + + + + [System.Runtime.CompilerServices.Nullable(2)] + [<System.Runtime.CompilerServices.Nullable(2)>] + + + + + + + + + [System.ParamArray] + [<System.ParamArray>] + + + + + + The type of the completed task. + The tasks to wait on for completion. + Creates a task that will complete when all of the objects in an array have completed. + A task that represents the completion of all of the supplied tasks. + - - The argument was . - The array contained a task. - - - - - System.Threading.Tasks - 4.0.0.0 - 4.0.10.0 - - - Creates a task that will complete when any of the supplied tasks have completed. - - - - - - - - - - Method - - System.Threading.Tasks - 4.0.0.0 - 4.0.10.0 - - - mscorlib - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Runtime - 4.2.0.0 - 4.2.1.0 - 4.2.2.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - System.Threading.Tasks.Task<System.Threading.Tasks.Task> - - - - - - The tasks to wait on for completion. - Creates a task that will complete when any of the supplied tasks have completed. - A task that represents the completion of one of the supplied tasks. The return task's Result is the task that completed. - + ]]> + + The argument was . + The array contained a task. + + + + + System.Threading.Tasks + 4.0.0.0 + 4.0.10.0 + + + Creates a task that will complete when any of the supplied tasks have completed. + + + + + + + + + + Method + + System.Threading.Tasks + 4.0.0.0 + 4.0.10.0 + + + mscorlib + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Runtime + 4.2.0.0 + 4.2.1.0 + 4.2.2.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + System.Threading.Tasks.Task<System.Threading.Tasks.Task> + + + + + + The tasks to wait on for completion. + Creates a task that will complete when any of the supplied tasks have completed. + A task that represents the completion of one of the supplied tasks. The return task's Result is the task that completed. + - - The argument was . - The array contained a null task, or was empty. - - - - - - - - - - Method - - System.Threading.Tasks - 4.0.0.0 - 4.0.10.0 - - - mscorlib - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Runtime - 4.2.0.0 - 4.2.1.0 - 4.2.2.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - System.Threading.Tasks.Task<System.Threading.Tasks.Task> - - - - - - [System.ParamArray] - [<System.ParamArray>] - - - - - - The tasks to wait on for completion. - Creates a task that will complete when any of the supplied tasks have completed. - A task that represents the completion of one of the supplied tasks. The return task's Result is the task that completed. - + ]]> + + The argument was . + The array contained a null task, or was empty. + + + + + + + + + + Method + + System.Threading.Tasks + 4.0.0.0 + 4.0.10.0 + + + mscorlib + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Runtime + 4.2.0.0 + 4.2.1.0 + 4.2.2.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + System.Threading.Tasks.Task<System.Threading.Tasks.Task> + + + + + + [System.ParamArray] + [<System.ParamArray>] + + + + + + The tasks to wait on for completion. + Creates a task that will complete when any of the supplied tasks have completed. + A task that represents the completion of one of the supplied tasks. The return task's Result is the task that completed. + - - The argument was null. - The array contained a null task, or was empty. - - - - - - - - - - Method - - System.Runtime - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - System.Threading.Tasks - - - mscorlib - - - netstandard - - - System.Threading.Tasks.Task<System.Threading.Tasks.Task> - - - - - - - The first task to wait on for completion. - The second task to wait on for completion. - Creates a task that will complete when either of the supplied tasks have completed. - A new task that represents the completion of one of the supplied tasks. Its is the task that completed first. - + ]]> + + The argument was null. + The array contained a null task, or was empty. + + + + + + + + + + Method + + System.Runtime + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + System.Threading.Tasks + + + mscorlib + + + netstandard + + + System.Threading.Tasks.Task<System.Threading.Tasks.Task> + + + + + + + The first task to wait on for completion. + The second task to wait on for completion. + Creates a task that will complete when either of the supplied tasks have completed. + A new task that represents the completion of one of the supplied tasks. Its is the task that completed first. + - - - or was . - - - - - - - - - - Method - - System.Threading.Tasks - 4.0.0.0 - 4.0.10.0 - - - mscorlib - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Runtime - 4.2.0.0 - 4.2.1.0 - 4.2.2.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - System.Threading.Tasks.Task<System.Threading.Tasks.Task<TResult>> - - - - - - [System.Runtime.CompilerServices.Nullable(2)] - [<System.Runtime.CompilerServices.Nullable(2)>] - - - - - - - - - The type of the completed task. - The tasks to wait on for completion. - Creates a task that will complete when any of the supplied tasks have completed. - A task that represents the completion of one of the supplied tasks. The return task's Result is the task that completed. - + ]]> + + + or was . + + + + + + + + + + Method + + System.Threading.Tasks + 4.0.0.0 + 4.0.10.0 + + + mscorlib + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Runtime + 4.2.0.0 + 4.2.1.0 + 4.2.2.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + System.Threading.Tasks.Task<System.Threading.Tasks.Task<TResult>> + + + + + + [System.Runtime.CompilerServices.Nullable(2)] + [<System.Runtime.CompilerServices.Nullable(2)>] + + + + + + + + + The type of the completed task. + The tasks to wait on for completion. + Creates a task that will complete when any of the supplied tasks have completed. + A task that represents the completion of one of the supplied tasks. The return task's Result is the task that completed. + - - The argument was . - The array contained a null task, or was empty. - - - - - - - - - - Method - - System.Threading.Tasks - 4.0.0.0 - 4.0.10.0 - - - mscorlib - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Runtime - 4.2.0.0 - 4.2.1.0 - 4.2.2.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - System.Threading.Tasks.Task<System.Threading.Tasks.Task<TResult>> - - - - - - [System.Runtime.CompilerServices.Nullable(2)] - [<System.Runtime.CompilerServices.Nullable(2)>] - - - - - - - - - [System.ParamArray] - [<System.ParamArray>] - - - - - - The type of the completed task. - The tasks to wait on for completion. - Creates a task that will complete when any of the supplied tasks have completed. - A task that represents the completion of one of the supplied tasks. The return task's Result is the task that completed. - + ]]> + + The argument was . + The array contained a null task, or was empty. + + + + + + + + + + Method + + System.Threading.Tasks + 4.0.0.0 + 4.0.10.0 + + + mscorlib + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Runtime + 4.2.0.0 + 4.2.1.0 + 4.2.2.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + System.Threading.Tasks.Task<System.Threading.Tasks.Task<TResult>> + + + + + + [System.Runtime.CompilerServices.Nullable(2)] + [<System.Runtime.CompilerServices.Nullable(2)>] + + + + + + + + + [System.ParamArray] + [<System.ParamArray>] + + + + + + The type of the completed task. + The tasks to wait on for completion. + Creates a task that will complete when any of the supplied tasks have completed. + A task that represents the completion of one of the supplied tasks. The return task's Result is the task that completed. + - - The argument was null. - The array contained a null task, or was empty. - - - - - - - - - - Method - - System.Runtime - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - System.Threading.Tasks - - - mscorlib - - - netstandard - - - System.Threading.Tasks.Task<System.Threading.Tasks.Task<TResult>> - - - - - - [System.Runtime.CompilerServices.Nullable(2)] - [<System.Runtime.CompilerServices.Nullable(2)>] - - - - - - - - - - The type of the result of the returned task. - The first task to wait on for completion. - The second task to wait on for completion. - Creates a task that will complete when either of the supplied tasks have completed. - A task that represents the completion of one of the supplied tasks. The returned task's is the task that completed first. - + ]]> + + The argument was null. + The array contained a null task, or was empty. + + + + + + + + + + Method + + System.Runtime + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + System.Threading.Tasks + + + mscorlib + + + netstandard + + + System.Threading.Tasks.Task<System.Threading.Tasks.Task<TResult>> + + + + + + [System.Runtime.CompilerServices.Nullable(2)] + [<System.Runtime.CompilerServices.Nullable(2)>] + + + + + + + + + + The type of the result of the returned task. + The first task to wait on for completion. + The second task to wait on for completion. + Creates a task that will complete when either of the supplied tasks have completed. + A task that represents the completion of one of the supplied tasks. The returned task's is the task that completed first. + [!TIP] > In every overloaded version of Task.WhenAny() when this method returns the first completed task, the other tasks will continue running until completion, even any of them completed in the `Canceled` or `Faulted` state. So, if that behavior is not desired you may want to cancel all the remaining tasks once the first task complete. - ]]> - - - or was . - - - - - - - - - - Method - - System.Threading.Tasks - 4.0.0.0 - 4.0.10.0 - - - mscorlib - 2.0.5.0 - 4.0.0.0 - - - netstandard - 2.0.0.0 - 2.1.0.0 - - - System.Runtime - 4.2.0.0 - 4.2.1.0 - 4.2.2.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - System.Runtime.CompilerServices.YieldAwaitable - - - - Creates an awaitable task that asynchronously yields back to the current context when awaited. - A context that, when awaited, will asynchronously transition back into the current context at the time of the await. If the current is non-null, it is treated as the current context. Otherwise, the task scheduler that is associated with the currently executing task is treated as the current context. - + ]]> + + + or was . + + + + + + + + + + Method + + System.Threading.Tasks + 4.0.0.0 + 4.0.10.0 + + + mscorlib + 2.0.5.0 + 4.0.0.0 + + + netstandard + 2.0.0.0 + 2.1.0.0 + + + System.Runtime + 4.2.0.0 + 4.2.1.0 + 4.2.2.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + System.Runtime.CompilerServices.YieldAwaitable + + + + Creates an awaitable task that asynchronously yields back to the current context when awaited. + A context that, when awaited, will asynchronously transition back into the current context at the time of the await. If the current is non-null, it is treated as the current context. Otherwise, the task scheduler that is associated with the currently executing task is treated as the current context. + object), this will post the remainder of the method's execution back to that context. However, the context will decide how to prioritize this work relative to other work that may be pending. The synchronization context that is present on a UI thread in most UI environments will often prioritize work posted to the context higher than input and rendering work. For this reason, do not rely on `await Task.Yield();` to keep a UI responsive. For more information, see the entry [Useful Abstractions Enabled with ContinueWith](https://devblogs.microsoft.com/pfxteam/useful-abstractions-enabled-with-continuewith/) in the Parallel Programming with .NET blog. - ]]> - - - - - + ]]> + + + + + diff --git a/xml/System.Threading.Tasks/TaskCanceledException.xml b/xml/System.Threading.Tasks/TaskCanceledException.xml index 122a681101a..4ded6343489 100644 --- a/xml/System.Threading.Tasks/TaskCanceledException.xml +++ b/xml/System.Threading.Tasks/TaskCanceledException.xml @@ -116,18 +116,18 @@ Initializes a new instance of the class with a system-supplied message that describes the error. - property of the new instance to a system-supplied message that describes the error. This message takes into account the current system culture. - - The following table shows the initial property values for an instance of : - -|Property|Value| -|--------------|-----------| -||`null`.| -||The localized error message string.| - + property of the new instance to a system-supplied message that describes the error. This message takes into account the current system culture. + + The following table shows the initial property values for an instance of : + +|Property|Value| +|--------------|-----------| +||`null`.| +||The localized error message string.| + ]]> Handling and Throwing Exceptions @@ -177,16 +177,16 @@ The message that describes the exception. The caller of this constructor is required to ensure that this string has been localized for the current system culture. Initializes a new instance of the class with a specified message that describes the error. - . - -|Property|Value| -|--------------|-----------| -||`null`.| -||The error message string specified in `message`.| - + . + +|Property|Value| +|--------------|-----------| +||`null`.| +||The error message string specified in `message`.| + ]]> Handling and Throwing Exceptions @@ -296,11 +296,11 @@ The contextual information about the source or destination. Initializes a new instance of the class with serialized data. - Handling and Throwing Exceptions @@ -353,18 +353,18 @@ The exception that is the cause of the current exception. If the parameter is not , the current exception is raised in a block that handles the inner exception. Initializes a new instance of the class with a specified error message and a reference to the inner exception that is the cause of this exception. - property. The property returns the same value that is passed into the constructor, or `null` if the property does not supply the inner exception value to the constructor. - - The following table shows the initial property values for an instance of . - -|Property|Value| -|--------------|-----------| -||`null`.| -||The error message string specified in `message`.| - + property. The property returns the same value that is passed into the constructor, or `null` if the property does not supply the inner exception value to the constructor. + + The following table shows the initial property values for an instance of . + +|Property|Value| +|--------------|-----------| +||`null`.| +||The error message string specified in `message`.| + ]]> Handling and Throwing Exceptions @@ -455,13 +455,13 @@ Gets the task associated with this exception. A reference to the that is associated with this exception. - , in which case this property will return null. - - This property is thread-safe and may be used from multiple threads concurrently. - + , in which case this property will return null. + + This property is thread-safe and may be used from multiple threads concurrently. + ]]> Handling and Throwing Exceptions diff --git a/xml/System.Threading.Tasks/TaskCompletionSource.xml b/xml/System.Threading.Tasks/TaskCompletionSource.xml index fa6cabd20d1..2c803e24891 100644 --- a/xml/System.Threading.Tasks/TaskCompletionSource.xml +++ b/xml/System.Threading.Tasks/TaskCompletionSource.xml @@ -36,7 +36,7 @@ It is often the case that a is desired to represent another asynchronous operation. is provided for this purpose. It enables the creation of a task that can be handed out to consumers, and those consumers can use the members of the task as they would any other. However, unlike most tasks, the state of a task created by a is controlled explicitly by the methods on . This enables the completion of the external asynchronous operation to be propagated to the underlying `Task`. The separation also ensures that consumers are not able to transition the state without access to the corresponding . All members of are thread-safe and may be used from multiple threads concurrently. - + ]]> diff --git a/xml/System.Threading.Tasks/TaskCompletionSource`1.xml b/xml/System.Threading.Tasks/TaskCompletionSource`1.xml index 22ddd51ed95..bca91787cd8 100644 --- a/xml/System.Threading.Tasks/TaskCompletionSource`1.xml +++ b/xml/System.Threading.Tasks/TaskCompletionSource`1.xml @@ -69,21 +69,21 @@ The type of the result value associated with this . Represents the producer side of a unbound to a delegate, providing access to the consumer side through the property. - to represent an external asynchronous operation. is provided for this purpose. It enables the creation of a task that can be handed out to consumers. The consumers can use the members of the task the same way as they would in any other scenario handling task member variables. However, unlike most tasks, the state of a task created by a TaskCompletionSource is controlled explicitly by the methods on TaskCompletionSource. This enables the completion of the external asynchronous operation to be propagated to the underlying Task. The separation also ensures that consumers are not able to transition the state without access to the corresponding TaskCompletionSource. For more information, see the entry [The Nature of TaskCompletionSource\](https://devblogs.microsoft.com/pfxteam/the-nature-of-taskcompletionsourcetresult/) in the Parallel Programming with .NET blog. - - The [Parallel Extensions samples](https://go.microsoft.com/fwlink/?LinkID=165717) also contain examples of how to use . - - - -## Examples - The following example shows how to use a : - + to represent an external asynchronous operation. is provided for this purpose. It enables the creation of a task that can be handed out to consumers. The consumers can use the members of the task the same way as they would in any other scenario handling task member variables. However, unlike most tasks, the state of a task created by a TaskCompletionSource is controlled explicitly by the methods on TaskCompletionSource. This enables the completion of the external asynchronous operation to be propagated to the underlying Task. The separation also ensures that consumers are not able to transition the state without access to the corresponding TaskCompletionSource. For more information, see the entry [The Nature of TaskCompletionSource\](https://devblogs.microsoft.com/pfxteam/the-nature-of-taskcompletionsourcetresult/) in the Parallel Programming with .NET blog. + + The [Parallel Extensions samples](https://go.microsoft.com/fwlink/?LinkID=165717) also contain examples of how to use . + + + +## Examples + The following example shows how to use a : + :::code language="csharp" source="~/snippets/csharp/System.Threading.Tasks/TaskCompletionSourceTResult/Overview/taskcompletionsource.cs" id="Snippet01"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.threading.tasks.taskcompletionsource/vb/taskcompletionsource.vb" id="Snippet01"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.threading.tasks.taskcompletionsource/vb/taskcompletionsource.vb" id="Snippet01"::: + ]]> All members of are thread-safe and may be used from multiple threads concurrently. @@ -233,11 +233,11 @@ The options to use when creating the underlying . Creates a with the specified options. - created by this instance and accessible through its property will be instantiated using the specified `creationOptions`. - + created by this instance and accessible through its property will be instantiated using the specified `creationOptions`. + ]]> The represent options invalid for use with a . @@ -585,13 +585,13 @@ Gets the created by this . Returns the created by this . - that is controlled by this instance. When you create a object, the property of this object returns - - The , , , and methods (and their "Try" variants) on this instance all result in the relevant state transitions on this underlying Task. - + that is controlled by this instance. When you create a object, the property of this object returns + + The , , , and methods (and their "Try" variants) on this instance all result in the relevant state transitions on this underlying Task. + ]]> Using TPL with Other Asynchronous Patterns @@ -652,13 +652,13 @@ if the operation was successful; false if the operation was unsuccessful or the object has already been disposed. - is already in one of the three final states: , , or . - - This method also returns false if the underlying has already been disposed. - + is already in one of the three final states: , , or . + + This method also returns false if the underlying has already been disposed. + ]]> Using TPL with Other Asynchronous Patterns @@ -710,19 +710,19 @@ if the operation is successful; otherwise, . - object is already in one of the following three final states. - -- - -- - -- - - This method also returns `false` if the underlying object has already been disposed. - + object is already in one of the following three final states. + +- + +- + +- + + This method also returns `false` if the underlying object has already been disposed. + ]]> @@ -783,19 +783,19 @@ if the operation was successful; otherwise, . - is already in one of the three final states: , , or . - + is already in one of the three final states: , , or . + ]]> The was disposed. The argument is . - There are one or more null elements in . - - -or- - + There are one or more null elements in . + + -or- + The collection is empty. Using TPL with Other Asynchronous Patterns How to: Wrap EAP Patterns in a Task @@ -846,11 +846,11 @@ if the operation was successful; otherwise, . - is already in one of the three final states: , , or . - + is already in one of the three final states: , , or . + ]]> The was disposed. @@ -904,13 +904,13 @@ if the operation was successful; otherwise, . - is already in one of the three final states: , , or . - - This method also returns false if the underlying has already been disposed. - + is already in one of the three final states: , , or . + + This method also returns false if the underlying has already been disposed. + ]]> Using TPL with Other Asynchronous Patterns diff --git a/xml/System.Threading/PeriodicTimer.xml b/xml/System.Threading/PeriodicTimer.xml index 068a4296c13..b858ebf8353 100644 --- a/xml/System.Threading/PeriodicTimer.xml +++ b/xml/System.Threading/PeriodicTimer.xml @@ -1,27 +1,27 @@ - - - - - - - - - System.Runtime - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - System.Object - - - - System.IDisposable - - - - Provides a periodic timer that enables waiting asynchronously for timer ticks. - + + + + + + + + + System.Runtime + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + System.Object + + + + System.IDisposable + + + + Provides a periodic timer that enables waiting asynchronously for timer ticks. + may be used concurrently with an active to interrupt it and cause it to return `false`. - ]]> - - - - - - - - - - - Constructor - - System.Runtime - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - - - - The time interval in milliseconds between invocations of the callback. - Initializes the timer. - To be added. - - is less than or equal to 0, or greater than or equal to UInt32.MaxValue. - - - - - - - - - - Constructor - - System.Runtime - 8.0.0.0 - - - - [System.Runtime.CompilerServices.NullableContext(1)] - [<System.Runtime.CompilerServices.NullableContext(1)>] - - - - - - - - The period between ticks. - The used to interpret . - Initializes the timer. - To be added. - - must be or represent a number of milliseconds equal to or larger than 1 and smaller than . - - is . - - - - - - - - - - Method - - M:System.IDisposable.Dispose - - - System.Runtime - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - System.Void - - - - Stops the timer and releases the associated managed resources. - + ]]> + + + + + + + + + + + Constructor + + System.Runtime + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + + + + The time interval in milliseconds between invocations of the callback. + Initializes the timer. + To be added. + + is less than or equal to 0, or greater than or equal to UInt32.MaxValue. + + + + + + + + + + Constructor + + System.Runtime + 8.0.0.0 + + + + [System.Runtime.CompilerServices.NullableContext(1)] + [<System.Runtime.CompilerServices.NullableContext(1)>] + + + + + + + + The period between ticks. + The used to interpret . + Initializes the timer. + To be added. + + must be or represent a number of milliseconds equal to or larger than 1 and smaller than . + + is . + + + + + + + + + + Method + + M:System.IDisposable.Dispose + + + System.Runtime + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + System.Void + + + + Stops the timer and releases the associated managed resources. + will cause an active wait with to complete with a value of `false`. All subsequent invocations will produce a value of `false`. - ]]> - - - - - - - - - - - Method - - System.Runtime - 7.0.0.0 - 8.0.0.0 - - - System.Void - - - - Ensures that resources are freed and other cleanup operations are performed when the garbage collector reclaims the object. - To be added. - - - - - - - - - - Property - - System.Runtime - 8.0.0.0 - - - System.TimeSpan - - - Gets or sets the period between ticks. - To be added. - All prior ticks of the timer, including any that may be waiting to be consumed by , are unaffected by changes to . Setting affects only and all subsequent times at which the timer will tick. - - must be or represent a number of milliseconds equal to or larger than 1 and smaller than . - - - - - - - - - Method - - System.Runtime - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - System.Threading.Tasks.ValueTask<System.Boolean> - - - - - - A for cancelling the asynchronous wait. If cancellation is requested, it affects only the single wait operation; the underlying timer continues firing. - Waits for the next tick of the timer, or for the timer to be stopped. - A task that will be completed due to the timer firing, being called to stop the timer, or cancellation being requested. - + ]]> + + + + + + + + + + + Method + + System.Runtime + 7.0.0.0 + 8.0.0.0 + + + System.Void + + + + Ensures that resources are freed and other cleanup operations are performed when the garbage collector reclaims the object. + To be added. + + + + + + + + + + Property + + System.Runtime + 8.0.0.0 + + + System.TimeSpan + + + Gets or sets the period between ticks. + To be added. + All prior ticks of the timer, including any that may be waiting to be consumed by , are unaffected by changes to . Setting affects only and all subsequent times at which the timer will tick. + + must be or represent a number of milliseconds equal to or larger than 1 and smaller than . + + + + + + + + + Method + + System.Runtime + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + System.Threading.Tasks.ValueTask<System.Boolean> + + + + + + A for cancelling the asynchronous wait. If cancellation is requested, it affects only the single wait operation; the underlying timer continues firing. + Waits for the next tick of the timer, or for the timer to be stopped. + A task that will be completed due to the timer firing, being called to stop the timer, or cancellation being requested. + behaves like an auto-reset event, in that multiple ticks are coalesced into a single tick if they occur between calls to . Similarly, a call to will void any tick not yet consumed. may only be used by one consumer at a time, and may be used concurrently with a single call to . - ]]> - - - - - + ]]> + + The cancellation token was canceled. This exception is stored into the returned task. + + + + diff --git a/xml/System.Web.WebSockets/AspNetWebSocket.xml b/xml/System.Web.WebSockets/AspNetWebSocket.xml index 8cf86d3b2b1..de4e133130b 100644 --- a/xml/System.Web.WebSockets/AspNetWebSocket.xml +++ b/xml/System.Web.WebSockets/AspNetWebSocket.xml @@ -93,6 +93,7 @@ -or- Receiving operations are unavailable. + The cancellation token was canceled. This exception is stored into the returned task. @@ -137,6 +138,7 @@ -or- Sending operations are unavailable. + The cancellation token was canceled. This exception is stored into the returned task. @@ -242,6 +244,7 @@ -or- Receiving operations are unavailable. + The cancellation token was canceled. This exception is stored into the returned task. @@ -280,6 +283,7 @@ -or- Sending operations are unavailable. + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.Windows.Threading/Dispatcher.xml b/xml/System.Windows.Threading/Dispatcher.xml index 10c4d0c6fac..d7e9e5c0d82 100644 --- a/xml/System.Windows.Threading/Dispatcher.xml +++ b/xml/System.Windows.Threading/Dispatcher.xml @@ -1128,6 +1128,7 @@ The default priority is `DispatcherPriority.Send`. An object that indicates whether to cancel the action. Executes the specified synchronously at the specified priority on the thread the is associated with. To be added. + The cancellation token was canceled. This exception is stored into the returned task. @@ -1410,6 +1411,7 @@ The default priority is `DispatcherPriority.Send`. is a negative number other than -1, and this method was invoked across threads. is not a valid priority. + The cancellation token was canceled. This exception is stored into the returned task. @@ -1792,6 +1794,7 @@ The default priority is `DispatcherPriority.Send`. Executes the specified synchronously at the specified priority on the thread the is associated with. The value returned by . To be added. + The cancellation token was canceled. This exception is stored into the returned task. @@ -1843,6 +1846,7 @@ The default priority is `DispatcherPriority.Send`. is a negative number other than -1, and the method was invoked across threads. is not a valid priority. + The cancellation token was canceled. This exception is stored into the returned task. @@ -1961,6 +1965,7 @@ This method stores in the task it returns all non-usage exceptions that the meth Executes the specified asynchronously at the specified priority on the thread the is associated with. An object, which is returned immediately after is called, that can be used to interact with the delegate as it is pending execution in the event queue. 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 . + The cancellation token was canceled. This exception is stored into the returned task. @@ -2072,6 +2077,7 @@ This method stores in the task it returns all non-usage exceptions that the meth Executes the specified asynchronously at the specified priority on the thread the is associated with. An object, which is returned immediately after is called, that can be used to interact with the delegate as it is pending execution in the event queue. To be added. + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.Xml.Linq/XCData.xml b/xml/System.Xml.Linq/XCData.xml index 1f24a4e2fb4..37c0b0821ca 100644 --- a/xml/System.Xml.Linq/XCData.xml +++ b/xml/System.Xml.Linq/XCData.xml @@ -411,6 +411,7 @@ Text Writes this to the given . A task representing the asynchronous write operation. 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 . + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.Xml.Linq/XComment.xml b/xml/System.Xml.Linq/XComment.xml index 6baaf8de47f..b4f1147fb35 100644 --- a/xml/System.Xml.Linq/XComment.xml +++ b/xml/System.Xml.Linq/XComment.xml @@ -437,6 +437,7 @@ This is a comment Writes this to the specified . A task that represents the asynchronous write operation. 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 . + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.Xml.Linq/XDocument.xml b/xml/System.Xml.Linq/XDocument.xml index 36f829210bc..36ec59c31b6 100644 --- a/xml/System.Xml.Linq/XDocument.xml +++ b/xml/System.Xml.Linq/XDocument.xml @@ -1834,6 +1834,7 @@ This method stores in the task it returns all non-usage exceptions that the meth ]]> + The cancellation token was canceled. This exception is stored into the returned task. @@ -1886,6 +1887,7 @@ This method stores in the task it returns all non-usage exceptions that the meth ]]> + The cancellation token was canceled. This exception is stored into the returned task. @@ -1928,6 +1930,7 @@ This method stores in the task it returns all non-usage exceptions that the meth Creates a new containing the contents of the specified . A new XDocument containing the contents of the specified . 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 . + The cancellation token was canceled. This exception is stored into the returned task. @@ -3048,6 +3051,7 @@ Console.WriteLine(File.ReadAllText("Root2.xml")) Writes this to an . A task representing the asynchronous save operation. 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 . + The cancellation token was canceled. This exception is stored into the returned task. @@ -3100,6 +3104,7 @@ This method stores in the task it returns all non-usage exceptions that the meth ]]> + The cancellation token was canceled. This exception is stored into the returned task. @@ -3152,6 +3157,7 @@ This method stores in the task it returns all non-usage exceptions that the meth ]]> + The cancellation token was canceled. This exception is stored into the returned task. @@ -3287,6 +3293,7 @@ Console.WriteLine(sb.ToString()) Writes this XDocument's underlying XML tree to the specified . A task representing the asynchronous write operation. 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 . + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.Xml.Linq/XDocumentType.xml b/xml/System.Xml.Linq/XDocumentType.xml index a606b149e3b..d14a7c13cbf 100644 --- a/xml/System.Xml.Linq/XDocumentType.xml +++ b/xml/System.Xml.Linq/XDocumentType.xml @@ -968,6 +968,7 @@ SystemId:Pubs.dtd Writes this to the specified . A task representing the asynchronous write operation. 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 . + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.Xml.Linq/XElement.xml b/xml/System.Xml.Linq/XElement.xml index f0e4db72abb..ccfbf639157 100644 --- a/xml/System.Xml.Linq/XElement.xml +++ b/xml/System.Xml.Linq/XElement.xml @@ -3962,6 +3962,7 @@ This method stores in the task it returns all non-usage exceptions that the meth ]]> + The cancellation token was canceled. This exception is stored into the returned task. @@ -4014,6 +4015,7 @@ This method stores in the task it returns all non-usage exceptions that the meth ]]> + The cancellation token was canceled. This exception is stored into the returned task. @@ -4056,6 +4058,7 @@ This method stores in the task it returns all non-usage exceptions that the meth Asynchronously creates a new and initializes its underlying XML tree using the specified XML reader, optionally preserving white space. A new containing the contents of the specified reader. 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 . + The cancellation token was canceled. This exception is stored into the returned task. @@ -8163,6 +8166,7 @@ Console.WriteLine(str) Asynchronously outputs this to an . A task representing the asynchronous save operation. 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 . + The cancellation token was canceled. This exception is stored into the returned task. @@ -8205,6 +8209,7 @@ Console.WriteLine(str) Asynchronously outputs this to a . A task representing the asynchronous save operation. 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 . + The cancellation token was canceled. This exception is stored into the returned task. @@ -8247,6 +8252,7 @@ Console.WriteLine(str) Asynchronously outputs this to a . A task representing the asynchronous save operation. 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 . + The cancellation token was canceled. This exception is stored into the returned task. @@ -8977,6 +8983,7 @@ Console.WriteLine(sb.ToString()) Asynchronously writes this to the specified writer. A task representing the asynchronous write operation. 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 . + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.Xml.Linq/XNode.xml b/xml/System.Xml.Linq/XNode.xml index e808a313715..e0be9020692 100644 --- a/xml/System.Xml.Linq/XNode.xml +++ b/xml/System.Xml.Linq/XNode.xml @@ -2920,6 +2920,7 @@ ccc An XNode that contains the nodes read from the reader. 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 . The is not positioned on a recognized node type. + The cancellation token was canceled. This exception is stored into the returned task. @@ -3656,6 +3657,7 @@ Console.WriteLine(sb.ToString()) Writes the current node to an . A task representing the asynchronous write operation. 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 . + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.Xml.Linq/XProcessingInstruction.xml b/xml/System.Xml.Linq/XProcessingInstruction.xml index 19ae9218998..44eba642160 100644 --- a/xml/System.Xml.Linq/XProcessingInstruction.xml +++ b/xml/System.Xml.Linq/XProcessingInstruction.xml @@ -508,6 +508,7 @@ xml-stylesheet Writes this to the specified . A task representing the asynchronous write operation. 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 . + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.Xml.Linq/XText.xml b/xml/System.Xml.Linq/XText.xml index a2f03c90b72..6217b918040 100644 --- a/xml/System.Xml.Linq/XText.xml +++ b/xml/System.Xml.Linq/XText.xml @@ -493,6 +493,7 @@ Newer text Asynchronously writes this to the specified . A task representing the asynchronous write operation. 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 . + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System/BinaryData.xml b/xml/System/BinaryData.xml index 1aaa07f98fb..d655639bdb9 100644 --- a/xml/System/BinaryData.xml +++ b/xml/System/BinaryData.xml @@ -1,1173 +1,1175 @@ - - - - - - - - - System.Memory.Data - 1.0.1.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - System.Object - - - - - [System.Text.Json.Serialization.JsonConverter(typeof(System.BinaryDataConverter))] - [<System.Text.Json.Serialization.JsonConverter(typeof(System.BinaryDataConverter))>] - - - [System.Runtime.CompilerServices.Nullable(0)] - [<System.Runtime.CompilerServices.Nullable(0)>] - - - [System.Runtime.CompilerServices.NullableContext(1)] - [<System.Runtime.CompilerServices.NullableContext(1)>] - - - [System.Text.Json.Serialization.JsonConverter(typeof(System.Text.Json.Serialization.BinaryDataJsonConverter))] - [<System.Text.Json.Serialization.JsonConverter(typeof(System.Text.Json.Serialization.BinaryDataJsonConverter))>] - - - - A lightweight abstraction for a payload of bytes that supports converting between string, stream, JSON, and bytes. - To be added. - - - - - - - - - - Constructor - - System.Memory.Data - 1.0.1.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - - - - The byte array to wrap. - Creates a instance by wrapping the provided byte array. - To be added. - - - - - - - - - - Constructor - - System.Memory.Data - 1.0.1.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - - [System.Runtime.CompilerServices.NullableContext(0)] - [<System.Runtime.CompilerServices.NullableContext(0)>] - - - - - - - The byte data to wrap. - Creates a instance by wrapping the provided bytes. - To be added. - - - - - - - - - - Constructor - - System.Memory.Data - 1.0.1.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - - - - The string data. - Creates a instance from a string by converting the string to bytes using the UTF-8 encoding. - To be added. - - - - - - - - - - Constructor - - System.Memory.Data - 8.0.0.0 - - - - - - - [System.Runtime.CompilerServices.Nullable(2)] - [<System.Runtime.CompilerServices.Nullable(2)>] - - - - - - To be added. - To be added. - To be added. - To be added. - - - - - - - - - - Constructor - - System.Memory.Data - 8.0.0.0 - - - - [System.Runtime.CompilerServices.NullableContext(0)] - [<System.Runtime.CompilerServices.NullableContext(0)>] - - - - - - - - [System.Runtime.CompilerServices.Nullable(2)] - [<System.Runtime.CompilerServices.Nullable(2)>] - - - - - - To be added. - To be added. - To be added. - To be added. - - - - - - - - - - Constructor - - System.Memory.Data - 8.0.0.0 - - - - - - - [System.Runtime.CompilerServices.Nullable(2)] - [<System.Runtime.CompilerServices.Nullable(2)>] - - - - - - To be added. - To be added. - To be added. - To be added. - - - - - - - - - Constructor - - System.Memory.Data - 1.0.1.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - - [System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("JSON serialization and deserialization might require types that cannot be statically analyzed.")] - [<System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("JSON serialization and deserialization might require types that cannot be statically analyzed.")>] - - - [System.Diagnostics.CodeAnalysis.RequiresDynamicCode("JSON serialization and deserialization might require types that cannot be statically analyzed and might need runtime code generation.")] - [<System.Diagnostics.CodeAnalysis.RequiresDynamicCode("JSON serialization and deserialization might require types that cannot be statically analyzed and might need runtime code generation.")>] - - - [System.Runtime.CompilerServices.NullableContext(2)] - [<System.Runtime.CompilerServices.NullableContext(2)>] - - - - - - - - - The object to serialize to JSON using . - The options to use when serializing to JSON. - The type to use when serializing the data. If not specified, will be used to determine the type. - Creates a instance by serializing the provided object to JSON using . - To be added. - - - - - - - - - Constructor - - System.Memory.Data - 7.0.0.0 - 8.0.0.0 - - - - [System.Runtime.CompilerServices.NullableContext(2)] - [<System.Runtime.CompilerServices.NullableContext(2)>] - - - - - - - - [System.Runtime.CompilerServices.Nullable(1)] - [<System.Runtime.CompilerServices.Nullable(1)>] - - - - - - - The object that will be serialized to JSON using . - The to use when serializing to JSON. - The type to use when serializing the data. If not specified, will be used to determine the type. - Creates a instance by serializing the provided object to JSON using . - To be added. - - - - - - - - - - Property - - System.Memory.Data - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - System.BinaryData - - - Returns an empty . - To be added. - To be added. - - - - - - - - - - Method - - System.Memory.Data - 1.0.1.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - - [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>] - - - [System.Runtime.CompilerServices.NullableContext(2)] - [<System.Runtime.CompilerServices.NullableContext(2)>] - - - - System.Boolean - - - - - - [System.Diagnostics.CodeAnalysis.NotNullWhen(true)] - [<System.Diagnostics.CodeAnalysis.NotNullWhen(true)>] - - - - - - The object to compare with the current object. - Determines whether the specified object is equal to the current object. - - if the specified object is equal to the current object; otherwise, . - To be added. - - - - - - - - - - Method - - System.Memory.Data - 1.0.1.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - System.BinaryData - - - - - - The byte array to wrap. - Creates a instance by wrapping the provided byte array. - A wrapper over . - To be added. - - - - - - - - - - Method - - System.Memory.Data - 1.0.1.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - - [System.Runtime.CompilerServices.NullableContext(0)] - [<System.Runtime.CompilerServices.NullableContext(0)>] - - - - System.BinaryData - - - - - - The byte data to wrap. - Creates a instance by wrapping the provided . - A wrapper over . - To be added. - - - - - - - - - - Method - - System.Memory.Data - 8.0.0.0 - - - System.BinaryData - - - - - - - [System.Runtime.CompilerServices.Nullable(2)] - [<System.Runtime.CompilerServices.Nullable(2)>] - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - - - - - - - - Method - - System.Memory.Data - 8.0.0.0 - - - - [System.Runtime.CompilerServices.NullableContext(0)] - [<System.Runtime.CompilerServices.NullableContext(0)>] - - - - System.BinaryData - - - [System.Runtime.CompilerServices.Nullable(1)] - [<System.Runtime.CompilerServices.Nullable(1)>] - - - - - - - - - [System.Runtime.CompilerServices.Nullable(2)] - [<System.Runtime.CompilerServices.Nullable(2)>] - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - - - - - - - Method - - System.Memory.Data - 1.0.1.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - - [System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("JSON serialization and deserialization might require types that cannot be statically analyzed.")] - [<System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("JSON serialization and deserialization might require types that cannot be statically analyzed.")>] - - - [System.Diagnostics.CodeAnalysis.RequiresDynamicCode("JSON serialization and deserialization might require types that cannot be statically analyzed and might need runtime code generation.")] - [<System.Diagnostics.CodeAnalysis.RequiresDynamicCode("JSON serialization and deserialization might require types that cannot be statically analyzed and might need runtime code generation.")>] - - - - System.BinaryData - - - - - - [System.Runtime.CompilerServices.Nullable(2)] - [<System.Runtime.CompilerServices.Nullable(2)>] - - - - - - - - - - [System.Runtime.CompilerServices.Nullable(2)] - [<System.Runtime.CompilerServices.Nullable(2)>] - - - - - - The type to use when serializing the data. - The data to use. - The options to use when serializing to JSON. - Creates a instance by serializing the provided object using the . - A value representing the UTF-8 encoding of the JSON representation of . - To be added. - - - - - - - - - - Method - - System.Memory.Data - 7.0.0.0 - 8.0.0.0 - - - System.BinaryData - - - - - - [System.Runtime.CompilerServices.Nullable(2)] - [<System.Runtime.CompilerServices.Nullable(2)>] - - - - - - - - - - The type to use when serializing the data. - The data to use. - The to use when serializing to JSON. - Creates a instance by serializing the provided object using the . - A value representing the UTF-8 encoding of the JSON representation of . - To be added. - - - - - - - - - - Method - - System.Memory.Data - 1.0.1.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - System.BinaryData - - - - - - The stream containing the data. - Creates a instance from the specified stream. The stream is not disposed by this method. - A value representing all of the data remaining in . - To be added. - - - - - - - - - - Method - - System.Memory.Data - 8.0.0.0 - - - System.BinaryData - - - - - - - [System.Runtime.CompilerServices.Nullable(2)] - [<System.Runtime.CompilerServices.Nullable(2)>] - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - - - - - - - Method - - System.Memory.Data - 1.0.1.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - System.Threading.Tasks.Task<System.BinaryData> - - - - - - - The stream containing the data. - A token that may be used to cancel the operation. - Creates a instance from the specified stream. The stream is not disposed by this method. - A value representing all of the data remaining in . - 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 . - - - - - - - - - Method - - System.Memory.Data - 8.0.0.0 - - - System.Threading.Tasks.Task<System.BinaryData> - - - - - - - [System.Runtime.CompilerServices.Nullable(2)] - [<System.Runtime.CompilerServices.Nullable(2)>] - - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - - - - - - - - Method - - System.Memory.Data - 1.0.1.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - System.BinaryData - - - - - - The string data. - Creates a instance from a string by converting the string to bytes using the UTF-8 encoding. - A value representing the UTF-8 encoding of . - To be added. - - - - - - - - - - Method - - System.Memory.Data - 8.0.0.0 - - - System.BinaryData - - - - - - - [System.Runtime.CompilerServices.Nullable(2)] - [<System.Runtime.CompilerServices.Nullable(2)>] - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - - - - - - - - Method - - System.Memory.Data - 1.0.1.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - - [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>] - - - - System.Int32 - - - - Returns the hash code for the current object. - A 32-bit signed integer hash code. - To be added. - - - - - - - - - - - Property - - System.Memory.Data - 8.0.0.0 - - - System.Boolean - - - Gets a value that indicates whether this data is empty. - - if the data is empty (that is, its is 0); otherwise, . - To be added. - - - - - - - - - - Property - - System.Memory.Data - 8.0.0.0 - - - System.Int32 - - - Gets the number of bytes of this data. - The number of bytes of this data. - To be added. - - - - - - - - - - Property - - System.Memory.Data - 8.0.0.0 - - - - [System.Runtime.CompilerServices.Nullable(2)] - [<System.Runtime.CompilerServices.Nullable(2)>] - - - [get: System.Runtime.CompilerServices.NullableContext(2)] - [<get: System.Runtime.CompilerServices.NullableContext(2)>] - - - - System.String - - - To be added. - To be added. - To be added. - - - - - - - - - - Method - - System.Memory.Data - 1.0.1.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - - [System.Runtime.CompilerServices.NullableContext(0)] - [<System.Runtime.CompilerServices.NullableContext(0)>] - - - - System.ReadOnlyMemory<System.Byte> - - - - - - [System.Runtime.CompilerServices.Nullable(2)] - [<System.Runtime.CompilerServices.Nullable(2)>] - - - - - - The value to be converted. - Defines an implicit conversion from a to a . - A read-only memory of bytes representing the implicitly converted . - To be added. - - - - - - - - - - Method - - System.Memory.Data - 1.0.1.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - - [System.Runtime.CompilerServices.NullableContext(0)] - [<System.Runtime.CompilerServices.NullableContext(0)>] - - - - System.ReadOnlySpan<System.Byte> - - - - - - [System.Runtime.CompilerServices.Nullable(2)] - [<System.Runtime.CompilerServices.Nullable(2)>] - - - - - - The value to be converted. - Defines an implicit conversion from a to a . - A read-only span of bytes representing the implicitly converted . - To be added. - - - - - - - - - - Method - - System.Memory.Data - 1.0.1.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - System.Byte[] - - - - Converts the to a byte array. - A byte array representing the data. - To be added. - - - - - - - - - - Method - - System.Memory.Data - 1.0.1.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - - [System.Runtime.CompilerServices.NullableContext(0)] - [<System.Runtime.CompilerServices.NullableContext(0)>] - - - - System.ReadOnlyMemory<System.Byte> - - - - Gets the value of this instance as bytes without any further interpretation. - The value of this instance as bytes without any further interpretation. - To be added. - - - - - - - - - - Method - - System.Memory.Data - 1.0.1.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - - [System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("JSON serialization and deserialization might require types that cannot be statically analyzed.")] - [<System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("JSON serialization and deserialization might require types that cannot be statically analyzed.")>] - - - [System.Diagnostics.CodeAnalysis.RequiresDynamicCode("JSON serialization and deserialization might require types that cannot be statically analyzed and might need runtime code generation.")] - [<System.Diagnostics.CodeAnalysis.RequiresDynamicCode("JSON serialization and deserialization might require types that cannot be statically analyzed and might need runtime code generation.")>] - - - [System.Runtime.CompilerServices.NullableContext(2)] - [<System.Runtime.CompilerServices.NullableContext(2)>] - - - - T - - - - - - - - - The type that the data should be converted to. - The to use when serializing to JSON. - Converts the to the specified type using . - The data converted to the specified type. - To be added. - - - - - - - - - - Method - - System.Memory.Data - 7.0.0.0 - 8.0.0.0 - - - - [System.Runtime.CompilerServices.NullableContext(2)] - [<System.Runtime.CompilerServices.NullableContext(2)>] - - - - T - - - - - - - - - [System.Runtime.CompilerServices.Nullable(1)] - [<System.Runtime.CompilerServices.Nullable(1)>] - - - - - - The type that the data should be converted to. - The to use when serializing to JSON. - Converts the to the specified type using . - The data converted to the specified type. - To be added. - - - - - - - - - - Method - - System.Memory.Data - 1.0.1.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - System.IO.Stream - - - - Converts the to a read-only stream. - A stream representing the data. - To be added. - - - - - - - - - - Method - - System.Memory.Data - 1.0.1.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - - - System.String - - - - Converts the value of this instance to a string using UTF-8. - A string representation of the value of this instance. - + + + + + + + + + System.Memory.Data + 1.0.1.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + System.Object + + + + + [System.Text.Json.Serialization.JsonConverter(typeof(System.BinaryDataConverter))] + [<System.Text.Json.Serialization.JsonConverter(typeof(System.BinaryDataConverter))>] + + + [System.Runtime.CompilerServices.Nullable(0)] + [<System.Runtime.CompilerServices.Nullable(0)>] + + + [System.Runtime.CompilerServices.NullableContext(1)] + [<System.Runtime.CompilerServices.NullableContext(1)>] + + + [System.Text.Json.Serialization.JsonConverter(typeof(System.Text.Json.Serialization.BinaryDataJsonConverter))] + [<System.Text.Json.Serialization.JsonConverter(typeof(System.Text.Json.Serialization.BinaryDataJsonConverter))>] + + + + A lightweight abstraction for a payload of bytes that supports converting between string, stream, JSON, and bytes. + To be added. + + + + + + + + + + Constructor + + System.Memory.Data + 1.0.1.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + + + + The byte array to wrap. + Creates a instance by wrapping the provided byte array. + To be added. + + + + + + + + + + Constructor + + System.Memory.Data + 1.0.1.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + + [System.Runtime.CompilerServices.NullableContext(0)] + [<System.Runtime.CompilerServices.NullableContext(0)>] + + + + + + + The byte data to wrap. + Creates a instance by wrapping the provided bytes. + To be added. + + + + + + + + + + Constructor + + System.Memory.Data + 1.0.1.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + + + + The string data. + Creates a instance from a string by converting the string to bytes using the UTF-8 encoding. + To be added. + + + + + + + + + + Constructor + + System.Memory.Data + 8.0.0.0 + + + + + + + [System.Runtime.CompilerServices.Nullable(2)] + [<System.Runtime.CompilerServices.Nullable(2)>] + + + + + + To be added. + To be added. + To be added. + To be added. + + + + + + + + + + Constructor + + System.Memory.Data + 8.0.0.0 + + + + [System.Runtime.CompilerServices.NullableContext(0)] + [<System.Runtime.CompilerServices.NullableContext(0)>] + + + + + + + + [System.Runtime.CompilerServices.Nullable(2)] + [<System.Runtime.CompilerServices.Nullable(2)>] + + + + + + To be added. + To be added. + To be added. + To be added. + + + + + + + + + + Constructor + + System.Memory.Data + 8.0.0.0 + + + + + + + [System.Runtime.CompilerServices.Nullable(2)] + [<System.Runtime.CompilerServices.Nullable(2)>] + + + + + + To be added. + To be added. + To be added. + To be added. + + + + + + + + + Constructor + + System.Memory.Data + 1.0.1.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + + [System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("JSON serialization and deserialization might require types that cannot be statically analyzed.")] + [<System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("JSON serialization and deserialization might require types that cannot be statically analyzed.")>] + + + [System.Diagnostics.CodeAnalysis.RequiresDynamicCode("JSON serialization and deserialization might require types that cannot be statically analyzed and might need runtime code generation.")] + [<System.Diagnostics.CodeAnalysis.RequiresDynamicCode("JSON serialization and deserialization might require types that cannot be statically analyzed and might need runtime code generation.")>] + + + [System.Runtime.CompilerServices.NullableContext(2)] + [<System.Runtime.CompilerServices.NullableContext(2)>] + + + + + + + + + The object to serialize to JSON using . + The options to use when serializing to JSON. + The type to use when serializing the data. If not specified, will be used to determine the type. + Creates a instance by serializing the provided object to JSON using . + To be added. + + + + + + + + + Constructor + + System.Memory.Data + 7.0.0.0 + 8.0.0.0 + + + + [System.Runtime.CompilerServices.NullableContext(2)] + [<System.Runtime.CompilerServices.NullableContext(2)>] + + + + + + + + [System.Runtime.CompilerServices.Nullable(1)] + [<System.Runtime.CompilerServices.Nullable(1)>] + + + + + + + The object that will be serialized to JSON using . + The to use when serializing to JSON. + The type to use when serializing the data. If not specified, will be used to determine the type. + Creates a instance by serializing the provided object to JSON using . + To be added. + + + + + + + + + + Property + + System.Memory.Data + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + System.BinaryData + + + Returns an empty . + To be added. + To be added. + + + + + + + + + + Method + + System.Memory.Data + 1.0.1.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + + [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>] + + + [System.Runtime.CompilerServices.NullableContext(2)] + [<System.Runtime.CompilerServices.NullableContext(2)>] + + + + System.Boolean + + + + + + [System.Diagnostics.CodeAnalysis.NotNullWhen(true)] + [<System.Diagnostics.CodeAnalysis.NotNullWhen(true)>] + + + + + + The object to compare with the current object. + Determines whether the specified object is equal to the current object. + + if the specified object is equal to the current object; otherwise, . + To be added. + + + + + + + + + + Method + + System.Memory.Data + 1.0.1.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + System.BinaryData + + + + + + The byte array to wrap. + Creates a instance by wrapping the provided byte array. + A wrapper over . + To be added. + + + + + + + + + + Method + + System.Memory.Data + 1.0.1.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + + [System.Runtime.CompilerServices.NullableContext(0)] + [<System.Runtime.CompilerServices.NullableContext(0)>] + + + + System.BinaryData + + + + + + The byte data to wrap. + Creates a instance by wrapping the provided . + A wrapper over . + To be added. + + + + + + + + + + Method + + System.Memory.Data + 8.0.0.0 + + + System.BinaryData + + + + + + + [System.Runtime.CompilerServices.Nullable(2)] + [<System.Runtime.CompilerServices.Nullable(2)>] + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + + + + + + + + + + Method + + System.Memory.Data + 8.0.0.0 + + + + [System.Runtime.CompilerServices.NullableContext(0)] + [<System.Runtime.CompilerServices.NullableContext(0)>] + + + + System.BinaryData + + + [System.Runtime.CompilerServices.Nullable(1)] + [<System.Runtime.CompilerServices.Nullable(1)>] + + + + + + + + + [System.Runtime.CompilerServices.Nullable(2)] + [<System.Runtime.CompilerServices.Nullable(2)>] + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + + + + + + + + + Method + + System.Memory.Data + 1.0.1.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + + [System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("JSON serialization and deserialization might require types that cannot be statically analyzed.")] + [<System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("JSON serialization and deserialization might require types that cannot be statically analyzed.")>] + + + [System.Diagnostics.CodeAnalysis.RequiresDynamicCode("JSON serialization and deserialization might require types that cannot be statically analyzed and might need runtime code generation.")] + [<System.Diagnostics.CodeAnalysis.RequiresDynamicCode("JSON serialization and deserialization might require types that cannot be statically analyzed and might need runtime code generation.")>] + + + + System.BinaryData + + + + + + [System.Runtime.CompilerServices.Nullable(2)] + [<System.Runtime.CompilerServices.Nullable(2)>] + + + + + + + + + + [System.Runtime.CompilerServices.Nullable(2)] + [<System.Runtime.CompilerServices.Nullable(2)>] + + + + + + The type to use when serializing the data. + The data to use. + The options to use when serializing to JSON. + Creates a instance by serializing the provided object using the . + A value representing the UTF-8 encoding of the JSON representation of . + To be added. + + + + + + + + + + Method + + System.Memory.Data + 7.0.0.0 + 8.0.0.0 + + + System.BinaryData + + + + + + [System.Runtime.CompilerServices.Nullable(2)] + [<System.Runtime.CompilerServices.Nullable(2)>] + + + + + + + + + + The type to use when serializing the data. + The data to use. + The to use when serializing to JSON. + Creates a instance by serializing the provided object using the . + A value representing the UTF-8 encoding of the JSON representation of . + To be added. + + + + + + + + + + Method + + System.Memory.Data + 1.0.1.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + System.BinaryData + + + + + + The stream containing the data. + Creates a instance from the specified stream. The stream is not disposed by this method. + A value representing all of the data remaining in . + To be added. + + + + + + + + + + Method + + System.Memory.Data + 8.0.0.0 + + + System.BinaryData + + + + + + + [System.Runtime.CompilerServices.Nullable(2)] + [<System.Runtime.CompilerServices.Nullable(2)>] + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + + + + + + + + + Method + + System.Memory.Data + 1.0.1.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + System.Threading.Tasks.Task<System.BinaryData> + + + + + + + The stream containing the data. + A token that may be used to cancel the operation. + Creates a instance from the specified stream. The stream is not disposed by this method. + A value representing all of the data remaining in . + 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 . + The cancellation token was canceled. This exception is stored into the returned task. + + + + + + + + + Method + + System.Memory.Data + 8.0.0.0 + + + System.Threading.Tasks.Task<System.BinaryData> + + + + + + + [System.Runtime.CompilerServices.Nullable(2)] + [<System.Runtime.CompilerServices.Nullable(2)>] + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + To be added. + The cancellation token was canceled. This exception is stored into the returned task. + + + + + + + + + + Method + + System.Memory.Data + 1.0.1.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + System.BinaryData + + + + + + The string data. + Creates a instance from a string by converting the string to bytes using the UTF-8 encoding. + A value representing the UTF-8 encoding of . + To be added. + + + + + + + + + + Method + + System.Memory.Data + 8.0.0.0 + + + System.BinaryData + + + + + + + [System.Runtime.CompilerServices.Nullable(2)] + [<System.Runtime.CompilerServices.Nullable(2)>] + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + + + + + + + + + + Method + + System.Memory.Data + 1.0.1.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + + [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>] + + + + System.Int32 + + + + Returns the hash code for the current object. + A 32-bit signed integer hash code. + To be added. + + + + + + + + + + + Property + + System.Memory.Data + 8.0.0.0 + + + System.Boolean + + + Gets a value that indicates whether this data is empty. + + if the data is empty (that is, its is 0); otherwise, . + To be added. + + + + + + + + + + Property + + System.Memory.Data + 8.0.0.0 + + + System.Int32 + + + Gets the number of bytes of this data. + The number of bytes of this data. + To be added. + + + + + + + + + + Property + + System.Memory.Data + 8.0.0.0 + + + + [System.Runtime.CompilerServices.Nullable(2)] + [<System.Runtime.CompilerServices.Nullable(2)>] + + + [get: System.Runtime.CompilerServices.NullableContext(2)] + [<get: System.Runtime.CompilerServices.NullableContext(2)>] + + + + System.String + + + To be added. + To be added. + To be added. + + + + + + + + + + Method + + System.Memory.Data + 1.0.1.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + + [System.Runtime.CompilerServices.NullableContext(0)] + [<System.Runtime.CompilerServices.NullableContext(0)>] + + + + System.ReadOnlyMemory<System.Byte> + + + + + + [System.Runtime.CompilerServices.Nullable(2)] + [<System.Runtime.CompilerServices.Nullable(2)>] + + + + + + The value to be converted. + Defines an implicit conversion from a to a . + A read-only memory of bytes representing the implicitly converted . + To be added. + + + + + + + + + + Method + + System.Memory.Data + 1.0.1.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + + [System.Runtime.CompilerServices.NullableContext(0)] + [<System.Runtime.CompilerServices.NullableContext(0)>] + + + + System.ReadOnlySpan<System.Byte> + + + + + + [System.Runtime.CompilerServices.Nullable(2)] + [<System.Runtime.CompilerServices.Nullable(2)>] + + + + + + The value to be converted. + Defines an implicit conversion from a to a . + A read-only span of bytes representing the implicitly converted . + To be added. + + + + + + + + + + Method + + System.Memory.Data + 1.0.1.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + System.Byte[] + + + + Converts the to a byte array. + A byte array representing the data. + To be added. + + + + + + + + + + Method + + System.Memory.Data + 1.0.1.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + + [System.Runtime.CompilerServices.NullableContext(0)] + [<System.Runtime.CompilerServices.NullableContext(0)>] + + + + System.ReadOnlyMemory<System.Byte> + + + + Gets the value of this instance as bytes without any further interpretation. + The value of this instance as bytes without any further interpretation. + To be added. + + + + + + + + + + Method + + System.Memory.Data + 1.0.1.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + + [System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("JSON serialization and deserialization might require types that cannot be statically analyzed.")] + [<System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("JSON serialization and deserialization might require types that cannot be statically analyzed.")>] + + + [System.Diagnostics.CodeAnalysis.RequiresDynamicCode("JSON serialization and deserialization might require types that cannot be statically analyzed and might need runtime code generation.")] + [<System.Diagnostics.CodeAnalysis.RequiresDynamicCode("JSON serialization and deserialization might require types that cannot be statically analyzed and might need runtime code generation.")>] + + + [System.Runtime.CompilerServices.NullableContext(2)] + [<System.Runtime.CompilerServices.NullableContext(2)>] + + + + T + + + + + + + + + The type that the data should be converted to. + The to use when serializing to JSON. + Converts the to the specified type using . + The data converted to the specified type. + To be added. + + + + + + + + + + Method + + System.Memory.Data + 7.0.0.0 + 8.0.0.0 + + + + [System.Runtime.CompilerServices.NullableContext(2)] + [<System.Runtime.CompilerServices.NullableContext(2)>] + + + + T + + + + + + + + + [System.Runtime.CompilerServices.Nullable(1)] + [<System.Runtime.CompilerServices.Nullable(1)>] + + + + + + The type that the data should be converted to. + The to use when serializing to JSON. + Converts the to the specified type using . + The data converted to the specified type. + To be added. + + + + + + + + + + Method + + System.Memory.Data + 1.0.1.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + System.IO.Stream + + + + Converts the to a read-only stream. + A stream representing the data. + To be added. + + + + + + + + + + Method + + System.Memory.Data + 1.0.1.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + + + System.String + + + + Converts the value of this instance to a string using UTF-8. + A string representation of the value of this instance. + - - - - - - - - - - - Method - - System.Memory.Data - 8.0.0.0 - - - System.BinaryData - - - - - - [System.Runtime.CompilerServices.Nullable(2)] - [<System.Runtime.CompilerServices.Nullable(2)>] - - - - - - To be added. - To be added. - To be added. - To be added. - - - - + ]]> + + + + + + + + + + + Method + + System.Memory.Data + 8.0.0.0 + + + System.BinaryData + + + + + + [System.Runtime.CompilerServices.Nullable(2)] + [<System.Runtime.CompilerServices.Nullable(2)>] + + + + + + To be added. + To be added. + To be added. + To be added. + + + +