diff --git a/xml/Microsoft.Extensions.Caching.Distributed/DistributedCacheExtensions.xml b/xml/Microsoft.Extensions.Caching.Distributed/DistributedCacheExtensions.xml index 5fdc69c0277..8a4719cc0ac 100644 --- a/xml/Microsoft.Extensions.Caching.Distributed/DistributedCacheExtensions.xml +++ b/xml/Microsoft.Extensions.Caching.Distributed/DistributedCacheExtensions.xml @@ -89,7 +89,7 @@ The key to get the stored data for. Asynchronously gets a string from the specified cache with the specified key. A task that gets the string value from the stored cache key. - 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 . @@ -131,7 +131,7 @@ Optional. A to cancel the operation. Asynchronously gets a string from the specified cache with the specified key. A task that gets the string value from the stored cache key. - 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 . @@ -200,7 +200,7 @@ The data to store in the cache. Asynchronously sets a sequence of bytes in the specified cache with the specified key. A task that represents the asynchronous set operation. - 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 . or is null. @@ -239,7 +239,7 @@ Optional. A to cancel the operation. Asynchronously sets a sequence of bytes in the specified cache with the specified key. A task that represents the asynchronous set operation. - 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 . or is null. @@ -351,7 +351,7 @@ The data to store in the cache. Asynchronously sets a string in the specified cache with the specified key. A task that represents the asynchronous set operation. - 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 . or is null. @@ -385,7 +385,7 @@ The cache options for the entry. Asynchronously sets a string in the specified cache with the specified key. A task that represents the asynchronous set operation. - 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 . or is null. @@ -424,7 +424,7 @@ Optional. A to cancel the operation. Asynchronously sets a string in the specified cache with the specified key. A task that represents the asynchronous set operation. - 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 . or is null. @@ -465,7 +465,7 @@ Optional. A to cancel the operation. Asynchronously sets a string in the specified cache with the specified key. A task that represents the asynchronous set operation. - 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 . or is null. diff --git a/xml/Microsoft.Extensions.Caching.Distributed/IDistributedCache.xml b/xml/Microsoft.Extensions.Caching.Distributed/IDistributedCache.xml index 5eff7dea422..2eda84248d1 100644 --- a/xml/Microsoft.Extensions.Caching.Distributed/IDistributedCache.xml +++ b/xml/Microsoft.Extensions.Caching.Distributed/IDistributedCache.xml @@ -82,7 +82,7 @@ To be added. To be added. 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 . @@ -116,7 +116,7 @@ Optional. The used to propagate notifications that the operation should be canceled. Gets a value with the given key. The that represents the asynchronous operation, containing the located value or null. - 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 . @@ -175,7 +175,7 @@ To be added. To be added. 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 . @@ -208,7 +208,7 @@ Optional. The used to propagate notifications that the operation should be canceled. Refreshes a value in the cache based on its key, resetting its sliding expiration timeout (if any). The that represents the asynchronous operation. - 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 . @@ -267,7 +267,7 @@ To be added. To be added. 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 . @@ -300,7 +300,7 @@ Optional. The used to propagate notifications that the operation should be canceled. Removes the value with the given key. The that represents the asynchronous operation. - 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 . @@ -367,7 +367,7 @@ To be added. To be added. 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 . @@ -404,7 +404,7 @@ Optional. The used to propagate notifications that the operation should be canceled. Sets the value with the given key. The that represents the asynchronous operation. - 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 . diff --git a/xml/Microsoft.Extensions.Caching.Distributed/MemoryDistributedCache.xml b/xml/Microsoft.Extensions.Caching.Distributed/MemoryDistributedCache.xml index 8dc7748e521..222609a8eba 100644 --- a/xml/Microsoft.Extensions.Caching.Distributed/MemoryDistributedCache.xml +++ b/xml/Microsoft.Extensions.Caching.Distributed/MemoryDistributedCache.xml @@ -172,7 +172,7 @@ To be added. To be added. 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 . @@ -209,7 +209,7 @@ Optional. The used to propagate notifications that the operation should be canceled. Gets a value with the given key. The that represents the asynchronous operation, containing the located value or . - 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 . @@ -274,7 +274,7 @@ To be added. To be added. 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 . @@ -310,7 +310,7 @@ Optional. The used to propagate notifications that the operation should be canceled. Refreshes a value in the cache based on its key, resetting its sliding expiration timeout (if any). The that represents the asynchronous operation. - 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 . @@ -375,7 +375,7 @@ To be added. To be added. 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 . @@ -411,7 +411,7 @@ Optional. The used to propagate notifications that the operation should be canceled. Removes the value with the given key. The that represents the asynchronous operation. - 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 . @@ -484,7 +484,7 @@ To be added. To be added. 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 . @@ -524,7 +524,7 @@ Optional. The used to propagate notifications that the operation should be canceled. Sets the value with the given key. The that represents the asynchronous operation. - 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 . diff --git a/xml/Microsoft.Extensions.Caching.Redis/RedisCache.xml b/xml/Microsoft.Extensions.Caching.Redis/RedisCache.xml index bfb9c7b8ff2..f03fc5b692e 100644 --- a/xml/Microsoft.Extensions.Caching.Redis/RedisCache.xml +++ b/xml/Microsoft.Extensions.Caching.Redis/RedisCache.xml @@ -140,7 +140,7 @@ To be added. To be added. 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 . @@ -171,7 +171,7 @@ Optional. The used to propagate notifications that the operation should be canceled. Gets a value with the given key. The that represents the asynchronous operation, containing the located value or . - 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 . @@ -231,7 +231,7 @@ To be added. To be added. 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 . @@ -262,7 +262,7 @@ Optional. The used to propagate notifications that the operation should be canceled. Refreshes a value in the cache based on its key, resetting its sliding expiration timeout (if any). The that represents the asynchronous operation. - 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 . @@ -322,7 +322,7 @@ To be added. To be added. 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 . @@ -353,7 +353,7 @@ Optional. The used to propagate notifications that the operation should be canceled. Removes the value with the given key. The that represents the asynchronous operation. - 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 . @@ -421,7 +421,7 @@ To be added. To be added. 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 . @@ -456,7 +456,7 @@ Optional. The used to propagate notifications that the operation should be canceled. Sets the value with the given key. The that represents the asynchronous operation. - 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 . diff --git a/xml/Microsoft.Extensions.Caching.SqlServer/SqlServerCache.xml b/xml/Microsoft.Extensions.Caching.SqlServer/SqlServerCache.xml index f473379ab84..d54b0b0a2f3 100644 --- a/xml/Microsoft.Extensions.Caching.SqlServer/SqlServerCache.xml +++ b/xml/Microsoft.Extensions.Caching.SqlServer/SqlServerCache.xml @@ -115,7 +115,7 @@ To be added. To be added. 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 . @@ -148,7 +148,7 @@ Optional. The used to propagate notifications that the operation should be canceled. Gets a value with the given key. The that represents the asynchronous operation, containing the located value or . - 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 . @@ -210,7 +210,7 @@ To be added. To be added. 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 . @@ -243,7 +243,7 @@ Optional. The used to propagate notifications that the operation should be canceled. Refreshes a value in the cache based on its key, resetting its sliding expiration timeout (if any). The that represents the asynchronous operation. - 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 . @@ -305,7 +305,7 @@ To be added. To be added. 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 . @@ -338,7 +338,7 @@ Optional. The used to propagate notifications that the operation should be canceled. Removes the value with the given key. The that represents the asynchronous operation. - 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 . @@ -408,7 +408,7 @@ To be added. To be added. 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 . @@ -445,7 +445,7 @@ Optional. The used to propagate notifications that the operation should be canceled. Sets the value with the given key. The that represents the asynchronous operation. - 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 . diff --git a/xml/Microsoft.Extensions.Caching.StackExchangeRedis/RedisCache.xml b/xml/Microsoft.Extensions.Caching.StackExchangeRedis/RedisCache.xml index ef56bb1a34a..558e1a5ecb6 100644 --- a/xml/Microsoft.Extensions.Caching.StackExchangeRedis/RedisCache.xml +++ b/xml/Microsoft.Extensions.Caching.StackExchangeRedis/RedisCache.xml @@ -134,7 +134,7 @@ Optional. The used to propagate notifications that the operation should be canceled. Gets a value with the given key. The that represents the asynchronous operation, containing the located value or . - 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 . @@ -194,7 +194,7 @@ Optional. The used to propagate notifications that the operation should be canceled. Refreshes a value in the cache based on its key, resetting its sliding expiration timeout (if any). The that represents the asynchronous operation. - 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 . @@ -254,7 +254,7 @@ Optional. The used to propagate notifications that the operation should be canceled. Removes the value with the given key. The that represents the asynchronous operation. - 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 . @@ -322,7 +322,7 @@ Optional. The used to propagate notifications that the operation should be canceled. Sets the value with the given key. The that represents the asynchronous operation. - 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 . diff --git a/xml/Microsoft.Extensions.DependencyInjection/AsyncServiceScope.xml b/xml/Microsoft.Extensions.DependencyInjection/AsyncServiceScope.xml index f241e2bda47..7d1a3789eac 100644 --- a/xml/Microsoft.Extensions.DependencyInjection/AsyncServiceScope.xml +++ b/xml/Microsoft.Extensions.DependencyInjection/AsyncServiceScope.xml @@ -107,7 +107,7 @@ Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources asynchronously. A task that represents the asynchronous dispose operation. - 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 . diff --git a/xml/Microsoft.Extensions.DependencyInjection/ServiceProvider.xml b/xml/Microsoft.Extensions.DependencyInjection/ServiceProvider.xml index 912240feb8c..7b680830af8 100644 --- a/xml/Microsoft.Extensions.DependencyInjection/ServiceProvider.xml +++ b/xml/Microsoft.Extensions.DependencyInjection/ServiceProvider.xml @@ -99,7 +99,7 @@ Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources asynchronously. A task that represents the asynchronous dispose operation. - 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 . diff --git a/xml/Microsoft.Extensions.Hosting/HostingAbstractionsHostBuilderExtensions.xml b/xml/Microsoft.Extensions.Hosting/HostingAbstractionsHostBuilderExtensions.xml index 2b95fe71545..c9df69bb2e5 100644 --- a/xml/Microsoft.Extensions.Hosting/HostingAbstractionsHostBuilderExtensions.xml +++ b/xml/Microsoft.Extensions.Hosting/HostingAbstractionsHostBuilderExtensions.xml @@ -88,7 +88,7 @@ A that can be used to cancel the start. Builds and starts the host. The started . - 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 . diff --git a/xml/Microsoft.Extensions.Hosting/HostingAbstractionsHostExtensions.xml b/xml/Microsoft.Extensions.Hosting/HostingAbstractionsHostExtensions.xml index 86f82285789..de1934c51ca 100644 --- a/xml/Microsoft.Extensions.Hosting/HostingAbstractionsHostExtensions.xml +++ b/xml/Microsoft.Extensions.Hosting/HostingAbstractionsHostExtensions.xml @@ -89,7 +89,7 @@ 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. - 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 . @@ -221,7 +221,7 @@ The token to trigger shutdown. Returns a Task that completes when shutdown is triggered via the given token. The that represents the asynchronous operation. - 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 . diff --git a/xml/Mono.Security.Interface/IMonoSslStream.xml b/xml/Mono.Security.Interface/IMonoSslStream.xml index 56a98c8d9e5..c44197e06fc 100644 --- a/xml/Mono.Security.Interface/IMonoSslStream.xml +++ b/xml/Mono.Security.Interface/IMonoSslStream.xml @@ -95,7 +95,7 @@ To be added. To be added. 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 . @@ -126,7 +126,7 @@ To be added. To be added. 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 . @@ -205,7 +205,7 @@ To be added. To be added. 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 . @@ -236,7 +236,7 @@ To be added. To be added. 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 . diff --git a/xml/System.Activities/WorkflowInvoker.xml b/xml/System.Activities/WorkflowInvoker.xml index b2aa795ed7c..a3c6973ac5e 100644 --- a/xml/System.Activities/WorkflowInvoker.xml +++ b/xml/System.Activities/WorkflowInvoker.xml @@ -1054,18 +1054,18 @@ The following example invokes a workflow consisting of a single `Add` activity t ## Remarks To be notified when the workflow is complete, handle . To configure a time-out interval in which the workflow must complete, use one of the overloads that take a . - This method invokes a workflow asynchronously using the event-based asynchronous design pattern. For more information, see [Event-based Asynchronous Pattern Overview](https://go.microsoft.com/fwlink/?LinkId=141765). + This method invokes a workflow asynchronously using the event-based asynchronous design pattern. For more information, see [Event-based Asynchronous Pattern Overview](/dotnet/standard/asynchronous-programming-patterns/event-based-asynchronous-pattern-overview). - + 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 . ## Examples The following example invokes a workflow consisting of a `LongRunningDiceRoll` activity. The `LongRunningDiceRoll` activity has two output arguments that represent the results of the dice roll operation. When the workflow completes these are retrieved in the handler. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet131"::: - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet33"::: - - ]]> + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet33"::: + +]]> @@ -1113,7 +1113,9 @@ The following example invokes a workflow consisting of a single `Add` activity t :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet33"::: - ]]> + 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 . + +]]> @@ -1197,18 +1199,18 @@ The following example invokes a workflow consisting of a single `Add` activity t > [!NOTE] > The is only thrown if the time-out interval elapses and the workflow becomes idle during execution. A workflow that takes longer than the specified time-out interval to complete completes successfully if the workflow does not become idle. - This method invokes a workflow asynchronously using the event-based asynchronous design pattern. For more information, see [Event-based Asynchronous Pattern Overview](https://go.microsoft.com/fwlink/?LinkId=141765). + This method invokes a workflow asynchronously using the event-based asynchronous design pattern. For more information, see [Event-based Asynchronous Pattern Overview](/dotnet/standard/asynchronous-programming-patterns/event-based-asynchronous-pattern-overview). - + 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 . ## Examples The following example invokes a workflow consisting of a `LongRunningDiceRoll` activity. The `LongRunningDiceRoll` activity has two output arguments that represent the results of the dice roll operation. When the workflow completes these are retrieved in the handler. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet131"::: - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet33"::: - - ]]> + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet33"::: + +]]> @@ -1307,7 +1309,9 @@ The following example invokes a workflow consisting of a single `Add` activity t :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowinvokerexample/cs/program.cs" id="Snippet33"::: - ]]> + 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 . + +]]> diff --git a/xml/System.CodeDom.Compiler/IndentedTextWriter.xml b/xml/System.CodeDom.Compiler/IndentedTextWriter.xml index 34773fec4c9..c24475c5a87 100644 --- a/xml/System.CodeDom.Compiler/IndentedTextWriter.xml +++ b/xml/System.CodeDom.Compiler/IndentedTextWriter.xml @@ -446,7 +446,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. + 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 . @@ -678,7 +678,7 @@ Asynchronously outputs tabs to the underlying based on the current . A representing the asynchronous operation. - 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 . @@ -1380,7 +1380,7 @@ The to write. Asynchronously writes the specified to the underlying , inserting tabs at the start of every line. A representing the asynchronous operation. - 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 . @@ -1415,7 +1415,7 @@ The string to write. Asynchronously writes the specified string to the underlying , inserting tabs at the start of every line. A representing the asynchronous operation. - 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 . @@ -1526,7 +1526,7 @@ The number of characters to write. Asynchronously writes the specified number of s from the specified buffer to the underlying , starting at the specified index, and outputting tabs at the start of every new line. A representing the asynchronous operation. - 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 . @@ -2322,7 +2322,7 @@ Asynchronously writes the line terminator to the underlying . A representing the asynchronous line writing operation. - 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 . @@ -2358,7 +2358,7 @@ The character to write. Asynchronously writes the specified to the underlying followed by a line terminator, inserting tabs at the start of every line. A representing the asynchronous operation. - 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 . @@ -2393,7 +2393,7 @@ The string to write. Asynchronously writes the specified string followed by a line terminator to the underlying , inserting tabs at the start of every line. A representing the asynchronous operation. - 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 . @@ -2504,7 +2504,7 @@ The number of characters to write. Asynchronously writes the specified number of characters from the specified buffer followed by a line terminator, to the underlying , starting at the specified index within the buffer, inserting tabs at the start of every line. A representing the asynchronous operation. - 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 . @@ -2598,7 +2598,7 @@ The string to write. Asynchronously writes the specified string to the underlying without inserting tabs. A representing the asynchronous operation. - 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 . diff --git a/xml/System.CommandLine.Parsing/ParseResultExtensions.xml b/xml/System.CommandLine.Parsing/ParseResultExtensions.xml index 3bf3e462881..aeafc50b0e9 100644 --- a/xml/System.CommandLine.Parsing/ParseResultExtensions.xml +++ b/xml/System.CommandLine.Parsing/ParseResultExtensions.xml @@ -130,7 +130,7 @@ Invokes the appropriate command handler for a parsed command line input. A task whose result can be used as a process exit code. - 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 . diff --git a/xml/System.CommandLine.Parsing/ParserExtensions.xml b/xml/System.CommandLine.Parsing/ParserExtensions.xml index 408866c99b9..4e9be7f44c5 100644 --- a/xml/System.CommandLine.Parsing/ParserExtensions.xml +++ b/xml/System.CommandLine.Parsing/ParserExtensions.xml @@ -107,7 +107,7 @@ Parses a command line string value and invokes the handler for the indicated command. The exit code for the invocation. - The command line string input will be split into tokens as if it had been passed on the command line. + The command line string input will be split into tokens as if it had been passed on the command line.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 . @@ -137,7 +137,7 @@ Parses a command line string array and invokes the handler for the indicated command. The exit code for the invocation. - 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 . diff --git a/xml/System.CommandLine/CommandExtensions.xml b/xml/System.CommandLine/CommandExtensions.xml index b9593400277..33bab0fa599 100644 --- a/xml/System.CommandLine/CommandExtensions.xml +++ b/xml/System.CommandLine/CommandExtensions.xml @@ -107,7 +107,7 @@ Parses and invokes a command. The exit code for the invocation. - The command line string input will be split into tokens as if it had been passed on the command line. + The command line string input will be split into tokens as if it had been passed on the command line.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 . @@ -137,7 +137,7 @@ Parses and invokes a command. The exit code for the invocation. - 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 . diff --git a/xml/System.Data.Common/DbBatch.xml b/xml/System.Data.Common/DbBatch.xml index 54b91face44..4fd6e4edcbd 100644 --- a/xml/System.Data.Common/DbBatch.xml +++ b/xml/System.Data.Common/DbBatch.xml @@ -292,7 +292,10 @@ The precise semantics of batch execution vary across ADO.NET providers, especial The default implementation of this asynchronous method delegates to its synchronous counterpart and returns a completed `ValueTask`, potentially blocking the calling thread. Data providers that support [asynchronous programming](/dotnet/framework/data/adonet/asynchronous-programming) should override the default implementation using asynchronous I/O operations. - ]]> + + 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 . + +]]> @@ -366,7 +369,9 @@ The precise semantics of batch execution vary across ADO.NET providers, especial ## Remarks For more information about asynchronous programming, see [Asynchronous Programming](/dotnet/framework/data/adonet/asynchronous-programming). - ]]> + 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 . + +]]> @@ -436,7 +441,9 @@ The precise semantics of batch execution vary across ADO.NET providers, especial ## Remarks For more information about asynchronous programming, see [Asynchronous Programming](/dotnet/framework/data/adonet/asynchronous-programming). - ]]> + 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. ADO.NET Overview @@ -538,7 +545,9 @@ The precise semantics of batch execution vary across ADO.NET providers, especial ## Remarks Managed provider implementers must call in . For more information about asynchronous programming, see [Asynchronous Programming](/dotnet/framework/data/adonet/asynchronous-programming). - ]]> + 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 value is invalid. @@ -590,7 +599,7 @@ The precise semantics of batch execution vary across ADO.NET providers, especial A token to cancel the asynchronous operation. An asynchronous version of , which executes the batch and returns the first column of the first row in the first returned result set. All other columns, rows and result sets are ignored. The first column of the first row in the first result set. - 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 . An error occurred while executing the batch. @@ -638,7 +647,7 @@ The precise semantics of batch execution vary across ADO.NET providers, especial An optional token to cancel the asynchronous operation. The default value is . 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. - 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 . diff --git a/xml/System.Data.Common/DbCommand.xml b/xml/System.Data.Common/DbCommand.xml index 00907fa09d9..85f8b32ab8a 100644 --- a/xml/System.Data.Common/DbCommand.xml +++ b/xml/System.Data.Common/DbCommand.xml @@ -747,7 +747,10 @@ The default implementation of this asynchronous method delegates to its synchronous counterpart and returns a completed `ValueTask`, potentially blocking the calling thread. Data providers that support [asynchronous programming](/dotnet/framework/data/adonet/asynchronous-programming) should override the default implementation using asynchronous I/O operations. - ]]> + + 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 . + +]]> @@ -848,7 +851,9 @@ ## Remarks For more information about asynchronous programming, see [Asynchronous Programming](/dotnet/framework/data/adonet/asynchronous-programming). - ]]> + 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 command. An invalid value. @@ -973,7 +978,9 @@ ## Remarks For more information about asynchronous programming, see [Asynchronous Programming](/dotnet/framework/data/adonet/asynchronous-programming). - ]]> + 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 command. ADO.NET Overview @@ -1028,7 +1035,9 @@ ## Remarks For more information about asynchronous programming, see [Asynchronous Programming](/dotnet/framework/data/adonet/asynchronous-programming). - ]]> + 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 command. ADO.NET Overview @@ -1192,7 +1201,9 @@ ## Remarks Managed provider implementers must call in . For more information about asynchronous programming, see [Asynchronous Programming](/dotnet/framework/data/adonet/asynchronous-programming). - ]]> + 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 command. An invalid value. @@ -1246,7 +1257,9 @@ ## Remarks Managed provider implementers must call in . For more information about asynchronous programming, see [Asynchronous Programming](/dotnet/framework/data/adonet/asynchronous-programming). - ]]> + 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 command. An invalid value. @@ -1300,7 +1313,9 @@ ## Remarks Managed provider implementers must call in . For more information about asynchronous programming, see [Asynchronous Programming](/dotnet/framework/data/adonet/asynchronous-programming). - ]]> + 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 command. An invalid value. @@ -1354,7 +1369,9 @@ ## Remarks Managed provider implementers must call in . For more information about asynchronous programming, see [Asynchronous Programming](/dotnet/framework/data/adonet/asynchronous-programming). - ]]> + 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 command. An invalid value. @@ -1478,7 +1495,9 @@ ## Remarks For more information about asynchronous programming, see [Asynchronous Programming](/dotnet/framework/data/adonet/asynchronous-programming). - ]]> + 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 command. ADO.NET Overview @@ -1534,7 +1553,9 @@ ## Remarks For more information about asynchronous programming, see [Asynchronous Programming](/dotnet/framework/data/adonet/asynchronous-programming). - ]]> + 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 command. ADO.NET Overview @@ -1682,7 +1703,9 @@ If the property is set to `TableDirect`, `PrepareAsync` does nothing. If is set to `StoredProcedure`, the call to `PrepareAsync` should succeed, although it may result in a no-op. - ]]> + 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 . + +]]> diff --git a/xml/System.Data.Common/DbConnection.xml b/xml/System.Data.Common/DbConnection.xml index 60f2d2bd699..d355d0000e4 100644 --- a/xml/System.Data.Common/DbConnection.xml +++ b/xml/System.Data.Common/DbConnection.xml @@ -209,7 +209,9 @@ Data providers that support [asynchronous programming](/dotnet/framework/data/adonet/asynchronous-programming) should override the default implementation using asynchronous I/O operations. - ]]> + 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 . + +]]> @@ -368,7 +370,9 @@ Data providers that support [asynchronous programming](/dotnet/framework/data/adonet/asynchronous-programming) should override the default implementation using asynchronous I/O operations. - ]]> + 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 . + +]]> @@ -414,7 +418,9 @@ Data providers that support [asynchronous programming](/dotnet/framework/data/adonet/asynchronous-programming) should override the default implementation using asynchronous I/O operations. - ]]> + 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 . + +]]> @@ -550,7 +556,9 @@ This property returns `false` by default; providers that implement + 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 . + +]]> @@ -660,7 +668,9 @@ This property returns `false` by default; providers that implement [!CAUTION] > Do not close or dispose a `DbConnection`, a `DbDataReader`, or any other managed object in the `Finalize` method of your class. In a finalizer, you should only release unmanaged resources that your class owns directly. If your class does not own any unmanaged resources, do not include a `Finalize` method in your class definition. For more information, see [Garbage Collection](/dotnet/standard/garbage-collection/). - ]]> + 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 . + +]]> @@ -1154,7 +1164,9 @@ This property returns `false` by default; providers that implement + 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 . + +]]> @@ -1417,7 +1429,7 @@ This property returns `false` by default; providers that implement . Exceptions thrown by will be communicated via the returned Task Exception property. A task representing the asynchronous operation. - 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 . @@ -1453,7 +1465,7 @@ This property returns `false` by default; providers that implement . Exceptions thrown by will be communicated via the returned Task Exception property. A task representing the asynchronous operation. - 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 . @@ -1491,7 +1503,7 @@ This property returns `false` by default; providers that implement . Exceptions thrown by will be communicated via the returned Task Exception property. A task representing the asynchronous operation. - 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 . @@ -1662,7 +1674,9 @@ This property returns `false` by default; providers that implement + 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 . + +]]> ADO.NET Overview @@ -1720,7 +1734,9 @@ This property returns `false` by default; providers that implement + 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 . + +]]> ADO.NET Overview diff --git a/xml/System.Data.Common/DbDataReader.xml b/xml/System.Data.Common/DbDataReader.xml index 8b40c8fdac3..59de4c9530b 100644 --- a/xml/System.Data.Common/DbDataReader.xml +++ b/xml/System.Data.Common/DbDataReader.xml @@ -203,7 +203,9 @@ Data providers that support [asynchronous programming](/dotnet/framework/data/adonet/asynchronous-programming) should override the default implementation using asynchronous I/O operations. - ]]> + 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 . + +]]> @@ -428,7 +430,9 @@ Data providers that support [asynchronous programming](/dotnet/framework/data/adonet/asynchronous-programming) should override the default implementation using asynchronous I/O operations. - ]]> + 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 . + +]]> @@ -2046,7 +2050,7 @@ Returns if the executed command returned no resultset, o The default implementation will return a cancelled task if passed an already cancelled . Exceptions thrown by will be communicated via the returned Task Exception property. A task representing the asynchronous operation. - 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 . @@ -2534,7 +2538,9 @@ Returns if the executed command returned no resultset, o Other methods and properties of the DbDataReader object should not be invoked while the returned Task is not yet completed. - ]]> + 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 connection was dropped or closed during the data retrieval. @@ -2611,7 +2617,9 @@ Returns if the executed command returned no resultset, o This method accepts a cancellation token that can be used to request the operation to be cancelled early. Implementations may ignore this request. Other methods and properties of the DbDataReader object should not be invoked while the returned Task is not yet completed. - ]]> + 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 connection was dropped or closed during the data retrieval. @@ -2854,7 +2862,9 @@ Returns if the executed command returned no resultset, o Data providers that support [asynchronous programming](/dotnet/framework/data/adonet/asynchronous-programming) should override the default implementation using asynchronous I/O operations. Other methods and properties of the DbDataReader object should not be invoked while the returned Task is not yet completed. - ]]> + 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 command text. ADO.NET Overview @@ -2909,7 +2919,9 @@ Returns if the executed command returned no resultset, o This method accepts a cancellation token that can be used to request the operation to be cancelled early. Implementations may ignore this request. Other methods and properties of the DbDataReader object should not be invoked while the returned Task is not yet completed. - ]]> + 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 command text. ADO.NET Overview @@ -3030,7 +3042,9 @@ Returns if the executed command returned no resultset, o Other methods and properties of the DbDataReader object should not be invoked while the returned Task is not yet completed. - ]]> + 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 command text. ADO.NET Overview @@ -3086,7 +3100,9 @@ Returns if the executed command returned no resultset, o Other methods and properties of the DbDataReader object should not be invoked while the returned Task is not yet completed. - ]]> + 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 command text. ADO.NET Overview diff --git a/xml/System.Data.Common/DbDataSource.xml b/xml/System.Data.Common/DbDataSource.xml index bb3ae447ebc..4eddb94799c 100644 --- a/xml/System.Data.Common/DbDataSource.xml +++ b/xml/System.Data.Common/DbDataSource.xml @@ -338,7 +338,9 @@ ## Remarks If the current instance of represents a connection pool, disposing it should close all idle connections, and arrange for busy connections to be closed as soon as possible. - ]]> + 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 . + +]]> @@ -431,7 +433,9 @@ It is the responsibility of the caller to properly dispose the connection returned by this method. Failure to do so may result in a connection leak. - ]]> + 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 . + +]]> @@ -491,7 +495,9 @@ ## Remarks This method is meant to be overridden by implementing ADO.NET providers, and is not a user-facing API. - ]]> + 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 . + +]]> diff --git a/xml/System.Data.Common/DbTransaction.xml b/xml/System.Data.Common/DbTransaction.xml index d4cbbbf861c..29897ef8c22 100644 --- a/xml/System.Data.Common/DbTransaction.xml +++ b/xml/System.Data.Common/DbTransaction.xml @@ -195,7 +195,9 @@ Data providers that support [asynchronous programming](/dotnet/framework/data/adonet/asynchronous-programming) should override the default implementation using asynchronous I/O operations. - ]]> + 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 . + +]]> @@ -459,7 +461,9 @@ Data providers that support [asynchronous programming](/dotnet/framework/data/adonet/asynchronous-programming) should override the default implementation using asynchronous I/O operations. - ]]> + 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 . + +]]> @@ -564,7 +568,7 @@ An optional token to cancel the asynchronous operation. The default value is . 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. - 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 . @@ -680,7 +684,9 @@ Data providers that support [asynchronous programming](/dotnet/framework/data/adonet/asynchronous-programming) should override the default implementation using asynchronous I/O operations. - ]]> + 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 . + +]]> @@ -712,7 +718,7 @@ An optional token to cancel the asynchronous operation. The default value is . Rolls back all commands that were executed after the specified savepoint was established. A representing the asynchronous operation. - 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 . @@ -772,7 +778,7 @@ An optional token to cancel the asynchronous operation. The default value is . 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. - 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 . diff --git a/xml/System.Data.SqlClient/SqlBulkCopy.xml b/xml/System.Data.SqlClient/SqlBulkCopy.xml index e2e5fdfa28d..6d86488ad43 100644 --- a/xml/System.Data.SqlClient/SqlBulkCopy.xml +++ b/xml/System.Data.SqlClient/SqlBulkCopy.xml @@ -1201,7 +1201,9 @@ For more information about asynchronous programming in the .NET Framework Data Provider for SQL Server, see [Asynchronous Programming](/dotnet/framework/data/adonet/asynchronous-programming). - ]]> +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 . + +]]> @@ -1242,7 +1244,9 @@ For more information about asynchronous programming in the .NET Framework Data P ## Remarks For more information about asynchronous programming in the .NET Framework Data Provider for SQL Server, see [Asynchronous Programming](/dotnet/framework/data/adonet/asynchronous-programming). - ]]> + 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 . + +]]> Calling multiple times for the same instance before task completion. @@ -1297,7 +1301,9 @@ For more information about asynchronous programming in the .NET Framework Data P ## Remarks For more information about asynchronous programming in the .NET Framework Data Provider for SQL Server, see [Asynchronous Programming](/dotnet/framework/data/adonet/asynchronous-programming). - ]]> + 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 . + +]]> Calling multiple times for the same instance before task completion. @@ -1352,7 +1358,9 @@ For more information about asynchronous programming in the .NET Framework Data P ## Remarks For more information about asynchronous programming in the .NET Framework Data Provider for SQL Server, see [Asynchronous Programming](/dotnet/framework/data/adonet/asynchronous-programming). - ]]> + 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 . + +]]> Calling multiple times for the same instance before task completion. @@ -1413,7 +1421,7 @@ For more information about asynchronous programming in the .NET Framework Data P The cancellation instruction. A value in this parameter makes this method equivalent to . The asynchronous version of , which copies all rows from the supplied array to a destination table specified by the property of the object. Returns . - 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 . @@ -1457,7 +1465,9 @@ For more information about asynchronous programming in the .NET Framework Data P ## Remarks For more information about asynchronous programming in the .NET Framework Data Provider for SQL Server, see [Asynchronous Programming](/dotnet/framework/data/adonet/asynchronous-programming). - ]]> + 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 . + +]]> Calling multiple times for the same instance before task completion. @@ -1514,7 +1524,9 @@ For more information about asynchronous programming in the .NET Framework Data P ## Remarks For more information about asynchronous programming in the .NET Framework Data Provider for SQL Server, see [Asynchronous Programming](/dotnet/framework/data/adonet/asynchronous-programming). - ]]> + 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 . + +]]> Calling multiple times for the same instance before task completion. @@ -1573,7 +1585,9 @@ For more information about asynchronous programming in the .NET Framework Data P ## Remarks For more information about asynchronous programming in the .NET Framework Data Provider for SQL Server, see [Asynchronous Programming](/dotnet/framework/data/adonet/asynchronous-programming). - ]]> + 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 . + +]]> Calling multiple times for the same instance before task completion. @@ -1632,7 +1646,9 @@ For more information about asynchronous programming in the .NET Framework Data P ## Remarks For more information about asynchronous programming in the .NET Framework Data Provider for SQL Server, see [Asynchronous Programming](/dotnet/framework/data/adonet/asynchronous-programming). - ]]> + 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 . + +]]> Calling multiple times for the same instance before task completion. @@ -1697,7 +1713,9 @@ For more information about asynchronous programming in the .NET Framework Data P ## Remarks For more information about asynchronous programming in the .NET Framework Data Provider for SQL Server, see [Asynchronous Programming](/dotnet/framework/data/adonet/asynchronous-programming). - ]]> + 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 . + +]]> Calling multiple times for the same instance before task completion. diff --git a/xml/System.Data.SqlClient/SqlCommand.xml b/xml/System.Data.SqlClient/SqlCommand.xml index 9592c9e4724..1e7d94953e8 100644 --- a/xml/System.Data.SqlClient/SqlCommand.xml +++ b/xml/System.Data.SqlClient/SqlCommand.xml @@ -2557,7 +2557,7 @@ In some situations, can be set to To be added. To be added. 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 . @@ -2694,7 +2694,9 @@ If no statements are detected that contribute to the count, the return value is ## Remarks For more information about asynchronous programming in the .NET Framework Data Provider for SQL Server, see [Asynchronous Programming](/dotnet/framework/data/adonet/asynchronous-programming). - ]]> + 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 . + +]]> A other than **Binary** or **VarBinary** was used when was set to . For more information about streaming, see [SqlClient Streaming Support](/dotnet/framework/data/adonet/sqlclient-streaming-support). @@ -2959,7 +2961,9 @@ The closed or dropped durin ## Remarks For more information about asynchronous programming in the .NET Framework Data Provider for SQL Server, see [Asynchronous Programming](/dotnet/framework/data/adonet/asynchronous-programming). - ]]> + 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 . + +]]> A other than **Binary** or **VarBinary** was used when was set to . For more information about streaming, see [SqlClient Streaming Support](/dotnet/framework/data/adonet/sqlclient-streaming-support). @@ -3033,7 +3037,9 @@ The closed or dropped durin ## Remarks For more information about asynchronous programming in the .NET Framework Data Provider for SQL Server, see [Asynchronous Programming](/dotnet/framework/data/adonet/asynchronous-programming). - ]]> + 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 . + +]]> A other than **Binary** or **VarBinary** was used when was set to . For more information about streaming, see [SqlClient Streaming Support](/dotnet/framework/data/adonet/sqlclient-streaming-support). @@ -3109,7 +3115,9 @@ The closed or dropped durin ## Remarks For more information about asynchronous programming in the .NET Framework Data Provider for SQL Server, see [Asynchronous Programming](/dotnet/framework/data/adonet/asynchronous-programming). - ]]> + 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 . + +]]> A other than **Binary** or **VarBinary** was used when was set to . For more information about streaming, see [SqlClient Streaming Support](/dotnet/framework/data/adonet/sqlclient-streaming-support). @@ -3187,7 +3195,9 @@ A timeout occurred during a streaming operation. For more information about stre ## Remarks For more information about asynchronous programming in the .NET Framework Data Provider for SQL Server, see [Asynchronous Programming](/dotnet/framework/data/adonet/asynchronous-programming). - ]]> + 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 . + +]]> A other than **Binary** or **VarBinary** was used when was set to . For more information about streaming, see [SqlClient Streaming Support](/dotnet/framework/data/adonet/sqlclient-streaming-support). @@ -3349,7 +3359,9 @@ A timeout occurred during a streaming operation. For more information about stre ## Remarks For more information about asynchronous programming in the .NET Framework Data Provider for SQL Server, see [Asynchronous Programming](/dotnet/framework/data/adonet/asynchronous-programming). - ]]> + 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 . + +]]> A other than **Binary** or **VarBinary** was used when was set to . For more information about streaming, see [SqlClient Streaming Support](/dotnet/framework/data/adonet/sqlclient-streaming-support). @@ -3521,7 +3533,9 @@ The **XmlReader** returned by this method does not support asynchronous operatio For more information about asynchronous programming in the .NET Framework Data Provider for SQL Server, see [Asynchronous Programming](/dotnet/framework/data/adonet/asynchronous-programming). - ]]> + 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 . + +]]> A other than **Binary** or **VarBinary** was used when was set to . For more information about streaming, see [SqlClient Streaming Support](/dotnet/framework/data/adonet/sqlclient-streaming-support). @@ -3599,7 +3613,9 @@ The **XmlReader** returned by this method does not support asynchronous operatio For more information about asynchronous programming in the .NET Framework Data Provider for SQL Server, see [Asynchronous Programming](/dotnet/framework/data/adonet/asynchronous-programming). - ]]> + 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 . + +]]> A other than **Binary** or **VarBinary** was used when was set to . For more information about streaming, see [SqlClient Streaming Support](/dotnet/framework/data/adonet/sqlclient-streaming-support). diff --git a/xml/System.Data.SqlClient/SqlConnection.xml b/xml/System.Data.SqlClient/SqlConnection.xml index d6865c44734..c7483c0c054 100644 --- a/xml/System.Data.SqlClient/SqlConnection.xml +++ b/xml/System.Data.SqlClient/SqlConnection.xml @@ -2622,7 +2622,9 @@ class Program { For more information about asynchronous programming in the .NET Framework Data Provider for SQL Server, see [Asynchronous Programming](/dotnet/framework/data/adonet/asynchronous-programming). - ]]> + 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 . + +]]> Calling more than once for the same instance before task completion. diff --git a/xml/System.Data.SqlClient/SqlDataReader.xml b/xml/System.Data.SqlClient/SqlDataReader.xml index 07e69f4ac45..aeee87a5d53 100644 --- a/xml/System.Data.SqlClient/SqlDataReader.xml +++ b/xml/System.Data.SqlClient/SqlDataReader.xml @@ -3724,7 +3724,9 @@ This member is an explicit interface member implementation. It can be used only ## Remarks For more information, see [SqlClient Streaming Support](/dotnet/framework/data/adonet/sqlclient-streaming-support). - ]]> + 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 connection drops or is closed during the data retrieval. @@ -3967,7 +3969,9 @@ This member is an explicit interface member implementation. It can be used only ## Remarks For more information about asynchronous programming in the .NET Framework Data Provider for SQL Server, see [Asynchronous Programming](/dotnet/framework/data/adonet/asynchronous-programming). - ]]> + 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 . + +]]> Calling more than once for the same instance before task completion. @@ -4092,7 +4096,9 @@ This member is an explicit interface member implementation. It can be used only For more information, including code samples, about asynchronous programming in the .NET Framework Data Provider for SQL Server, see [Asynchronous Programming](/dotnet/framework/data/adonet/asynchronous-programming). - ]]> + 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 . + +]]> Calling more than once for the same instance before task completion. diff --git a/xml/System.Data/DataReaderExtensions.xml b/xml/System.Data/DataReaderExtensions.xml index 786b472f6b2..fad40ee9d54 100644 --- a/xml/System.Data/DataReaderExtensions.xml +++ b/xml/System.Data/DataReaderExtensions.xml @@ -1152,7 +1152,7 @@ A whose property is if the specified column value is equivalent to or if it is not. + 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 connection was dropped or closed during the data retrieval. diff --git a/xml/System.Device.Location/CivicAddressResolver.xml b/xml/System.Device.Location/CivicAddressResolver.xml index df83d7c1840..cdc7fabbe1e 100644 --- a/xml/System.Device.Location/CivicAddressResolver.xml +++ b/xml/System.Device.Location/CivicAddressResolver.xml @@ -143,15 +143,19 @@ CivicAddressResolver resolver = new CivicAddressResolver(); The containing the location to resolve to a civic address. Resolves an address asynchronously from a location that is based on latitude and longitude. The call does not block execution of the calling thread while the address is being resolved. - , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . ## Examples The following program shows how to call to resolve a civic address asynchronously. :::code language="csharp" source="~/snippets/csharp/System.Device.Location/CivicAddress/Overview/resolvecivicaddressasync.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Misc/system.device.location.resolvecivicaddressasync/vb/resolvecivicaddressasync.vb" id="Snippet1"::: - - ]]> + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Misc/system.device.location.resolvecivicaddressasync/vb/resolvecivicaddressasync.vb" id="Snippet1"::: + +]]> is . diff --git a/xml/System.Device.Location/ICivicAddressResolver.xml b/xml/System.Device.Location/ICivicAddressResolver.xml index eb872e92586..0cdd620d629 100644 --- a/xml/System.Device.Location/ICivicAddressResolver.xml +++ b/xml/System.Device.Location/ICivicAddressResolver.xml @@ -88,7 +88,9 @@ :::code language="csharp" source="~/snippets/csharp/System.Device.Location/CivicAddress/Overview/resolvecivicaddressasync.cs" id="Snippet2"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Misc/system.device.location.resolvecivicaddressasync/vb/resolvecivicaddressasync.vb" id="Snippet2"::: - ]]> + 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 . + +]]> diff --git a/xml/System.Diagnostics/Process.xml b/xml/System.Diagnostics/Process.xml index 104fc466c93..ec21fa9bc0e 100644 --- a/xml/System.Diagnostics/Process.xml +++ b/xml/System.Diagnostics/Process.xml @@ -6847,7 +6847,9 @@ The file specified in the could not be found. Calling this method will set to `true`. - ]]> +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 . + +]]> diff --git a/xml/System.Formats.Tar/TarEntry.xml b/xml/System.Formats.Tar/TarEntry.xml index 718d29c8b92..c48a990e6bc 100644 --- a/xml/System.Formats.Tar/TarEntry.xml +++ b/xml/System.Formats.Tar/TarEntry.xml @@ -168,6 +168,7 @@ An I/O problem occurred. Files of type , , or can only be extracted in Unix platforms. Elevation is required to extract a or to disk. + 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 . diff --git a/xml/System.Formats.Tar/TarFile.xml b/xml/System.Formats.Tar/TarFile.xml index db31cc85e74..25ab7b88f8c 100644 --- a/xml/System.Formats.Tar/TarFile.xml +++ b/xml/System.Formats.Tar/TarFile.xml @@ -120,7 +120,7 @@ The token to monitor for cancellation requests. The default value is . Asynchronously creates a tar stream that contains all the filesystem entries from the specified directory. A task that represents the asynchronous creation operation. - 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 . or is . @@ -161,7 +161,7 @@ The token to monitor for cancellation requests. The default value is . Asynchronously creates a tar archive from the contents of the specified directory, and outputs them into the specified path. Can optionally include the base directory as the prefix for the entry names. A task that represents the asynchronous creation operation. - 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 . or is . @@ -292,6 +292,7 @@ Extracting one of the tar entries would have resulted in a file outside the spec Files of type , , or can only be extracted in Unix platforms. Elevation is required to extract a or to disk. + 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 . @@ -341,6 +342,7 @@ Extracting one of the tar entries would have resulted in a file outside the spec Files of type , , or can only be extracted in Unix platforms. Elevation is required to extract a or to disk. + 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 . diff --git a/xml/System.Formats.Tar/TarReader.xml b/xml/System.Formats.Tar/TarReader.xml index 281cea70e5e..924a3369056 100644 --- a/xml/System.Formats.Tar/TarReader.xml +++ b/xml/System.Formats.Tar/TarReader.xml @@ -98,7 +98,7 @@ Asynchronously disposes the current instance, and closes the streams of all the entries that were read from the archive if the leaveOpen argument was set to in the constructor. A value task that represents the asynchronous dispose operation. - The property of any entry can be replaced with a new stream. If the user decides to replace it on a instance that was obtained using a , the underlying stream gets disposed immediately, freeing the of origin from the responsibility of having to dispose it. + The property of any entry can be replaced with a new stream. If the user decides to replace it on a instance that was obtained using a , the underlying stream gets disposed immediately, freeing the of origin from the responsibility of having to dispose it.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 . @@ -175,7 +175,7 @@ Two or more extended attributes entries were found consecutively in the current The token to monitor for cancellation requests. The default value is . Asynchronously retrieves the next entry from the archive stream. A value task containing a instance if a valid entry was found, or if the end of the archive has been reached. - 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 archive is malformed. diff --git a/xml/System.Formats.Tar/TarWriter.xml b/xml/System.Formats.Tar/TarWriter.xml index f3772831483..5cda9867e26 100644 --- a/xml/System.Formats.Tar/TarWriter.xml +++ b/xml/System.Formats.Tar/TarWriter.xml @@ -154,7 +154,7 @@ Asynchronously disposes the current instance, and closes the archive stream if the leaveOpen argument was set to in the constructor. A value task that represents the asynchronous dispose operation. - 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 . @@ -313,7 +313,9 @@ These are the entry types supported for writing on each format: - - - ]]> +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 entry type is or and the is or empty. The archive stream is disposed. @@ -347,7 +349,7 @@ These are the entry types supported for writing on each format: The token to monitor for cancellation requests. The default value is . Asynchronously writes the specified file into the archive stream as a tar entry. A task that represents the asynchronous write operation. - 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 archive stream is disposed. or is or empty. diff --git a/xml/System.IO.Compression/BrotliStream.xml b/xml/System.IO.Compression/BrotliStream.xml index bb494427c23..8e24f99ddf2 100644 --- a/xml/System.IO.Compression/BrotliStream.xml +++ b/xml/System.IO.Compression/BrotliStream.xml @@ -576,7 +576,7 @@ The token to monitor for cancellation requests. The default value is . 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. + 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 . @@ -799,6 +799,7 @@ The `ReadAsync` method enables you to perform resource-intensive I/O operations without blocking the main thread. This performance consideration is particularly important in a Windows 8.x Store app or desktop app where a time-consuming stream operation can block the UI thread and make your app appear as if it is not working. The async methods are used in conjunction with the and keywords in Visual Basic and C#. 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. + 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 . @@ -1051,6 +1052,7 @@ The `WriteAsync` method enables you to perform resource-intensive I/O operations without blocking the main thread. This performance consideration is particularly important in a Windows 8.x Store app or desktop app where a time-consuming stream operation can block the UI thread and make your app appear as if it is not working. The async methods are used in conjunction with the and keywords in Visual Basic and C#. 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. + 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 . diff --git a/xml/System.IO.Compression/DeflateStream.xml b/xml/System.IO.Compression/DeflateStream.xml index a2b9cddf60f..00ee6dcccba 100644 --- a/xml/System.IO.Compression/DeflateStream.xml +++ b/xml/System.IO.Compression/DeflateStream.xml @@ -719,7 +719,9 @@ If the operation is canceled before it completes, the returned task contains the Copying begins at the current position in the current Deflate stream. - ]]> +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 . + +]]> @@ -1054,7 +1056,9 @@ The end write call is invalid. 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 . + +]]> @@ -1373,7 +1377,9 @@ Use the property to determ 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 . + +]]> @@ -1723,7 +1729,9 @@ Use the property to deter 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 . + +]]> diff --git a/xml/System.IO.Compression/GZipStream.xml b/xml/System.IO.Compression/GZipStream.xml index f7c92f38aeb..db739b4bb3b 100644 --- a/xml/System.IO.Compression/GZipStream.xml +++ b/xml/System.IO.Compression/GZipStream.xml @@ -752,7 +752,9 @@ If the operation is canceled before it completes, the returned task contains the Copying begins at the current position in the current GZip stream. - ]]> +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 . + +]]> @@ -1072,7 +1074,9 @@ This method flushes only if the current compression mode is 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 . + +]]> @@ -1396,7 +1400,9 @@ Use the property to determine 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 . + +]]> @@ -1752,7 +1758,9 @@ Use the property to determin 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 . + +]]> diff --git a/xml/System.IO.Compression/ZLibStream.xml b/xml/System.IO.Compression/ZLibStream.xml index 021e8401589..d0a12a68cf4 100644 --- a/xml/System.IO.Compression/ZLibStream.xml +++ b/xml/System.IO.Compression/ZLibStream.xml @@ -364,7 +364,7 @@ The token to monitor for cancellation requests. Asynchronously reads the bytes from the current stream and writes them to another stream, using a specified buffer size and cancellation token. A task that represents the asynchronous copy operation. - 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 . is . @@ -518,7 +518,7 @@ The token to monitor for cancellation requests. 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. + 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 . @@ -677,7 +677,7 @@ The token to monitor for cancellation requests. Asynchronously reads a sequence of bytes from the current stream, advances the position within the stream by the number of bytes read, and monitors cancellation requests. A task that represents the asynchronous completion of the operation. - 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 . @@ -866,7 +866,7 @@ The token to monitor for cancellation requests. 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. + 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 . diff --git a/xml/System.IO.Hashing/NonCryptographicHashAlgorithm.xml b/xml/System.IO.Hashing/NonCryptographicHashAlgorithm.xml index 8a8c0a69747..6d519e9bf73 100644 --- a/xml/System.IO.Hashing/NonCryptographicHashAlgorithm.xml +++ b/xml/System.IO.Hashing/NonCryptographicHashAlgorithm.xml @@ -147,7 +147,7 @@ The default value is . Asychronously reads the contents of and appends them to the data already processed for the current hash computation. A task that represents the asynchronous append operation. - 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 . is . diff --git a/xml/System.IO.IsolatedStorage/IsolatedStorageFileStream.xml b/xml/System.IO.IsolatedStorage/IsolatedStorageFileStream.xml index bf5362e69f4..f9e2a06ac12 100644 --- a/xml/System.IO.IsolatedStorage/IsolatedStorageFileStream.xml +++ b/xml/System.IO.IsolatedStorage/IsolatedStorageFileStream.xml @@ -1330,7 +1330,7 @@ Dim source As New IsolatedStorageFileStream(UserName,FileMode.Open,isoFile) The token to monitor for cancellation requests. The default value is . 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. - 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 . @@ -1818,7 +1818,9 @@ The meth The method will return zero only if the end of the stream is reached. In all other cases, always reads at least one byte from the stream before returning. If no data is available from the object upon a call to , the method will block until at least one byte of data can be returned. - ]]> +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 . + +]]> @@ -2265,7 +2267,9 @@ If the write operation is successful, the current position of the object is advanced by the number of bytes written. If an exception occurs, the current position of the object is unchanged. - ]]> +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 . + +]]> diff --git a/xml/System.IO.Pipelines/PipeReader.xml b/xml/System.IO.Pipelines/PipeReader.xml index d688eef35b5..609b0a48f12 100644 --- a/xml/System.IO.Pipelines/PipeReader.xml +++ b/xml/System.IO.Pipelines/PipeReader.xml @@ -278,7 +278,7 @@ The canceled An optional exception that indicates the failure that caused the reader to complete. Marks the current pipe reader instance as being complete, meaning no more data will be read from it. A value task that represents the asynchronous complete operation. - 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 . diff --git a/xml/System.IO.Pipelines/PipeWriter.xml b/xml/System.IO.Pipelines/PipeWriter.xml index 9eb766317cb..92e2a979095 100644 --- a/xml/System.IO.Pipelines/PipeWriter.xml +++ b/xml/System.IO.Pipelines/PipeWriter.xml @@ -226,7 +226,7 @@ The canceled An optional exception that indicates the failure that caused the pipeline to complete. Marks the current pipe writer instance as being complete, meaning no more data will be written to it. A value task that represents the asynchronous complete operation. - 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 . diff --git a/xml/System.IO.Pipes/NamedPipeClientStream.xml b/xml/System.IO.Pipes/NamedPipeClientStream.xml index 397190aa2f5..f8a68e8b97c 100644 --- a/xml/System.IO.Pipes/NamedPipeClientStream.xml +++ b/xml/System.IO.Pipes/NamedPipeClientStream.xml @@ -910,7 +910,7 @@ Asynchronously connects to a waiting server with an infinite timeout period. A task that represents the asynchronous connect operation. - 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 . @@ -951,7 +951,7 @@ The number of milliseconds to wait for the server to respond before the connection times out. Asynchronously connects to a waiting server within the specified timeout period. A task that represents the asynchronous connect operation. - 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 . @@ -992,7 +992,7 @@ The token to monitor for cancellation requests. The default value is . Asynchronously connects to a waiting server and monitors cancellation requests. A task that represents the asynchronous connect operation. - 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 . @@ -1035,7 +1035,7 @@ The token to monitor for cancellation requests. The default value is . Asynchronously connects to a waiting server within the specified timeout period and monitors cancellation requests. A task that represents the asynchronous connect operation. - 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 . @@ -1065,7 +1065,7 @@ The token to monitor for cancellation requests. The default value is . Asynchronously connects to a waiting server within the specified timeout period and monitors cancellation requests. A task that represents the asynchronous connect operation. - 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 . diff --git a/xml/System.IO.Pipes/NamedPipeServerStream.xml b/xml/System.IO.Pipes/NamedPipeServerStream.xml index 95ac942101f..8f36106eeff 100644 --- a/xml/System.IO.Pipes/NamedPipeServerStream.xml +++ b/xml/System.IO.Pipes/NamedPipeServerStream.xml @@ -1499,7 +1499,9 @@ ## Remarks Because it is asynchronous, this method returns immediately, but the connection process is completed when the client calls 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 . + +]]> @@ -1549,7 +1551,9 @@ Cancellation requests using the cancellation token will only work if the object was created with a pipe option value of or if the cancellation occurs before the method is called. - ]]> + 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 . + +]]> diff --git a/xml/System.IO.Pipes/PipeStream.xml b/xml/System.IO.Pipes/PipeStream.xml index bc4c89f4a20..4fed3a1af6e 100644 --- a/xml/System.IO.Pipes/PipeStream.xml +++ b/xml/System.IO.Pipes/PipeStream.xml @@ -878,7 +878,7 @@ When the disposing parameter is `true`, this method releases all resources held The token to monitor for cancellation requests. 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. - 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 . @@ -1659,7 +1659,9 @@ Use the property to determine wheth 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 stream does not support reading. Cannot access a closed pipe. @@ -2344,7 +2346,9 @@ Use the property to determine whet 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 . + +]]> is . diff --git a/xml/System.IO/BinaryWriter.xml b/xml/System.IO/BinaryWriter.xml index ce8265afc00..30db3379827 100644 --- a/xml/System.IO/BinaryWriter.xml +++ b/xml/System.IO/BinaryWriter.xml @@ -651,7 +651,7 @@ Asynchronously releases all resources used by the current instance of the class. A task that represents the asynchronous dispose operation. - 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 . diff --git a/xml/System.IO/BufferedStream.xml b/xml/System.IO/BufferedStream.xml index 1ec7ef78231..3e88d17fc8c 100644 --- a/xml/System.IO/BufferedStream.xml +++ b/xml/System.IO/BufferedStream.xml @@ -808,7 +808,9 @@ If the operation is canceled before it completes, the returned task contains the Copying begins at the current position in the current stream. - ]]> +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 . + +]]> @@ -1151,7 +1153,7 @@ Calling `DisposeAsync` allows the resources used by the The token to monitor for cancellation requests. 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. + 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. @@ -1528,7 +1530,9 @@ If the operation is canceled before it completes, the returned task contains the ## Remarks You can create a cancellation token by creating an instance of the class and passing the property as the `cancellationToken` parameter. - ]]> + This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . + +]]> is . @@ -2018,7 +2022,9 @@ If the operation is canceled before it completes, the returned task contains the ## Remarks You can create a cancellation token by creating an instance of the class and passing the property as the `cancellationToken` parameter. - ]]> + This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . + +]]> is . diff --git a/xml/System.IO/File.xml b/xml/System.IO/File.xml index bc0d8a05718..ee2bce4f46b 100644 --- a/xml/System.IO/File.xml +++ b/xml/System.IO/File.xml @@ -348,7 +348,7 @@ The token to monitor for cancellation requests. The default value is . 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. - 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 . @@ -394,7 +394,7 @@ The token to monitor for cancellation requests. The default value is . 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. - 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 . @@ -643,7 +643,7 @@ The token to monitor for cancellation requests. The default value is . 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. - 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 . @@ -690,7 +690,7 @@ The token to monitor for cancellation requests. The default value is . 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. - 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 . @@ -4051,7 +4051,7 @@ The following example moves a file. The token to monitor for cancellation requests. The default value is . 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. - 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 . @@ -4303,7 +4303,7 @@ The following example moves a file. The token to monitor for cancellation requests. The default value is . 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. - 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 . @@ -4347,7 +4347,7 @@ The following example moves a file. The token to monitor for cancellation requests. The default value is . 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. - 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 . @@ -4607,7 +4607,7 @@ The following example moves a file. The token to monitor for cancellation requests. The default value is . 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. - 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 . @@ -4651,7 +4651,7 @@ The following example moves a file. The token to monitor for cancellation requests. The default value is . 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. - 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 . @@ -4896,7 +4896,7 @@ The following example moves a file. The token to monitor for cancellation requests. The default value is . 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. - 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 . @@ -4930,7 +4930,7 @@ The following example moves a file. The token to monitor for cancellation requests. The default value is . 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. - 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 . @@ -6401,7 +6401,7 @@ It is not possible to change the compression status of a o The token to monitor for cancellation requests. The default value is . 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. - 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 . @@ -6848,7 +6848,7 @@ It is not possible to change the compression status of a o The token to monitor for cancellation requests. The default value is . 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. - 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 . @@ -6894,7 +6894,7 @@ It is not possible to change the compression status of a o The token to monitor for cancellation requests. The default value is . 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. - 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 . @@ -7149,7 +7149,7 @@ It is not possible to change the compression status of a o The token to monitor for cancellation requests. The default value is . 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. - 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 . @@ -7196,7 +7196,7 @@ It is not possible to change the compression status of a o The token to monitor for cancellation requests. The default value is . 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. - 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 . diff --git a/xml/System.IO/FileStream.xml b/xml/System.IO/FileStream.xml index 6680db14eac..5f3eeab2728 100644 --- a/xml/System.IO/FileStream.xml +++ b/xml/System.IO/FileStream.xml @@ -2756,7 +2756,9 @@ Calling `DisposeAsync` allows the resources used by the value for the property. If the handle to the file is disposed, the returned task contains the exception in 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 stream has been disposed. Cancellation @@ -3559,6 +3561,8 @@ Use the property to determine whether the If the operation is canceled before it completes, the returned task contains the value for the property. If the handle to the file is disposed, the returned task contains the exception in 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 . + ## Examples The following example shows how to read from a file asynchronously. @@ -3566,7 +3570,7 @@ The following example shows how to read from a file asynchronously. :::code language="csharp" source="~/snippets/csharp/System.IO/FileStream/Overview/example4.cs" id="Snippet4"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Asynchronous_File_IO_async/vb/example4.vb" id="Snippet4"::: - ]]> +]]> is . @@ -4306,7 +4310,9 @@ If the operation is canceled before it completes, the returned task contains the :::code language="csharp" source="~/snippets/csharp/System.IO/FileStream/Overview/example3.cs" id="Snippet3"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Asynchronous_File_IO_async/vb/example3.vb" id="Snippet3"::: - ]]> + 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 . diff --git a/xml/System.IO/MemoryStream.xml b/xml/System.IO/MemoryStream.xml index c4d1686b4d9..50ecf0e9ace 100644 --- a/xml/System.IO/MemoryStream.xml +++ b/xml/System.IO/MemoryStream.xml @@ -1132,7 +1132,7 @@ The stream is unwritable. The token to monitor for cancellation requests. Asynchronously reads all the bytes from the current stream and writes them to another stream, using a specified buffer size and cancellation token. A task that represents the asynchronous copy operation. - 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 . is . @@ -1448,7 +1448,9 @@ The pending operation does not support writing. You can create a cancellation token by creating an instance of the class and passing the property as the `cancellationToken` parameter. - ]]> + This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . + +]]> The stream has been disposed. Cancellation @@ -1957,7 +1959,9 @@ The pending operation does not support writing. You can create a cancellation token by creating an instance of the class and passing the property as the `cancellationToken` parameter. - ]]> + This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . + +]]> is . @@ -2593,7 +2597,9 @@ The underlying buffer will not be exposed if the current `MemoryStream` instance You can create a cancellation token by creating an instance of the class and passing the property as the `cancellationToken` parameter. - ]]> + This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . + +]]> is . diff --git a/xml/System.IO/RandomAccess.xml b/xml/System.IO/RandomAccess.xml index 2d5be6dce4c..ad877f52d98 100644 --- a/xml/System.IO/RandomAccess.xml +++ b/xml/System.IO/RandomAccess.xml @@ -188,7 +188,9 @@ Position of the file is not advanced. Position of the file is not advanced. - ]]> +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 . @@ -420,7 +422,9 @@ Position of the file is not advanced. Position of the file is not advanced. - ]]> +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 . diff --git a/xml/System.IO/Stream.xml b/xml/System.IO/Stream.xml index 449306dcabb..25140ca395b 100644 --- a/xml/System.IO/Stream.xml +++ b/xml/System.IO/Stream.xml @@ -865,15 +865,15 @@ Copying begins at the current position in the current stream. - + 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 . ## Examples The following example demonstrates how to use two objects to asynchronously copy the files from one directory to another. The class derives from the class. Notice that the event handler for the control is marked with the `async` modifier because it calls an asynchronous method :::code language="csharp" source="~/snippets/csharp/System.IO/FileStream/Overview/example.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Asynchronous_File_IO_async/vb/example.vb" id="Snippet1"::: - - ]]> + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Asynchronous_File_IO_async/vb/example.vb" id="Snippet1"::: + +]]> is . @@ -942,7 +942,9 @@ For an example of copying between two streams, see the overload. - ]]> + 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 . @@ -1002,7 +1004,9 @@ For an example of copying between two streams, see the overload. - ]]> + 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 . + +]]> @@ -1071,7 +1075,9 @@ For an example of copying between two streams, see the overload. - ]]> + 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 . @@ -1331,7 +1337,9 @@ Calling `DisposeAsync` allows the resources used by the to be reallocated for other purposes. For more information, see [Cleaning Up Unmanaged Resources](/dotnet/standard/garbage-collection/unmanaged). - ]]> + 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 . + +]]> @@ -1598,7 +1606,9 @@ ## Remarks If a derived class, such as or , does not flush the buffer in its implementation of the method, the method will not flush the buffer. - ]]> + 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. @@ -1660,7 +1670,9 @@ If a derived class, such as or , does not flush the buffer in its implementation of the method, the method will not flush the buffer. - ]]> + 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. Cancellation @@ -2133,15 +2145,15 @@ Use the property to determine whether the current instance supports reading. - + 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 . ## Examples The following example shows how to read from a file asynchronously. The example uses the class, which derives from the class. :::code language="csharp" source="~/snippets/csharp/System.IO/FileStream/Overview/example4.cs" id="Snippet4"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Asynchronous_File_IO_async/vb/example4.vb" id="Snippet4"::: - - ]]> + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Asynchronous_File_IO_async/vb/example4.vb" id="Snippet4"::: + +]]> is . @@ -2220,7 +2232,9 @@ For an example, see the overload. - ]]> + 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 . @@ -2595,7 +2609,9 @@ When `buffer` is empty, this read operation will be completed without waiting fo When `count` is 0 (zero), this read operation will be completed without waiting for available data in the stream. - ]]> +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 . @@ -3222,15 +3238,15 @@ This member is an explicit interface member implementation. It can be used only Use the property to determine whether the current instance supports writing. - + 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 . ## Examples The following example shows how to write asynchronously to a file. The example uses the class, which derives from the class. :::code language="csharp" source="~/snippets/csharp/System.IO/FileStream/Overview/example3.cs" id="Snippet3"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Asynchronous_File_IO_async/vb/example3.vb" id="Snippet3"::: - - ]]> + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Asynchronous_File_IO_async/vb/example3.vb" id="Snippet3"::: + +]]> is . @@ -3309,7 +3325,9 @@ This member is an explicit interface member implementation. It can be used only For an example, see the overload. - ]]> + 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 . diff --git a/xml/System.IO/StreamReader.xml b/xml/System.IO/StreamReader.xml index 48b8dcf8862..b4882806ea8 100644 --- a/xml/System.IO/StreamReader.xml +++ b/xml/System.IO/StreamReader.xml @@ -2018,17 +2018,17 @@ Following a call to , any operations on th , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . ## Examples The following example shows how to read all the characters in a file by using the method. It checks whether each character is a letter, digit, or white space before adding the character to an instance of the class. :::code language="csharp" source="~/snippets/csharp/System.IO/StreamReader/Overview/example42.cs" id="Snippet42"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.IO.StreamReader/VB/example42.vb" id="Snippet42"::: - - ]]> + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.IO.StreamReader/VB/example42.vb" id="Snippet42"::: + +]]> is . @@ -2260,7 +2260,9 @@ Following a call to , any operations on th ## Remarks The task does not complete until either the number of characters specified by the `count` parameter are read, or the end of the stream has been reached. - ]]> + 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 . @@ -2404,15 +2406,19 @@ Following a call to , any operations on th Reads a line of characters asynchronously from the current stream and returns the data as a string. A task that represents the asynchronous read operation. The value of the parameter contains the next line from the stream, or is if all the characters have been read. - , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . ## Examples The following example shows how to read the first line of a file by using the method. :::code language="csharp" source="~/snippets/csharp/System.IO/StreamReader/Overview/example41.cs" id="Snippet41"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.IO.StreamReader/VB/example41.vb" id="Snippet41"::: - - ]]> + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.IO.StreamReader/VB/example41.vb" id="Snippet41"::: + +]]> The number of characters in the next line is larger than Int32.MaxValue. The stream has been disposed. @@ -2458,11 +2464,11 @@ Following a call to , any operations on th ## Remarks -If this method is canceled via `cancellationToken`, some data - that has been read from the current but not stored (by the - ) or returned (to the caller) may be lost. +If this method is canceled via `cancellationToken`, some data that has been read from the current but not stored (by the ) or returned (to the caller) may be lost. + +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 number of characters in the next line is larger than Int32.MaxValue. The stream reader has been disposed. @@ -2604,15 +2610,19 @@ If this method is canceled via `cancellationToken`, some data Reads all characters from the current position to the end of the stream asynchronously and returns them as one string. A task that represents the asynchronous read operation. The value of the parameter contains a string with the characters from the current position to the end of the stream. - , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . ## Examples The following example shows how to read the contents of a file by using the method. :::code language="csharp" source="~/snippets/csharp/System.IO/StreamReader/Overview/example40.cs" id="Snippet40"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.IO.StreamReader/VB/example40.vb" id="Snippet40"::: - - ]]> + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.IO.StreamReader/VB/example40.vb" id="Snippet40"::: + +]]> The number of characters is larger than Int32.MaxValue. The stream has been disposed. @@ -2662,7 +2672,9 @@ If this method is canceled via `cancellationToken`, some data that has been read from the current but not stored (by the ) or returned (to the caller) may be lost. - ]]> +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 number of characters is larger than Int32.MaxValue. The stream reader has been disposed. diff --git a/xml/System.IO/StreamWriter.xml b/xml/System.IO/StreamWriter.xml index 9cc74d73399..b36a835ea42 100644 --- a/xml/System.IO/StreamWriter.xml +++ b/xml/System.IO/StreamWriter.xml @@ -1454,7 +1454,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 task that represents the asynchronous flush operation. - 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 stream has been disposed. @@ -2202,15 +2202,19 @@ See Asynchronously writes a character to the stream. A task that represents the asynchronous write operation. - , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . ## Examples The following example shows how to write a single character (the letter "a") to a text file by using the method. :::code language="csharp" source="~/snippets/csharp/System.IO/StreamWriter/AutoFlush/example20.cs" id="Snippet20"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.IO.StreamWriter/VB/example20.vb" id="Snippet20"::: - - ]]> + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.IO.StreamWriter/VB/example20.vb" id="Snippet20"::: + +]]> The stream writer is disposed. The stream writer is currently in use by a previous write operation. @@ -2270,15 +2274,19 @@ See Asynchronously writes a string to the stream. A task that represents the asynchronous write operation. - , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . ## Examples The following example shows how to write a string to a text file by using the method. :::code language="csharp" source="~/snippets/csharp/System.IO/StreamWriter/AutoFlush/example21.cs" id="Snippet21"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.IO.StreamWriter/VB/example21.vb" id="Snippet21"::: - - ]]> + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.IO.StreamWriter/VB/example21.vb" id="Snippet21"::: + +]]> The stream writer is disposed. The stream writer is currently in use by a previous write operation. @@ -2384,15 +2392,19 @@ See Asynchronously writes a subarray of characters to the stream. A task that represents the asynchronous write operation. - , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . ## Examples The following example shows how to write multiple characters to a text file by using the method. :::code language="csharp" source="~/snippets/csharp/System.IO/StreamWriter/AutoFlush/example24.cs" id="Snippet24"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.IO.StreamWriter/VB/example24.vb" id="Snippet24"::: - - ]]> + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.IO.StreamWriter/VB/example24.vb" id="Snippet24"::: + +]]> is . @@ -2954,17 +2966,17 @@ See property. - - + The line terminator is defined by 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 . ## Examples The following example shows how to write two lines that consist of string values to a text file by using the method. :::code language="csharp" source="~/snippets/csharp/System.IO/StreamWriter/AutoFlush/example23.cs" id="Snippet23"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.IO.StreamWriter/VB/example23.vb" id="Snippet23"::: - - ]]> + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.IO.StreamWriter/VB/example23.vb" id="Snippet23"::: + +]]> The stream writer is disposed. The stream writer is currently in use by a previous write operation. diff --git a/xml/System.IO/StringReader.xml b/xml/System.IO/StringReader.xml index eb09c8ab3ee..80e2be716a9 100644 --- a/xml/System.IO/StringReader.xml +++ b/xml/System.IO/StringReader.xml @@ -731,16 +731,16 @@ This implementation of `Close` calls the , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . ## Examples The following example shows how to read the first 23 characters of a string asynchronously. :::code language="csharp" source="~/snippets/csharp/System.IO/StringReader/Overview/example1.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.io.stringreader/vb/example1.vb" id="Snippet1"::: - - ]]> + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.io.stringreader/vb/example1.vb" id="Snippet1"::: + +]]> is . @@ -1072,15 +1072,19 @@ This implementation of `Close` calls the Reads a line of characters asynchronously from the current string and returns the data as a string. A task that represents the asynchronous read operation. The value of the parameter contains the next line from the string reader, or is if all the characters have been read. - , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . ## Examples The following example shows how to read one line at a time from a string asynchronously. :::code language="csharp" source="~/snippets/csharp/System.IO/StringReader/Overview/example3.cs" id="Snippet3"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.io.stringreader/vb/example3.vb" id="Snippet3"::: - - ]]> + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.io.stringreader/vb/example3.vb" id="Snippet3"::: + +]]> The number of characters in the next line is larger than Int32.MaxValue. The string reader has been disposed. @@ -1121,7 +1125,7 @@ This implementation of `Close` calls the The token to monitor for cancellation requests. Reads a line of characters asynchronously from the current string and returns the data as a string. A value task that represents the asynchronous read operation. The value of the TResult parameter contains the next line from the string reader, or is if all of the characters have been read. - 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 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. @@ -1263,15 +1267,19 @@ This implementation of `Close` calls the Reads all characters from the current position to the end of the string asynchronously and returns them as a single string. A task that represents the asynchronous read operation. The value of the parameter contains a string with the characters from the current position to the end of the string. - , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . ## Examples The following example shows how to read an entire string asynchronously. :::code language="csharp" source="~/snippets/csharp/System.IO/StringReader/Overview/example2.cs" id="Snippet2"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.io.stringreader/vb/example2.vb" id="Snippet2"::: - - ]]> + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.io.stringreader/vb/example2.vb" id="Snippet2"::: + +]]> The number of characters is larger than Int32.MaxValue. The string reader has been disposed. @@ -1312,7 +1320,7 @@ This implementation of `Close` calls the The token to monitor for cancellation requests. Reads all characters from the current position to the end of the string asynchronously and returns them as a single string. A task that represents the asynchronous read operation. The value of the TResult parameter contains a string with the characters from the current position to the end of the string. - 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 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. diff --git a/xml/System.IO/StringWriter.xml b/xml/System.IO/StringWriter.xml index 84c1bccb5cf..59104be8e91 100644 --- a/xml/System.IO/StringWriter.xml +++ b/xml/System.IO/StringWriter.xml @@ -1323,15 +1323,19 @@ Writes a character to the string asynchronously. A task that represents the asynchronous write operation. - , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . ## Examples The following example shows how to write characters by using the method. :::code language="csharp" source="~/snippets/csharp/System.IO/StringWriter/WriteAsync/example5.cs" id="Snippet5"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.io.stringwriter/vb/example5.vb" id="Snippet5"::: - - ]]> + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.io.stringwriter/vb/example5.vb" id="Snippet5"::: + +]]> The string writer is disposed. The string writer is currently in use by a previous write operation. @@ -1391,15 +1395,19 @@ Writes a string to the current string asynchronously. A task that represents the asynchronous write operation. - , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . ## Examples The following example shows how to write a string by using the method. :::code language="csharp" source="~/snippets/csharp/System.IO/StringWriter/WriteAsync/example4.cs" id="Snippet4"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.io.stringwriter/vb/example4.vb" id="Snippet4"::: - - ]]> + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.io.stringwriter/vb/example4.vb" id="Snippet4"::: + +]]> The string writer is disposed. The string writer is currently in use by a previous write operation. @@ -1487,7 +1495,7 @@ The token to monitor for cancellation requests. The default value is . Asynchronously writes the text representation of a string builder to the string. A task that represents the asynchronous write operation. - 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 . @@ -1547,15 +1555,19 @@ Writes a subarray of characters to the string asynchronously. A task that represents the asynchronous write operation. - , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . ## Examples The following example shows how to write characters by using the method. :::code language="csharp" source="~/snippets/csharp/System.IO/StringWriter/WriteAsync/example6.cs" id="Snippet6"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.io.stringwriter/vb/example6.vb" id="Snippet6"::: - - ]]> + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.io.stringwriter/vb/example6.vb" id="Snippet6"::: + +]]> is . @@ -1884,7 +1896,7 @@ The following example shows how to write a string by using the The token to monitor for cancellation requests. The default value is . 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. - 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 . diff --git a/xml/System.IO/TextReader.xml b/xml/System.IO/TextReader.xml index c35ab9d2ed3..8ec9f884c13 100644 --- a/xml/System.IO/TextReader.xml +++ b/xml/System.IO/TextReader.xml @@ -796,7 +796,9 @@ The class is an abstract class. Therefore, you do not instantiate it in your code. For an example of using the method, see the method. - ]]> + 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 . @@ -1039,7 +1041,9 @@ ## Remarks The task does not complete until either the number of characters specified by the `count` parameter are read, or the end of the text has been reached. - ]]> + 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 . @@ -1184,7 +1188,9 @@ If the current represents the standard input stream returned by the property, the method executes synchronously rather than asynchronously. - ]]> + 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 number of characters in the next line is larger than Int32.MaxValue. The text reader has been disposed. @@ -1243,7 +1249,9 @@ If the current represents the standard input stream the `Console.In` property, the method executes synchronously rather than asynchronously. - ]]> +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 number of characters in the next line is larger than Int32.MaxValue. The text reader has been disposed. @@ -1377,7 +1385,9 @@ If the current represents the standard input stream ## Remarks The class is an abstract class. Therefore, you do not instantiate it in your code. For an example of using the method, see the method. - ]]> + 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 number of characters is larger than Int32.MaxValue. The text reader has been disposed. @@ -1432,7 +1442,9 @@ The class is an abstract class. Therefore, you do no your code. For an example of using the method, see the method. - ]]> +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 number of characters is larger than Int32.MaxValue. The text reader has been disposed. diff --git a/xml/System.IO/TextWriter.xml b/xml/System.IO/TextWriter.xml index cb101893133..d94a4ca4692 100644 --- a/xml/System.IO/TextWriter.xml +++ b/xml/System.IO/TextWriter.xml @@ -549,7 +549,7 @@ Asynchronously releases all resources used by the object. A task that represents the asynchronous dispose operation. - 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 . @@ -723,7 +723,7 @@ Asynchronously clears all buffers for the current writer and causes any buffered data to be written to the underlying device. A task that represents the asynchronous flush operation. - 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 text writer is disposed. The writer is currently in use by a previous write operation. @@ -2586,7 +2586,9 @@ This method is equivalent to `Write(stringBuilder.ToString())`, but it uses the ## Remarks The class is an abstract class. Therefore, you do not instantiate it in your code. For an example of using the method, see the method. - ]]> + 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 text writer is disposed. The text writer is currently in use by a previous write operation. @@ -2647,7 +2649,7 @@ This method is equivalent to `Write(stringBuilder.ToString())`, but it uses the The character array to write to the text stream. If is , nothing is written. Writes a character array to the text stream asynchronously. A task that represents the asynchronous write operation. - 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 text writer is disposed. The text writer is currently in use by a previous write operation. @@ -2713,7 +2715,9 @@ This method is equivalent to `Write(stringBuilder.ToString())`, but it uses the ## Remarks The class is an abstract class. Therefore, you do not instantiate it in your code. For an example of using the method, see the method. - ]]> + 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 text writer is disposed. The text writer is currently in use by a previous write operation. @@ -2810,7 +2814,9 @@ This method is equivalent to `Write(stringBuilder.ToString())`, but it uses the This method is equivalent to calling `WriteAsync(stringBuilder.ToString())`, however, it uses the method to avoid creating the intermediate string. - ]]> +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 . + +]]> @@ -2876,7 +2882,9 @@ This method is equivalent to calling `WriteAsync(stringBuilder.ToString())`, how ## Remarks The class is an abstract class. Therefore, you do not instantiate it in your code. For an example of using the method, see the method. - ]]> + 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 . @@ -4548,7 +4556,9 @@ The class is an abstract class. Therefore, you do no The line terminator is defined by the field. - ]]> +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 text writer is disposed. The text writer is currently in use by a previous write operation. @@ -4615,7 +4625,9 @@ The line terminator is defined by the fi The class is an abstract class. Therefore, you do not instantiate it in your code. For an example of using the method, see the method. - ]]> + 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 text writer is disposed. The text writer is currently in use by a previous write operation. @@ -4682,7 +4694,9 @@ The line terminator is defined by the fi ## Remarks The line terminator is defined by the field. - ]]> + 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 text writer is disposed. The text writer is currently in use by a previous write operation. @@ -4751,7 +4765,9 @@ The line terminator is defined by the fi The class is an abstract class. Therefore, you do not instantiate it in your code. For an example of using the method, see the method. - ]]> + 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 text writer is disposed. The text writer is currently in use by a previous write operation. @@ -4856,7 +4872,9 @@ The line terminator is defined by the fi The line terminator is defined by the field. - ]]> +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 . + +]]> @@ -4923,7 +4941,9 @@ The line terminator is defined by the fi The line terminator is defined by the field. - ]]> +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 . diff --git a/xml/System.IO/UnmanagedMemoryStream.xml b/xml/System.IO/UnmanagedMemoryStream.xml index 8606d836470..10abfa87a0d 100644 --- a/xml/System.IO/UnmanagedMemoryStream.xml +++ b/xml/System.IO/UnmanagedMemoryStream.xml @@ -833,7 +833,9 @@ ## Remarks If the operation isn't cancelled, the calls the method, which means that no action performed. - ]]> + 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 . + +]]> @@ -1432,7 +1434,9 @@ This method is equivalent to the of the property of the returned task. - ]]> + 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 . + +]]> @@ -1898,7 +1902,9 @@ If an exception occurs during the write operation, it will be set as the of the property of the returned task. - ]]> + 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 . + +]]> diff --git a/xml/System.IdentityModel.Selectors/SecurityTokenProvider.xml b/xml/System.IdentityModel.Selectors/SecurityTokenProvider.xml index 8a0e7157d4d..2196d703ec1 100644 --- a/xml/System.IdentityModel.Selectors/SecurityTokenProvider.xml +++ b/xml/System.IdentityModel.Selectors/SecurityTokenProvider.xml @@ -460,7 +460,9 @@ The method calls method. - ]]> + 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 . + +]]> @@ -546,7 +548,9 @@ When the method is overridden and the security token passed into the token parameter cannot be canceled, throw the exception. - ]]> + 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 . + +]]> @@ -880,7 +884,9 @@ In most cases the `timeout` parameter is not used by derived classes of such as . However, sometimes retrieving a security token involves distributed messaging. An example is used in a federated service. In these cases the `timeout` parameter is used to avoid exceptions caused by network failures, message loss, and other error conditions. - ]]> + 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 . + +]]> @@ -967,8 +973,11 @@ The method is called by the class when a client sends a SOAP message and a security token is required. - The method calls the method. - ]]> + The method calls the method. + + 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 . + +]]> @@ -1058,7 +1067,9 @@ The method calls the method. - ]]> + 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 . + +]]> @@ -1152,7 +1163,9 @@ The method calls the method. - ]]> + 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 . + +]]> diff --git a/xml/System.Media/SoundPlayer.xml b/xml/System.Media/SoundPlayer.xml index dca88013f57..ab0386569aa 100644 --- a/xml/System.Media/SoundPlayer.xml +++ b/xml/System.Media/SoundPlayer.xml @@ -375,7 +375,9 @@ :::code language="csharp" source="~/snippets/csharp/System.Media/SoundPlayer/Overview/soundtestform.cs" id="Snippet3"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.Sound/VB/soundtestform.vb" id="Snippet3"::: - ]]> + 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 elapsed time during loading exceeds the time, in milliseconds, specified by . The file specified by cannot be found. diff --git a/xml/System.Net.Http/HttpClient.xml b/xml/System.Net.Http/HttpClient.xml index ea9727d777e..ad1220da893 100644 --- a/xml/System.Net.Http/HttpClient.xml +++ b/xml/System.Net.Http/HttpClient.xml @@ -3231,7 +3231,10 @@ The custom does not override > - is thrown on all applicable .NET Framework versions. > - without any inner exception is thrown on all applicable .NET Core versions. > - that nests a is thrown on .NET 5 and later versions. - ]]> + +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 . The request message was already sent by the instance. @@ -3287,7 +3290,10 @@ The custom does not override > - is thrown on all applicable .NET Framework versions. > - without any inner exception is thrown on all applicable .NET Core versions. > - that nests a is thrown on .NET 5 and later versions. - ]]> + +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 . The request message was already sent by the instance. @@ -3343,7 +3349,10 @@ The custom does not override > - is thrown on all applicable .NET Framework versions. > - without any inner exception is thrown on all applicable .NET Core versions. > - that nests a is thrown on .NET 5 and later versions. - ]]> + +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 . The request message was already sent by the instance. @@ -3401,7 +3410,10 @@ The custom does not override > - is thrown on all applicable .NET Framework versions. > - without any inner exception is thrown on all applicable .NET Core versions. > - that nests a is thrown on .NET 5 and later versions. - ]]> + +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 . The request message was already sent by the instance. diff --git a/xml/System.Net.Http/HttpContent.xml b/xml/System.Net.Http/HttpContent.xml index 93155e8f585..bda1b4c67db 100644 --- a/xml/System.Net.Http/HttpContent.xml +++ b/xml/System.Net.Http/HttpContent.xml @@ -952,7 +952,9 @@ When the `disposing` parameter is `true`, this method releases all resources hel Once the operation completes, the property on the returned task object contains the stream that represents the HTTP content. The returned stream can then be used to read the content using various stream APIs. - ]]> + 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 . + +]]> @@ -991,7 +993,9 @@ When the `disposing` parameter is `true`, this method releases all resources hel Once the operation completes, the property on the returned task object contains the stream that represents the HTTP content. The returned stream can then be used to read the content using various stream APIs. - ]]> + 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 . + +]]> diff --git a/xml/System.Net.NetworkInformation/IPGlobalProperties.xml b/xml/System.Net.NetworkInformation/IPGlobalProperties.xml index e64aa37df95..96152a922ea 100644 --- a/xml/System.Net.NetworkInformation/IPGlobalProperties.xml +++ b/xml/System.Net.NetworkInformation/IPGlobalProperties.xml @@ -1200,7 +1200,9 @@ The method also returns non-Teredo addresses and provides a more convenient way to obtain the unicast IP addresses for a system than enumerating all the objects on a local computer and querying the associated IP addresses. - ]]> + 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 call to the native function failed. The caller does not have necessary permission. diff --git a/xml/System.Net.Security/NegotiateStream.xml b/xml/System.Net.Security/NegotiateStream.xml index 2b1d61f044d..9fd72f8f1cc 100644 --- a/xml/System.Net.Security/NegotiateStream.xml +++ b/xml/System.Net.Security/NegotiateStream.xml @@ -669,7 +669,9 @@ The following example demonstrates calling this constructor. This code example i If the authentication fails, you receive an or an . In this case, you can retry the authentication with a different credential. - ]]> + 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 authentication failed. You can use this object to retry the authentication. The authentication failed. You can use this object to retry the authentication. @@ -729,7 +731,9 @@ The following example demonstrates calling this constructor. This code example i When authentication succeeds, you must check the and properties to determine what security services are used by the . Check the property to determine whether mutual authentication occurred. - ]]> + 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 authentication failed. You can use this object to retry the authentication. The authentication failed. You can use this object to retry the authentication. @@ -796,7 +800,9 @@ The following example demonstrates calling this constructor. This code example i When authentication succeeds, you must check the and properties to determine what security services are used by the . Check the property to determine whether mutual authentication occurred. - ]]> + 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 . @@ -868,7 +874,9 @@ The following example demonstrates calling this constructor. This code example i If the authentication fails, you receive an or an . In this case, you can retry the authentication with a different credential. - ]]> + 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 not a valid value. @@ -941,7 +949,9 @@ The following example demonstrates calling this constructor. This code example i If the authentication fails, you receive an or an . In this case, you can retry the authentication with a different credential. - ]]> + 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 . @@ -1327,7 +1337,9 @@ The following example demonstrates calling this constructor. This code example i If the authentication fails, you receive an or an . In this case, you can retry the authentication with a different credential. - ]]> + 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 authentication failed. You can use this object to retry the authentication. The authentication failed. You can use this object to retry the authentication. @@ -1386,7 +1398,9 @@ The following example demonstrates calling this constructor. This code example i If the authentication fails, you receive an or an . In this case, you can retry the authentication with a different credential. - ]]> + 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 and on the extended protection policy passed in the parameter are both . The authentication failed. You can use this object to retry the authentication. @@ -1448,7 +1462,9 @@ The following example demonstrates calling this constructor. This code example i If the authentication fails, you receive an or an . In this case, you can retry the authentication with a different credential. - ]]> + 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 . @@ -1520,7 +1536,9 @@ The following example demonstrates calling this constructor. This code example i If the authentication fails, you receive an or an . In this case, you can retry the authentication with a different credential. - ]]> + 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 and on the extended protection policy passed in the parameter are both . @@ -3229,7 +3247,9 @@ Authentication has not occurred. ## Remarks This method invokes on the underlying stream. - ]]> + 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 . + +]]> @@ -3859,7 +3879,9 @@ This method reads asynchronously as much data as is available into `buffer` and You cannot call this method until you have successfully authenticated. To authenticate, call one of the , , , , , or methods. - ]]> + 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 read operation failed. Authentication has not occurred. @@ -4261,7 +4283,9 @@ This method reads asynchronously as much data as is available into `buffer` and You cannot call this method until you have successfully authenticated. To authenticate, call one of the , , , , , or methods. - ]]> + 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 . + +]]> diff --git a/xml/System.Net.Security/SslStream.xml b/xml/System.Net.Security/SslStream.xml index 52905620c6d..ca995cbc4ff 100644 --- a/xml/System.Net.Security/SslStream.xml +++ b/xml/System.Net.Security/SslStream.xml @@ -828,7 +828,9 @@ If the authentication fails, you receive a , and this is no longer useable. You should close this object and remove all references to it so that it can be collected by the garbage collector. - ]]> + 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 . @@ -888,7 +890,9 @@ If the authentication fails, you receive a , and this is no longer useable. You should close this object and remove all references to it so that it can be collected by the garbage collector. - ]]> + 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 . @@ -958,7 +962,9 @@ > [!NOTE] > Client certificates are not supported in the SSL version 2 protocol. - ]]> + 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 authentication failed and left this object in an unusable state. Authentication has already occurred. @@ -1031,7 +1037,9 @@ > [!NOTE] > Client certificates are not supported in the SSL version 2 protocol. - ]]> + 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 authentication failed and left this object in an unusable state. Authentication has already occurred. @@ -1378,7 +1386,9 @@ If the authentication fails, you receive a , and this is no longer useable. You should close this object and remove all references to it so that it can be collected by the garbage collector. - ]]> + 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 . @@ -1437,7 +1447,9 @@ If the authentication fails, you receive a , and this is no longer useable. You should close this object and remove all references to it so that it can be collected by the garbage collector. - ]]> + 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 . + +]]> Either or or is and is not set in the constructor. @@ -1557,7 +1569,9 @@ If the authentication fails, you receive a , and this is no longer useable. You should close this object and remove all references to it so that it can be collected by the garbage collector. - ]]> + 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 . @@ -1626,7 +1640,9 @@ If the authentication fails, you receive a , and this is no longer useable. You should close this object and remove all references to it so that it can be collected by the garbage collector. - ]]> + 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 . @@ -3224,7 +3240,9 @@ Authentication has not occurred. ## Remarks This method invokes on the underlying stream. - ]]> + 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 . + +]]> @@ -4160,7 +4178,9 @@ This property gets the cipher suite that is going to be used in the communicatio You cannot call this method until you have successfully authenticated. - ]]> + 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 . @@ -4829,7 +4849,9 @@ You cannot call this method until you have successfully authenticated. The class does not support multiple simultaneous write operations. - ]]> + 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 . diff --git a/xml/System.Net.Sockets/NetworkStream.xml b/xml/System.Net.Sockets/NetworkStream.xml index 0e7bc10eaba..beaef1fe799 100644 --- a/xml/System.Net.Sockets/NetworkStream.xml +++ b/xml/System.Net.Sockets/NetworkStream.xml @@ -1272,7 +1272,9 @@ The Close method frees both unmanaged and managed resources associated with the ## Remarks This operation will not block. The returned object will complete after data has been flushed from the stream for the 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 . + +]]> @@ -1691,7 +1693,9 @@ There is a failure reading from the network. > [!NOTE] > If you receive an , check the property to determine if it was caused by a . If so, use the property to obtain the specific error code and refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. - ]]> + 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 does not support reading. An error occurred when accessing the socket. @@ -2329,6 +2333,8 @@ This method starts at the specified `offset` and sends `size` bytes from the con > [!NOTE] > If you receive an , check the property to determine if it was caused by a . If so, use the property to obtain the specific error code and refer to the Windows Sockets version 2 API error code documentation for a detailed description of the error. +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 parameter is . diff --git a/xml/System.Net.Sockets/Socket.xml b/xml/System.Net.Sockets/Socket.xml index c0fa6894427..97bad457c62 100644 --- a/xml/System.Net.Sockets/Socket.xml +++ b/xml/System.Net.Sockets/Socket.xml @@ -453,7 +453,7 @@ This method populates the instance with data ga Accepts an incoming connection. An asynchronous task that completes with the accepted Socket. - 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 . An invalid operation was requested. This exception occurs if the accepting is not listening for connections or the accepted socket is bound. You must call the and method before calling the method. @@ -628,7 +628,7 @@ This method populates the instance with data ga A cancellation token that can be used to cancel the asynchronous operation. Accepts an incoming connection. An asynchronous task that completes with the accepted Socket. - 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 . An invalid operation was requested. This exception occurs if the accepting is not listening for connections or the accepted socket is bound. You must call the and method before calling the method. @@ -3897,7 +3897,7 @@ This method populates the instance with data ga The endpoint to connect to. Establishes a connection to a remote host. An asynchronous task that completes when the connection is established. - 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 parameter cannot be null. The is listening. An error occurred when attempting to access the socket. @@ -4036,7 +4036,7 @@ This method populates the instance with data ga A cancellation token that can be used to cancel the asynchronous operation. Establishes a connection to a remote host. An asynchronous task that completes when the connection is established. - 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 parameter cannot be null. The is listening. An error occurred when attempting to access the socket. @@ -4079,7 +4079,7 @@ This method populates the instance with data ga The port on the remote host to connect to. Establishes a connection to a remote host. An asynchronous task that completes when the connection is established. - 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 parameter cannot be null. is less than . @@ -4128,7 +4128,7 @@ This method populates the instance with data ga The port on the remote host to connect to. Establishes a connection to a remote host. An asynchronous task that completes when the connection is established. - 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 parameter cannot be null. The parameter cannot be empty array. @@ -4178,7 +4178,7 @@ This method populates the instance with data ga The port on the remote host to connect to. Establishes a connection to a remote host. An asynchronous task that completes when the connection is established. - 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 parameter cannot be null. is less than . @@ -4229,7 +4229,7 @@ This method populates the instance with data ga A cancellation token that can be used to cancel the asynchronous operation. Establishes a connection to a remote host. An asynchronous task that completes when the connection is established. - 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 parameter cannot be null. is less than . @@ -4279,7 +4279,7 @@ This method populates the instance with data ga A cancellation token that can be used to cancel the asynchronous operation. Establishes a connection to a remote host. An asynchronous task that completes when the connection is established. - 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 parameter cannot be null. The parameter cannot be empty array. @@ -4424,7 +4424,7 @@ This method populates the instance with data ga A cancellation token that can be used to cancel the asynchronous operation. Establishes a connection to a remote host. An asynchronous task that completes when the connection is established. - 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 parameter cannot be null. is less than . @@ -4668,7 +4668,7 @@ This method populates the instance with data ga A cancellation token that can be used to cancel the asynchronous operation. Disconnects a connected socket from the remote host. An asynchronous task that completes when the socket is disconnected. - 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 object has been closed. An error occurred when attempting to access the socket. @@ -8732,7 +8732,7 @@ If you're using a connectionless , A list of buffers for the received data. Receives data from a connected socket. An asynchronous task that completes with the number of bytes received. - 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 parameter was null. The has been closed. An error occurred when attempting to access the socket. @@ -8900,7 +8900,7 @@ If you're using a connectionless , A bitwise combination of SocketFlags values that will be used when receiving the data. Receives data from a connected socket. An asynchronous task that completes with the number of bytes received. - 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 parameter was null. The has been closed. An error occurred when attempting to access the socket. @@ -11616,7 +11616,7 @@ This member outputs trace information when you enable network tracing in your ap A list of buffers for the data to send. Sends data on a connected socket. An asynchronous task that completes with the number of bytes sent. - 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 . is . An error occurred when attempting to access the socket. @@ -11785,7 +11785,7 @@ This member outputs trace information when you enable network tracing in your ap A bitwise combination of SocketFlags values that will be used when sending the data. Sends data on a connected socket. An asynchronous task that completes with the number of bytes sent. - 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 . is . An error occurred when attempting to access the socket. @@ -12181,7 +12181,7 @@ This member outputs trace information when you enable network tracing in your ap A cancellation token that can be used to cancel the asynchronous operation. Sends the file to a connected object. A value task that represents the asynchronous send file operation. - 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 object has been closed. The object is not connected to a remote host. The file was not found. diff --git a/xml/System.Net.Sockets/TcpClient.xml b/xml/System.Net.Sockets/TcpClient.xml index deed3657a47..150c53b66c0 100644 --- a/xml/System.Net.Sockets/TcpClient.xml +++ b/xml/System.Net.Sockets/TcpClient.xml @@ -1169,7 +1169,9 @@ The `Available` property is a way to determine whether data is queued for readin > [!NOTE] > If you receive a `NotSupportedException` with the message "This protocol version is not supported" while using IPv6 address, make sure you enabled IPv6 in the constructor by passing . - ]]> + 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 . + +]]> @@ -1230,7 +1232,9 @@ The `Available` property is a way to determine whether data is queued for readin > [!NOTE] > If you receive NotSupportedException with message `This protocol version is not supported` while using IPv6 address, then make sure you enabled IPv6 in constructor by passing . - ]]> + 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 parameter is . The is not between and . @@ -1297,7 +1301,9 @@ The `Available` property is a way to determine whether data is queued for readin > [!NOTE] > If you receive NotSupportedException with message `This protocol version is not supported` while using IPv6 address, then make sure you enabled IPv6 in constructor by passing . - ]]> + 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 parameter is . The port number is not valid. @@ -1353,7 +1359,9 @@ The `Available` property is a way to determine whether data is queued for readin > [!NOTE] > If you receive NotSupportedException with message `This protocol version is not supported` while using IPv6 address, then make sure you enabled IPv6 in constructor by passing . - ]]> + 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 . + +]]> @@ -1413,7 +1421,9 @@ The `Available` property is a way to determine whether data is queued for readin > [!NOTE] > This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in the .NET Framework](/dotnet/framework/network-programming/network-tracing). - ]]> + 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 parameter is . The parameter is not between and . @@ -1472,7 +1482,9 @@ The `Available` property is a way to determine whether data is queued for readin > [!NOTE] > If you receive NotSupportedException with message `This protocol version is not supported` while using IPv6 address, then make sure you enabled IPv6 in constructor by passing . - ]]> + 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 parameter is . The is not between and . @@ -1530,7 +1542,9 @@ The `Available` property is a way to determine whether data is queued for readin > [!NOTE] > If you receive NotSupportedException with message `This protocol version is not supported` while using IPv6 address, then make sure you enabled IPv6 in constructor by passing . - ]]> + 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 parameter is . The port number is not valid. @@ -1588,7 +1602,9 @@ The `Available` property is a way to determine whether data is queued for readin > [!NOTE] > This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in the .NET Framework](/dotnet/framework/network-programming/network-tracing). - ]]> + 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 parameter is . The parameter is not between and . diff --git a/xml/System.Net.Sockets/TcpListener.xml b/xml/System.Net.Sockets/TcpListener.xml index 709ebded0b8..d42bfcfe459 100644 --- a/xml/System.Net.Sockets/TcpListener.xml +++ b/xml/System.Net.Sockets/TcpListener.xml @@ -404,7 +404,9 @@ > [!NOTE] > This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in the .NET Framework](/dotnet/framework/network-programming/network-tracing). - ]]> + 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 listener has not been started with a call to . @@ -449,7 +451,9 @@ > [!NOTE] > This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in the .NET Framework](/dotnet/framework/network-programming/network-tracing). - ]]> + 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 . + +]]> @@ -565,7 +569,9 @@ > [!NOTE] > This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in the .NET Framework](/dotnet/framework/network-programming/network-tracing). - ]]> + 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 listener has not been started with a call to . Use the property to obtain the specific error code. When you have obtained this code, you can refer to the Windows Sockets version 2 API error code documentation for a detailed description of the error. @@ -612,7 +618,9 @@ > [!NOTE] > This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in the .NET Framework](/dotnet/framework/network-programming/network-tracing). - ]]> + 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 . + +]]> diff --git a/xml/System.Net.Sockets/UdpClient.xml b/xml/System.Net.Sockets/UdpClient.xml index 89469b33df8..4a9ebe9c1ce 100644 --- a/xml/System.Net.Sockets/UdpClient.xml +++ b/xml/System.Net.Sockets/UdpClient.xml @@ -2803,7 +2803,9 @@ If you want to send datagrams to a different remote host, you must call the method and specify the desired remote host. Use either of the other method overloads to send datagrams to a broadcast address. - ]]> + 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 . @@ -2898,7 +2900,9 @@ > [!WARNING] > Do not provide an `endPoint` parameter to this method if you have already established a remote host with the method. If you do, this method will throw a . If you receive a , use to obtain the specific error code. Once you have obtained this code, you can refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. - ]]> + 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 . @@ -3001,7 +3005,9 @@ > [!WARNING] > Do not provide a host name or port number to this method if you have already established a remote host with the method. If you do, this method will throw a . If you receive a , use to obtain the specific error code. Once you have obtained this code, you can refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. - ]]> + 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 . diff --git a/xml/System.Net/Dns.xml b/xml/System.Net/Dns.xml index cf7a2a70b46..64a2aa44f6e 100644 --- a/xml/System.Net/Dns.xml +++ b/xml/System.Net/Dns.xml @@ -892,7 +892,9 @@ This method queries a DNS server for the IP addresses associated with a host name. If `hostNameOrAddress` is an IP address, this address is returned without querying the DNS server. - ]]> + 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 . @@ -930,7 +932,7 @@ A cancellation token that can be used to signal the asynchronous operation should be canceled. 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. - 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 . @@ -962,7 +964,7 @@ A cancellation token that can be used to signal the asynchronous operation should be canceled. 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. - 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 . @@ -1476,7 +1478,9 @@ > [!NOTE] > This member emits trace information when you enable network tracing in your application. For more information, see [Network Tracing in the .NET Framework](/dotnet/framework/network-programming/network-tracing). - ]]> + 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 . @@ -1560,7 +1564,9 @@ > [!NOTE] > This member emits trace information when you enable network tracing in your application. For more information, see [Network Tracing in the .NET Framework](/dotnet/framework/network-programming/network-tracing). - ]]> + 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 parameter is . The length of parameter is greater than 255 characters. @@ -1596,7 +1602,7 @@ A cancellation token that can be used to signal the asynchronous operation should be canceled. 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 . - 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 . @@ -1628,7 +1634,7 @@ A cancellation token that can be used to signal the asynchronous operation should be canceled. 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 . - 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 . diff --git a/xml/System.Net/FileWebRequest.xml b/xml/System.Net/FileWebRequest.xml index 8e5eab5c3e3..7ba6a4cd91c 100644 --- a/xml/System.Net/FileWebRequest.xml +++ b/xml/System.Net/FileWebRequest.xml @@ -812,7 +812,9 @@ > [!NOTE] > In the case of asynchronous requests, the client application is responsible for implementing its own time-out mechanism. - ]]> +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 is being used by a previous call to . @@ -916,7 +918,9 @@ The stream already received a response previous to your request. > [!NOTE] > In the case of asynchronous requests, the client application is responsible for implementing its own time-out mechanism. - ]]> +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 is already in use by a previous call to . The was aborted. diff --git a/xml/System.Net/HttpListener.xml b/xml/System.Net/HttpListener.xml index 334e7c29e21..03b58fe2ba9 100644 --- a/xml/System.Net/HttpListener.xml +++ b/xml/System.Net/HttpListener.xml @@ -862,7 +862,9 @@ The following code example demonstrates calling the `Close` method: Before calling this method, you must call the method and add at least one URI prefix to listen for by adding the URI strings to the returned by the property. For a detailed description of prefixes, see the class overview. - ]]> + 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 . + +]]> diff --git a/xml/System.Net/HttpListenerRequest.xml b/xml/System.Net/HttpListenerRequest.xml index 85799b65ca4..995c22893db 100644 --- a/xml/System.Net/HttpListenerRequest.xml +++ b/xml/System.Net/HttpListenerRequest.xml @@ -594,7 +594,9 @@ If a call to this method to retrieve the client's X.509 v.3 certificate is in progress, then another call to this method cannot be made. - ]]> + 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 . + +]]> diff --git a/xml/System.Net/WebClient.xml b/xml/System.Net/WebClient.xml index 18a59d8bf5a..dd1518b3f6b 100644 --- a/xml/System.Net/WebClient.xml +++ b/xml/System.Net/WebClient.xml @@ -741,7 +741,9 @@ > [!NOTE] > This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in .NET Framework](/dotnet/framework/network-programming/network-tracing). - ]]> + 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 parameter is . The URI formed by combining and is invalid. @@ -1291,7 +1293,9 @@ When using this method in an ASP.NET page, you will receive an error if the account that the page executes under does not have permission to access the local 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 parameter is . @@ -1918,7 +1922,9 @@ internal class MyWebClient : WebClientProtocol > [!NOTE] > This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in .NET Framework](/dotnet/framework/network-programming/network-tracing). - ]]> + 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 parameter is . The URI formed by combining and is invalid. @@ -3605,7 +3611,9 @@ internal class MyWebClient : WebClientProtocol > [!NOTE] > This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in .NET Framework](/dotnet/framework/network-programming/network-tracing). - ]]> + 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 parameter is . The URI formed by combining and address is invalid. @@ -4298,7 +4306,9 @@ internal class MyWebClient : WebClientProtocol > [!NOTE] > This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in .NET Framework](/dotnet/framework/network-programming/network-tracing). - ]]> + 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 parameter is . @@ -4365,7 +4375,9 @@ internal class MyWebClient : WebClientProtocol > [!NOTE] > This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in .NET Framework](/dotnet/framework/network-programming/network-tracing). - ]]> + 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 parameter is . @@ -5428,7 +5440,9 @@ internal class MyWebClient : WebClientProtocol > [!NOTE] > This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in .NET Framework](/dotnet/framework/network-programming/network-tracing). - ]]> + 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 parameter is . The URI formed by combining and is invalid. @@ -5508,7 +5522,9 @@ internal class MyWebClient : WebClientProtocol > [!NOTE] > This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in .NET Framework](/dotnet/framework/network-programming/network-tracing). - ]]> + 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 parameter is . The URI formed by combining and is invalid. @@ -6448,7 +6464,9 @@ internal class MyWebClient : WebClientProtocol > [!NOTE] > This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in .NET Framework](/dotnet/framework/network-programming/network-tracing). - ]]> + 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 parameter is . @@ -6542,7 +6560,9 @@ internal class MyWebClient : WebClientProtocol > [!NOTE] > This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in .NET Framework](/dotnet/framework/network-programming/network-tracing). - ]]> + 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 parameter is . @@ -7565,7 +7585,9 @@ internal class MyWebClient : WebClientProtocol > [!NOTE] > This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in .NET Framework](/dotnet/framework/network-programming/network-tracing). - ]]> + 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 parameter is . @@ -7645,7 +7667,9 @@ internal class MyWebClient : WebClientProtocol > [!NOTE] > This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in .NET Framework](/dotnet/framework/network-programming/network-tracing). - ]]> + 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 parameter is . @@ -8595,7 +8619,9 @@ internal class MyWebClient : WebClientProtocol > [!NOTE] > This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in .NET Framework](/dotnet/framework/network-programming/network-tracing). - ]]> + 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 parameter is . @@ -8679,7 +8705,9 @@ internal class MyWebClient : WebClientProtocol > [!NOTE] > This member outputs trace information when you enable network tracing in your application. For more information see [Network Tracing in .NET Framework](/dotnet/framework/network-programming/network-tracing). - ]]> + 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 parameter is . diff --git a/xml/System.Net/WebRequest.xml b/xml/System.Net/WebRequest.xml index 33c2660aca9..886095c8a78 100644 --- a/xml/System.Net/WebRequest.xml +++ b/xml/System.Net/WebRequest.xml @@ -1739,7 +1739,9 @@ This property allows an application to determine which , make sure you close the request stream before you call . - ]]> + 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 . + +]]> @@ -1856,7 +1858,9 @@ This property allows an application to determine which object will complete after a response to an Internet request is available. - ]]> + 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 . + +]]> diff --git a/xml/System.Security.Cryptography/CryptoStream.xml b/xml/System.Security.Cryptography/CryptoStream.xml index 95d08ffe30f..a95061fd9eb 100644 --- a/xml/System.Security.Cryptography/CryptoStream.xml +++ b/xml/System.Security.Cryptography/CryptoStream.xml @@ -637,7 +637,9 @@ Copying begins at the current position in the current stream, and does not reset Copying begins at the current position in the current stream, and does not reset the position of the destination stream after the copy operation is complete. - ]]> + 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 . @@ -1007,7 +1009,9 @@ Copying begins at the current position in the current stream, and does not reset 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 stream has been disposed. @@ -1097,7 +1101,7 @@ Copying begins at the current position in the current stream, and does not reset 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. - 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 . @@ -1408,7 +1412,9 @@ Copying begins at the current position in the current stream, and does not reset 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 . + +]]> is . @@ -1775,7 +1781,9 @@ This member is an explicit interface member implementation. It can be used only 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 . + +]]> is . diff --git a/xml/System.Security.Cryptography/HMACMD5.xml b/xml/System.Security.Cryptography/HMACMD5.xml index 352340d023a..ad35c37341f 100644 --- a/xml/System.Security.Cryptography/HMACMD5.xml +++ b/xml/System.Security.Cryptography/HMACMD5.xml @@ -633,7 +633,7 @@ The default value is . Asynchronously computes the HMAC of a stream using the MD5 algorithm. The HMAC of the data. - 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 . or is . diff --git a/xml/System.Security.Cryptography/HMACSHA1.xml b/xml/System.Security.Cryptography/HMACSHA1.xml index d8d50accceb..38463b9f9be 100644 --- a/xml/System.Security.Cryptography/HMACSHA1.xml +++ b/xml/System.Security.Cryptography/HMACSHA1.xml @@ -693,7 +693,7 @@ Releases the unmanaged resources used by the . Asynchronously computes the HMAC of a stream using the SHA1 algorithm. The HMAC of the data. - 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 . or is . diff --git a/xml/System.Security.Cryptography/HMACSHA256.xml b/xml/System.Security.Cryptography/HMACSHA256.xml index 2b23cbc37fd..f2b3acc63f6 100644 --- a/xml/System.Security.Cryptography/HMACSHA256.xml +++ b/xml/System.Security.Cryptography/HMACSHA256.xml @@ -584,7 +584,7 @@ The default value is . Asynchronously computes the HMAC of a stream using the SHA256 algorithm. The HMAC of the data. - 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 . or is . diff --git a/xml/System.Security.Cryptography/HMACSHA384.xml b/xml/System.Security.Cryptography/HMACSHA384.xml index 685b0850950..9e7326b0176 100644 --- a/xml/System.Security.Cryptography/HMACSHA384.xml +++ b/xml/System.Security.Cryptography/HMACSHA384.xml @@ -583,7 +583,7 @@ The default value is . Asynchronously computes the HMAC of a stream using the SHA384 algorithm. The HMAC of the data. - 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 . or is . diff --git a/xml/System.Security.Cryptography/HMACSHA512.xml b/xml/System.Security.Cryptography/HMACSHA512.xml index 64f9150571a..e640efe2d0e 100644 --- a/xml/System.Security.Cryptography/HMACSHA512.xml +++ b/xml/System.Security.Cryptography/HMACSHA512.xml @@ -583,7 +583,7 @@ The default value is . Asynchronously computes the HMAC of a stream using the SHA512 algorithm. The HMAC of the data. - 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 . or is . diff --git a/xml/System.Security.Cryptography/HashAlgorithm.xml b/xml/System.Security.Cryptography/HashAlgorithm.xml index b78bc6475e4..51bc2efa410 100644 --- a/xml/System.Security.Cryptography/HashAlgorithm.xml +++ b/xml/System.Security.Cryptography/HashAlgorithm.xml @@ -492,7 +492,7 @@ The following example calculates the The token to monitor for cancellation requests. Asynchronously computes the hash value for the specified object. A task that represents the asynchronous compute hash operation and wraps the computed hash code. - 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 . diff --git a/xml/System.Security.Cryptography/MD5.xml b/xml/System.Security.Cryptography/MD5.xml index 879a5815e7c..777f1fd6c12 100644 --- a/xml/System.Security.Cryptography/MD5.xml +++ b/xml/System.Security.Cryptography/MD5.xml @@ -511,7 +511,7 @@ The default value is . Asynchronously computes the hash of a stream using the MD5 algorithm. The hash of the data. - 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 . is . diff --git a/xml/System.Security.Cryptography/SHA1.xml b/xml/System.Security.Cryptography/SHA1.xml index e54322782ce..27df2958c15 100644 --- a/xml/System.Security.Cryptography/SHA1.xml +++ b/xml/System.Security.Cryptography/SHA1.xml @@ -461,7 +461,7 @@ The default value is . Asynchronously computes the hash of a stream using the SHA1 algorithm. The hash of the data. - 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 . is . diff --git a/xml/System.Security.Cryptography/SHA256.xml b/xml/System.Security.Cryptography/SHA256.xml index fad678db758..95e2706896e 100644 --- a/xml/System.Security.Cryptography/SHA256.xml +++ b/xml/System.Security.Cryptography/SHA256.xml @@ -475,7 +475,7 @@ The .NET Framework includes the implementations and their associated hashName va The default value is . Asynchronously computes the hash of a stream using the SHA256 algorithm. The hash of the data. - 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 . is . diff --git a/xml/System.Security.Cryptography/SHA384.xml b/xml/System.Security.Cryptography/SHA384.xml index 71ab329dd71..748c9013f60 100644 --- a/xml/System.Security.Cryptography/SHA384.xml +++ b/xml/System.Security.Cryptography/SHA384.xml @@ -465,7 +465,7 @@ The default value is . Asynchronously computes the hash of a stream using the SHA384 algorithm. The hash of the data. - 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 . is . diff --git a/xml/System.Security.Cryptography/SHA512.xml b/xml/System.Security.Cryptography/SHA512.xml index e253327738f..5c2862a29a4 100644 --- a/xml/System.Security.Cryptography/SHA512.xml +++ b/xml/System.Security.Cryptography/SHA512.xml @@ -474,7 +474,7 @@ The default value is . Asynchronously computes the hash of a stream using the SHA512 algorithm. The hash of the data. - 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 . is . diff --git a/xml/System.ServiceModel.Activities/WorkflowControlClient.xml b/xml/System.ServiceModel.Activities/WorkflowControlClient.xml index d81208e59c9..8504c189117 100644 --- a/xml/System.ServiceModel.Activities/WorkflowControlClient.xml +++ b/xml/System.ServiceModel.Activities/WorkflowControlClient.xml @@ -359,7 +359,7 @@ The workflows instance to abandon. Begins an asynchronous operation that abandons the specified workflow instance. - 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 . @@ -423,7 +423,7 @@ The workflow instance to abandon. The reason to abandon the workflow instance. Begins an asynchronous operation that abandons the specified workflow instance with the specified reason. - 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 . @@ -844,7 +844,7 @@ The workflow instance to cancel. Begins an asynchronous operation that cancels the specified workflow instance. - 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 . @@ -1107,7 +1107,7 @@ The workflow instance to run. Begins an asynchronous operation that runs the specified workflow instance. - 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 . @@ -1264,7 +1264,7 @@ The workflow instance to suspend. Begins an asynchronous suspend operation. - 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 . @@ -1322,7 +1322,7 @@ The workflow instance to suspend. The reason to suspend the workflow instance. Begins an asynchronous suspend operation with the specified workflow instance ID and reason. - 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 . @@ -1481,7 +1481,7 @@ The workflow instance to terminate. Begins an asynchronous operation that terminates the specified workflow instance. - 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 . @@ -1539,7 +1539,7 @@ The workflow instance to terminate. The reason to terminate the workflow instance. Begins an asynchronous operation that terminates the specified workflow instance with the specified reason. - 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 . @@ -1660,7 +1660,7 @@ The workflow instance to unsuspend. Begins an asynchronous unsuspend operation. - 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 . diff --git a/xml/System.ServiceModel.Activities/WorkflowUpdateableControlClient.xml b/xml/System.ServiceModel.Activities/WorkflowUpdateableControlClient.xml index 8252b907eee..ae7cd1a1055 100644 --- a/xml/System.ServiceModel.Activities/WorkflowUpdateableControlClient.xml +++ b/xml/System.ServiceModel.Activities/WorkflowUpdateableControlClient.xml @@ -247,7 +247,7 @@ The workflows instance to abandon. Begins an asynchronous operation that abandons the specified workflow instance. - 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 . @@ -299,7 +299,7 @@ The workflows instance to abandon. The reason to abandon the workflow instance. Begins an asynchronous operation that abandons the specified workflow instance. - 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 . @@ -730,7 +730,7 @@ The workflow instance to cancel. Begins an asynchronous operation that cancels the specified workflow instance. - 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 . @@ -1002,7 +1002,7 @@ The workflow instance to run. Begins an asynchronous operation that runs the specified workflow instance. - 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 . @@ -1141,7 +1141,7 @@ The workflow instance to suspend. Begins an asynchronous suspend operation. - 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 . @@ -1193,7 +1193,7 @@ The workflow instance to suspend. The reason to suspend the workflow instance. Begins an asynchronous suspend operation. - 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 . @@ -1334,7 +1334,7 @@ The workflow instance to terminate. Begins an asynchronous terminate operation. - 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 . @@ -1386,7 +1386,7 @@ The workflow instance to terminate. The reason to terminate the workflow instance. Begins an asynchronous terminate operation. - 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 . @@ -1492,7 +1492,7 @@ The workflow instance to unsuspend. Begins an asynchronous unsuspend operation. - 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 . @@ -1600,7 +1600,7 @@ The workflow instance to update. The updated workflow identity. Begins an asynchronous update operation. - 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 . diff --git a/xml/System.ServiceModel.Description/MetadataExchangeClient.xml b/xml/System.ServiceModel.Description/MetadataExchangeClient.xml index ad465a36916..af230a1a0b9 100644 --- a/xml/System.ServiceModel.Description/MetadataExchangeClient.xml +++ b/xml/System.ServiceModel.Description/MetadataExchangeClient.xml @@ -586,7 +586,7 @@ Returns an asynchronous metadata set. The asynchronous metadata set. - 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 . @@ -611,7 +611,7 @@ The address from which to download the asynchronous metadata. Returns an asynchronous metadata set from the specified address. The asynchronous metadata located at the address. - 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 . @@ -638,7 +638,7 @@ The URI address that represents the route a message takes. Returns an asynchronous metadata set from the specified address and on the specified route. The metadata that is downloaded. - 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 . @@ -665,7 +665,7 @@ The download mechanism to use. Returns an asynchronous metadata set from the specified address using the specified download mode. The metadata that is downloaded. - 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 . diff --git a/xml/System.ServiceModel.Discovery/AnnouncementClient.xml b/xml/System.ServiceModel.Discovery/AnnouncementClient.xml index 65126e59dfd..717d53d9348 100644 --- a/xml/System.ServiceModel.Discovery/AnnouncementClient.xml +++ b/xml/System.ServiceModel.Discovery/AnnouncementClient.xml @@ -166,7 +166,7 @@ The endpoint discovery metadata. Causes an offline announcement message (Bye) to be sent asynchronously with the specified endpoint discovery metadata. - 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 . @@ -307,7 +307,7 @@ The endpoint discovery metadata. Causes an online announcement (Hello) message to be sent asynchronously with the specified endpoint discovery metadata. - 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 . diff --git a/xml/System.ServiceModel.Discovery/DiscoveryClient.xml b/xml/System.ServiceModel.Discovery/DiscoveryClient.xml index 4944e217494..e5ef6f771e1 100644 --- a/xml/System.ServiceModel.Discovery/DiscoveryClient.xml +++ b/xml/System.ServiceModel.Discovery/DiscoveryClient.xml @@ -281,7 +281,9 @@ ## Remarks Find operations initiated by calling this method cannot be canceled. - ]]> + 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 . + +]]> @@ -572,7 +574,9 @@ ## Remarks Resolve operations initiated by calling this method cannot be canceled. - ]]> + 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 . + +]]> diff --git a/xml/System.ServiceModel/ClientBase`1.xml b/xml/System.ServiceModel/ClientBase`1.xml index 60dea1356af..9f2b85f46a0 100644 --- a/xml/System.ServiceModel/ClientBase`1.xml +++ b/xml/System.ServiceModel/ClientBase`1.xml @@ -905,7 +905,7 @@ To be added. 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 . diff --git a/xml/System.Speech.Recognition/SpeechRecognitionEngine.xml b/xml/System.Speech.Recognition/SpeechRecognitionEngine.xml index b7cce1adb36..f66452442a7 100644 --- a/xml/System.Speech.Recognition/SpeechRecognitionEngine.xml +++ b/xml/System.Speech.Recognition/SpeechRecognitionEngine.xml @@ -1640,13 +1640,12 @@ namespace Sre_EmulateRecognize The recognizers that ship with Vista and Windows 7 ignore case and character width when applying grammar rules to the input phrase. For more information about this type of comparison, see the enumeration values and . The recognizers also ignore new lines and extra white space and treat punctuation as literal input. - + 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 . ## Examples The code example below is part of a console application that demonstrates asynchronous emulated input, the associated recognition results, and the associated events raised by the speech recognizer. The example generates the following output. -``` - +```txt TestRecognizeAsync("Smith")... SpeechDetected event raised. SpeechRecognized event raised. @@ -1859,11 +1858,10 @@ namespace SreEmulateRecognizeAsync completed = true; } } -} - -``` - - ]]> +} +``` + +]]> The recognizer has no speech recognition grammars loaded, or the recognizer has an asynchronous recognition operation that is not yet complete. @@ -1911,7 +1909,9 @@ namespace SreEmulateRecognizeAsync The recognizer uses `compareOptions` when it applies grammar rules to the input phrase. The recognizers that ship with Vista and Windows 7 ignore case if the or value is present. The recognizers always ignore the character width and never ignore the Kana type. The recognizers also ignore new lines and extra white space and treat punctuation as literal input. For more information about character width and Kana type, see the enumeration. - ]]> + 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 recognizer has no speech recognition grammars loaded, or the recognizer has an asynchronous recognition operation that is not yet complete. @@ -1961,7 +1961,9 @@ namespace SreEmulateRecognizeAsync The recognizer uses `compareOptions` when it applies grammar rules to the input phrase. The recognizers that ship with Vista and Windows 7 ignore case if the or value is present. The recognizers always ignore the character width and never ignore the Kana type. The recognizers also ignore new lines and extra white space and treat punctuation as literal input. For more information about character width and Kana type, see the enumeration. - ]]> + 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 recognizer has no speech recognition grammars loaded, or the recognizer has an asynchronous recognition operation that is not yet complete. @@ -2664,7 +2666,9 @@ namespace SpeechRecognitionApp To load a speech recognition grammar synchronously, use the method. - ]]> + 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 . @@ -3314,7 +3318,7 @@ namespace SynchronousRecognition To perform synchronous recognition, use one of the methods. - + 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 . ## Examples The following example shows part of a console application that demonstrates basic asynchronous speech recognition. The example creates a , loads it into an in-process speech recognizer, and performs one asynchronous recognition operation. Event handlers are included to demonstrate the events that the recognizer raises during the operation. @@ -3501,11 +3505,10 @@ namespace AsynchronousRecognition completed = true; } } -} - -``` - - ]]> +} +``` + +]]> diff --git a/xml/System.Speech.Recognition/SpeechRecognizer.xml b/xml/System.Speech.Recognition/SpeechRecognizer.xml index 4b643bc347b..f4f9a51bd6b 100644 --- a/xml/System.Speech.Recognition/SpeechRecognizer.xml +++ b/xml/System.Speech.Recognition/SpeechRecognizer.xml @@ -1033,7 +1033,7 @@ namespace SharedRecognizer ## Remarks The recognizers that ship with Vista and Windows 7 ignore case and character width when applying grammar rules to the input phrase. For more information about this type of comparison, see the enumeration values and . The recognizers also ignore new lines and extra white space and treat punctuation as literal input. - + 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 . ## Examples The following example is part of a console application that loads a speech recognition grammar and demonstrates asynchronous emulated input, the associated recognition results, and the associated events raised by the speech recognizer. If Windows Speech Recognition is not running, then starting this application will also start Windows Speech Recognition. If Windows Speech Recognition is in the **Sleeping** state, then always returns null. @@ -1125,11 +1125,10 @@ namespace SharedRecognizer completed = true; } } -} - -``` - - ]]> +} +``` + +]]> @@ -1171,7 +1170,9 @@ namespace SharedRecognizer The recognizer uses the `compareOptions` when it applies grammar rules to the input phrase. The recognizers that ship with Vista and Windows 7 ignore case if the or value is present. The recognizers always ignore the character width and never ignore the Kana type. The recognizers also ignore new lines and extra white space and treats punctuation as literal input. For more information about character width and Kana type, see the enumeration. - ]]> + 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 . + +]]> @@ -1211,7 +1212,9 @@ namespace SharedRecognizer ## Remarks The recognizer uses the `compareOptions` when it applies grammar rules to the input phrase. The recognizers that ship with Vista and Windows 7 ignore case if the or value is present. The recognizers always ignore the character width and never ignore the Kana type. The recognizers also ignore new lines and extra white space and treats punctuation as literal input. For more information about character width and Kana type, see the enumeration. - ]]> + 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 . + +]]> @@ -1644,7 +1647,9 @@ namespace SharedRecognizer To load a speech recognition grammar synchronously, use the method. - ]]> + 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 . + +]]> diff --git a/xml/System.Speech.Synthesis/SpeechSynthesizer.xml b/xml/System.Speech.Synthesis/SpeechSynthesizer.xml index 756e7d9a941..bf78810420f 100644 --- a/xml/System.Speech.Synthesis/SpeechSynthesizer.xml +++ b/xml/System.Speech.Synthesis/SpeechSynthesizer.xml @@ -1772,7 +1772,7 @@ namespace SampleSynthesis To synchronously speak the contents of a object, use . - + 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 . ## Examples The following example creates a object from a string and passes the object as an argument to the method. @@ -1805,11 +1805,10 @@ namespace SampleSynthesis Console.ReadKey(); } } -} - -``` - - ]]> +} +``` + +]]> @@ -1880,7 +1879,9 @@ namespace SampleSynthesis ``` - ]]> + 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 . + +]]> @@ -1913,7 +1914,7 @@ namespace SampleSynthesis ## Remarks To asynchronously speak a string that contains SSML markup, use the method. To synchronously speak the contents of a string, use the method. You can cancel the asynchronous speaking of a prompt with the or the method. - + 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 . ## Examples As shown in the following example, the method provides the simplest means to generate speech output asynchronously. @@ -1943,11 +1944,10 @@ namespace SampleSynthesis Console.ReadKey(); } } -} - -``` - - ]]> +} +``` + +]]> @@ -2329,7 +2329,9 @@ namespace SampleSynthesis } ``` - ]]> + 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 . + +]]> diff --git a/xml/System.Text.Json/JsonDocument.xml b/xml/System.Text.Json/JsonDocument.xml index 99ed22f4fa9..9a346be30fd 100644 --- a/xml/System.Text.Json/JsonDocument.xml +++ b/xml/System.Text.Json/JsonDocument.xml @@ -300,7 +300,7 @@ The value may be used for the entire lifetime o The token to monitor for cancellation requests. Parses a as UTF-8-encoded data representing a single JSON value into a JsonDocument. The stream is read to completion. A task to produce a JsonDocument representation of the JSON value. - 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 . does not represent a valid single JSON value. diff --git a/xml/System.Text.Json/JsonSerializer.xml b/xml/System.Text.Json/JsonSerializer.xml index 3514deaac4c..5249e5e533e 100644 --- a/xml/System.Text.Json/JsonSerializer.xml +++ b/xml/System.Text.Json/JsonSerializer.xml @@ -1774,7 +1774,9 @@ The used to create the instance of the For more information, see [How to serialize and deserialize JSON](/dotnet/standard/serialization/system-text-json-how-to). - ]]> + 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 . @@ -1819,7 +1821,7 @@ There is remaining data in the stream. Reads the UTF-8 encoded text representing a single JSON value into a . The Stream will be read to completion. A representation of the JSON value. - 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 . , , or is . The JSON is invalid, the is not compatible with the JSON, or there is remaining data in the Stream. @@ -2643,7 +2645,9 @@ For more information, see [How to serialize and deserialize JSON](/dotnet/standa For more information, see [How to serialize and deserialize JSON](/dotnet/standard/serialization/system-text-json-how-to). - ]]> + 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 not compatible with . @@ -2682,7 +2686,7 @@ For more information, see [How to serialize and deserialize JSON](/dotnet/standa The that can be used to cancel the write operation. Converts the provided value to UTF-8 encoded JSON text and write it to the . A task that represents the asynchronous write operation. - 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 . is not compatible with . diff --git a/xml/System.Text.Json/Utf8JsonWriter.xml b/xml/System.Text.Json/Utf8JsonWriter.xml index 996029e2627..09d79a4ad0d 100644 --- a/xml/System.Text.Json/Utf8JsonWriter.xml +++ b/xml/System.Text.Json/Utf8JsonWriter.xml @@ -269,7 +269,9 @@ In the case of Stream, this writes the data to the stream and flushes it. The instance cannot be reused after disposing. - ]]> +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 . + +]]> @@ -343,7 +345,9 @@ In the case of IBufferWriter, this advances the underlying , this writes the data to the stream and flushes it asynchronously, while monitoring cancellation requests. - ]]> +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 . + +]]> This instance has been disposed. diff --git a/xml/System.Threading.Tasks/Task.xml b/xml/System.Threading.Tasks/Task.xml index f89cb7d9633..121dbfdc3c8 100644 --- a/xml/System.Threading.Tasks/Task.xml +++ b/xml/System.Threading.Tasks/Task.xml @@ -5498,7 +5498,7 @@ timeout is greater than 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. - 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 . @@ -5533,7 +5533,7 @@ timeout is greater than 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. - 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 . @@ -5570,7 +5570,7 @@ timeout is greater than 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. + 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 . diff --git a/xml/System.Threading/CancellationTokenRegistration.xml b/xml/System.Threading/CancellationTokenRegistration.xml index 193631122d0..6ea6869cf3b 100644 --- a/xml/System.Threading/CancellationTokenRegistration.xml +++ b/xml/System.Threading/CancellationTokenRegistration.xml @@ -176,7 +176,9 @@ The returned completes once the associated callback is unregistered without having executed or once it's finished executing, except in the degenerate case where the callback is unregistering itself. - ]]> +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 . + +]]> diff --git a/xml/System.Threading/SemaphoreSlim.xml b/xml/System.Threading/SemaphoreSlim.xml index 687428949de..0f795702b44 100644 --- a/xml/System.Threading/SemaphoreSlim.xml +++ b/xml/System.Threading/SemaphoreSlim.xml @@ -999,7 +999,7 @@ The that created Asynchronously waits to enter the . A task that will complete when the semaphore has been entered. - 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 has been disposed. @@ -1050,7 +1050,9 @@ The that created + 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 current instance has already been disposed. @@ -1100,7 +1102,7 @@ The that created The token to observe. Asynchronously waits to enter the , while observing a . A task that will complete when the semaphore has been entered. - 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 current instance has already been disposed. was canceled. @@ -1153,7 +1155,9 @@ The that created + 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 current instance has already been disposed. @@ -1213,7 +1217,9 @@ The that created + 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 a number other than -1, which represents an infinite timeout. @@ -1275,7 +1281,9 @@ The that created + 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 a negative number other than -1, which represents an infinite timeout. diff --git a/xml/System.Threading/Timer.xml b/xml/System.Threading/Timer.xml index f202ea46f53..bf94f65d8ae 100644 --- a/xml/System.Threading/Timer.xml +++ b/xml/System.Threading/Timer.xml @@ -1051,7 +1051,7 @@ Sub TimerCallback(state As Object) Releases all resources used by the current instance of . A that completes when all work associated with the timer has ceased. - 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 . diff --git a/xml/System.Web.SessionState/ISessionStateModule.xml b/xml/System.Web.SessionState/ISessionStateModule.xml index e6287636337..3436052f9c3 100644 --- a/xml/System.Web.SessionState/ISessionStateModule.xml +++ b/xml/System.Web.SessionState/ISessionStateModule.xml @@ -65,7 +65,7 @@ The for which to release the session state. Asynchronously releases the session state for the specified . A for the asynchronous operation. - 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 . diff --git a/xml/System.Web.SessionState/SessionStateModule.xml b/xml/System.Web.SessionState/SessionStateModule.xml index 10d1bbfabe1..1b82d48e336 100644 --- a/xml/System.Web.SessionState/SessionStateModule.xml +++ b/xml/System.Web.SessionState/SessionStateModule.xml @@ -276,7 +276,7 @@ public void Session_OnEnd() The for which to release the session state. Asynchronously releases the session state for the specified . A for the asynchronous operation. - 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 . diff --git a/xml/System.Web/HttpResponse.xml b/xml/System.Web/HttpResponse.xml index e9a2e4165a0..e89bc3ae85d 100644 --- a/xml/System.Web/HttpResponse.xml +++ b/xml/System.Web/HttpResponse.xml @@ -1537,7 +1537,7 @@ Asynchronously sends all currently buffered output to the client. A that represents the asynchronous operation. - 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 . diff --git a/xml/System.Web/HttpResponseBase.xml b/xml/System.Web/HttpResponseBase.xml index de0dff73f99..4834cd777d4 100644 --- a/xml/System.Web/HttpResponseBase.xml +++ b/xml/System.Web/HttpResponseBase.xml @@ -1137,7 +1137,7 @@ Asynchronously sends all currently buffered output to the client. The task the represents the asynchronous operation. - 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 . diff --git a/xml/System.Web/HttpResponseWrapper.xml b/xml/System.Web/HttpResponseWrapper.xml index 82aa1912b55..281ba241409 100644 --- a/xml/System.Web/HttpResponseWrapper.xml +++ b/xml/System.Web/HttpResponseWrapper.xml @@ -1102,7 +1102,7 @@ Asynchronously sends all currently buffered output to the client. A object that represents the asynchronous operation. - 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 . diff --git a/xml/System.Web/HttpTaskAsyncHandler.xml b/xml/System.Web/HttpTaskAsyncHandler.xml index 22f6f92f26c..8bd02086514 100644 --- a/xml/System.Web/HttpTaskAsyncHandler.xml +++ b/xml/System.Web/HttpTaskAsyncHandler.xml @@ -136,7 +136,9 @@ ## Remarks To create a custom handler for an asynchronous task, override the method. - ]]> + 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 . + +]]> diff --git a/xml/System.Windows.Documents.Serialization/SerializerWriter.xml b/xml/System.Windows.Documents.Serialization/SerializerWriter.xml index 6a325afd7f3..0075b5294b1 100644 --- a/xml/System.Windows.Documents.Serialization/SerializerWriter.xml +++ b/xml/System.Windows.Documents.Serialization/SerializerWriter.xml @@ -782,7 +782,9 @@ ## Remarks The output of the write operation is normally specified as a parameter to the constructor of the derived class that implements . - ]]> + 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 . + +]]> @@ -822,7 +824,9 @@ ## Remarks The output of the write operation is normally specified as a parameter to the constructor of the derived class that implements . - ]]> + 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 . + +]]> @@ -862,7 +866,9 @@ ## Remarks The output of the write operation is normally specified as a parameter to the constructor of the derived class that implements . - ]]> + 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 . + +]]> @@ -902,7 +908,9 @@ ## Remarks The output of the write operation is normally specified as a parameter to the constructor of the derived class that implements . - ]]> + 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 . + +]]> @@ -942,7 +950,9 @@ ## Remarks The output of the write operation is normally specified as a parameter to the constructor of the derived class that implements . - ]]> + 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 . + +]]> @@ -1038,7 +1048,9 @@ The output of the write operation is normally specified as a parameter to the constructor of the derived class that implements . - ]]> + 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 . + +]]> @@ -1134,7 +1146,9 @@ The output of the write operation is normally specified as a parameter to the constructor of the derived class that implements . - ]]> + 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 . + +]]> @@ -1230,7 +1244,9 @@ The output of the write operation is normally specified as a parameter to the constructor of the derived class that implements . - ]]> + 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 . + +]]> @@ -1326,7 +1342,9 @@ The output of the write operation is normally specified as a parameter to the constructor of the derived class that implements . - ]]> + 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 . + +]]> @@ -1420,7 +1438,9 @@ The output of the write operation is normally specified as a parameter to the constructor of the derived class that implements . - ]]> + 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 . + +]]> diff --git a/xml/System.Windows.Documents.Serialization/SerializerWriterCollator.xml b/xml/System.Windows.Documents.Serialization/SerializerWriterCollator.xml index b5d32bb3b35..30483ac0e7e 100644 --- a/xml/System.Windows.Documents.Serialization/SerializerWriterCollator.xml +++ b/xml/System.Windows.Documents.Serialization/SerializerWriterCollator.xml @@ -133,7 +133,7 @@ When overridden in a derived class, cancels an asynchronous operation. - 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 . @@ -314,7 +314,9 @@ ## Remarks The methods write to the stream associated with the that created the from the call to . - ]]> + 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 . + +]]> @@ -402,7 +404,9 @@ `printTicket` can be `null` if there are no preferred print settings. - ]]> + 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 . + +]]> diff --git a/xml/System.Windows.Documents/DocumentPaginator.xml b/xml/System.Windows.Documents/DocumentPaginator.xml index 788df56e404..059e47557d0 100644 --- a/xml/System.Windows.Documents/DocumentPaginator.xml +++ b/xml/System.Windows.Documents/DocumentPaginator.xml @@ -166,7 +166,9 @@ ## Remarks The only way to cancel the asynchronous operation of this method is to cancel all asynchronous operations. Contrast this with the other overload of this method: . - ]]> + 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 . + +]]> @@ -320,7 +322,9 @@ This method raises the event. The is passed to the event as one of the event arguments. See for how to use this method to get the page. - ]]> + 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 negative. diff --git a/xml/System.Windows.Documents/DynamicDocumentPaginator.xml b/xml/System.Windows.Documents/DynamicDocumentPaginator.xml index ca5d4ab4132..ca06937028f 100644 --- a/xml/System.Windows.Documents/DynamicDocumentPaginator.xml +++ b/xml/System.Windows.Documents/DynamicDocumentPaginator.xml @@ -187,7 +187,9 @@ This method raises the event. The page number is passed to the event as one of the event arguments. See for how to use this method to get the page number. - ]]> + 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 . + +]]> diff --git a/xml/System.Windows.Documents/PageContent.xml b/xml/System.Windows.Documents/PageContent.xml index 6665e0dd093..e6e9016786d 100644 --- a/xml/System.Windows.Documents/PageContent.xml +++ b/xml/System.Windows.Documents/PageContent.xml @@ -224,7 +224,7 @@ ## Remarks asynchronously loads and parses the data stream associated with this . Other threads will continue to run while completes. - The following steps illustrate how to load the content asynchronously: + The following steps illustrate how to load the content asynchronously: 1. Create a delegate and add it to be notified of events. @@ -234,7 +234,9 @@ For more information about the `` element, see chapter 3 of the XPS specification which you can obtain at [XPS: Specification and License Downloads](https://www.microsoft.com/whdc/xps/downloads.mspx). - ]]> + 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 . + +]]> diff --git a/xml/System.Windows.Forms/PictureBox.xml b/xml/System.Windows.Forms/PictureBox.xml index 12a80bdd104..f1a1747f85b 100644 --- a/xml/System.Windows.Forms/PictureBox.xml +++ b/xml/System.Windows.Forms/PictureBox.xml @@ -1251,7 +1251,9 @@ ## Remarks Besides calling the method, the property must be set to `false` to load an image asynchronously. When you load an image asynchronously, you can handle the event to determine the progress of an image load or the event to determine when an image load has completed. - ]]> + 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 . + +]]> @@ -1288,13 +1290,15 @@ A call to the method sets the property to the value of `url`. Besides calling the method, you must set the property to `false` to load an image asynchronously. When you load an image asynchronously, you can handle the event to determine the progress of an image load or the event to determine when an image load has completed. If an error occurs during an asynchronous image-loading operation, it will be caught and reported by the property of the . + 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 . + ## Examples The following code example demonstrates how to use the method. To run this example, paste the following code into a Windows Form that contains a named `pictureBox1` and a named `startLoadButton`. Make sure that the event for the button is associated with the `startLoadButton_Click` method in this example. You must change the image file path to a path that is valid on your system. :::code language="csharp" source="~/snippets/csharp/System.Windows.Forms/PictureBox/CancelAsync/Form1.cs" id="Snippet3"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.TreeViewPictureBoxWhidbeyMembers/VB/Form1.vb" id="Snippet3"::: - ]]> +]]> diff --git a/xml/System.Windows.Markup/XamlReader.xml b/xml/System.Windows.Markup/XamlReader.xml index 4996cdbf433..b7e86e2e50e 100644 --- a/xml/System.Windows.Markup/XamlReader.xml +++ b/xml/System.Windows.Markup/XamlReader.xml @@ -456,7 +456,9 @@ Only one asynchronous load operation per instance of the class can be performed at a time. If more than one asynchronous operation is attempted on the same instance of the class an is thrown. - ]]> + 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 . @@ -502,7 +504,9 @@ Only one asynchronous load operation per instance of the class can be performed at a time. If more than one asynchronous operation is attempted on the same instance of the class an is thrown. - ]]> + 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 . @@ -536,7 +540,7 @@ To be added. To be added. 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 . @@ -579,7 +583,9 @@ Only one asynchronous load operation per instance of the class can be performed at a time. If more than one asynchronous operation is attempted on the same instance of the class an is thrown. - ]]> + 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 . @@ -613,7 +619,7 @@ To be added. To be added. 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 . @@ -644,7 +650,7 @@ To be added. To be added. 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 . diff --git a/xml/System.Windows.Threading/Dispatcher.xml b/xml/System.Windows.Threading/Dispatcher.xml index 7793c2140d4..98940368755 100644 --- a/xml/System.Windows.Threading/Dispatcher.xml +++ b/xml/System.Windows.Threading/Dispatcher.xml @@ -1853,8 +1853,9 @@ The default priority is `DispatcherPriority.Send`. The default priority is `DispatcherPriority.Normal`. +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 . - ]]> +]]> @@ -1885,7 +1886,7 @@ The default priority is `DispatcherPriority.Normal`. The priority that determines the order in which the specified callback is invoked relative to the other pending operations in the . 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. + 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 . @@ -1923,7 +1924,7 @@ The default priority is `DispatcherPriority.Normal`. An object that indicates whether to cancel the action. 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. + 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 . diff --git a/xml/System.Windows.Xps/VisualsToXpsDocument.xml b/xml/System.Windows.Xps/VisualsToXpsDocument.xml index a920d175b4a..fe221c5f648 100644 --- a/xml/System.Windows.Xps/VisualsToXpsDocument.xml +++ b/xml/System.Windows.Xps/VisualsToXpsDocument.xml @@ -154,7 +154,9 @@ ## Remarks For example, an exception is thrown if the method is called and a writing operation is not in progress. - ]]> + 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 state of the is not compatible with a operation. @@ -323,7 +325,7 @@ The that is written. Writes a asynchronously to an or a . - 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 . @@ -395,7 +397,9 @@ ## Remarks This method does not validate or modify the specified `printTicket` for a particular . If necessary, use the method to create a that is specific to the and is valid for a specified printer. - ]]> + 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 . + +]]> diff --git a/xml/System.Windows.Xps/XpsDocumentWriter.xml b/xml/System.Windows.Xps/XpsDocumentWriter.xml index 3eddcde6295..4767cad5f21 100644 --- a/xml/System.Windows.Xps/XpsDocumentWriter.xml +++ b/xml/System.Windows.Xps/XpsDocumentWriter.xml @@ -902,7 +902,9 @@ By design, this `Write` method does not raise the method does not call the event. - ]]> + 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 . + +]]> @@ -938,15 +940,19 @@ By design, this `Write` method does not raise the An object that contains a pointer to unpaginated source material and also contains methods for paginating the material. Writes asynchronously paginated content from a specified to the target or . - , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . ## Examples The following example shows how to use this method to write to an XPS document. :::code language="csharp" source="~/snippets/csharp/System.Windows.Documents/DocumentPaginator/PageSize/XpsSaveHelper.cs" id="Snippetwriteasynctoxpswithdocumentpaginator"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/XpsSave/visualbasic/xpssavehelper.vb" id="Snippetwriteasynctoxpswithdocumentpaginator"::: - - ]]> + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/XpsSave/visualbasic/xpssavehelper.vb" id="Snippetwriteasynctoxpswithdocumentpaginator"::: + +]]> @@ -987,15 +993,15 @@ By design, this `Write` method does not raise the class has a singular name, an can be one or a set of multiple documents. This method adds a to the 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 . ## Examples The following example shows how to use this method to write to an XPS document. :::code language="csharp" source="~/snippets/csharp/System.Windows.Documents/DocumentPaginator/PageSize/XpsSaveHelper.cs" id="Snippetwriteasynctoxpswithfixeddocument"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/XpsSave/visualbasic/xpssavehelper.vb" id="Snippetwriteasynctoxpswithfixeddocument"::: - - ]]> + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/XpsSave/visualbasic/xpssavehelper.vb" id="Snippetwriteasynctoxpswithfixeddocument"::: + +]]> @@ -1044,7 +1050,9 @@ By design, this `Write` method does not raise the + 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 . + +]]> @@ -1079,7 +1087,7 @@ By design, this `Write` method does not raise the The page that is written. Writes asynchronously a specified to the target or . - 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 . @@ -1118,16 +1126,16 @@ By design, this `Write` method does not raise the , use . - - + + 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 . ## Examples The following example shows how to use this method to write a to an XPS document. :::code language="csharp" source="~/snippets/csharp/System.Windows.Documents/DocumentPaginator/PageSize/XpsSaveHelper.cs" id="Snippetwriteasynctoxpswithvisual"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/XpsSave/visualbasic/xpssavehelper.vb" id="Snippetwriteasynctoxpswithvisual"::: - - ]]> + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/XpsSave/visualbasic/xpssavehelper.vb" id="Snippetwriteasynctoxpswithvisual"::: + +]]> @@ -1178,7 +1186,9 @@ By design, this `Write` method does not raise the method does not call the event. - ]]> + 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 . + +]]> @@ -1257,7 +1267,9 @@ By design, this `Write` method does not raise the . If necessary, use the method to create a that is specific to the and is valid for a specified printer. - ]]> + 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 . + +]]> @@ -1345,7 +1357,9 @@ By design, this `Write` method does not raise the . If necessary, use the method to create a that is specific to the and is valid for a specified printer. - ]]> + 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 . + +]]> @@ -1433,7 +1447,9 @@ By design, this `Write` method does not raise the . If necessary, use the method to create a that is specific to the and is valid for a specified printer. - ]]> + 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 . + +]]> @@ -1512,7 +1528,9 @@ By design, this `Write` method does not raise the . If necessary, use the method to create a that is specific to the and is valid for a specified printer. - ]]> + 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 . + +]]> @@ -1600,7 +1618,9 @@ By design, this `Write` method does not raise the . If necessary, use the method to create a that is specific to the and is valid for a specified printer. - ]]> + 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 . + +]]> diff --git a/xml/System.Xml.Linq/XCData.xml b/xml/System.Xml.Linq/XCData.xml index f558db0b3a5..e9408a09d13 100644 --- a/xml/System.Xml.Linq/XCData.xml +++ b/xml/System.Xml.Linq/XCData.xml @@ -393,7 +393,7 @@ Text A token that can be used to request cancellation of the asynchronous operation. Writes this to the given . A task representing the asynchronous write operation. - 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 . diff --git a/xml/System.Xml.Linq/XComment.xml b/xml/System.Xml.Linq/XComment.xml index 95ab7c911bf..607f88eb3ce 100644 --- a/xml/System.Xml.Linq/XComment.xml +++ b/xml/System.Xml.Linq/XComment.xml @@ -418,7 +418,7 @@ This is a comment A token that can be used to request cancellation of the asynchronous operation. Writes this to the specified . A task that represents the asynchronous write operation. - 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 . diff --git a/xml/System.Xml.Linq/XDocument.xml b/xml/System.Xml.Linq/XDocument.xml index c16f78740ba..7f2febda8cb 100644 --- a/xml/System.Xml.Linq/XDocument.xml +++ b/xml/System.Xml.Linq/XDocument.xml @@ -1771,7 +1771,9 @@ Root 1 2 If is set, the underlying property is set to `false`. - ]]> +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 . + +]]> @@ -1820,7 +1822,9 @@ If is set, the property is set to `false`. - ]]> +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 . + +]]> @@ -1862,7 +1866,7 @@ If A cancellation token. Creates a new containing the contents of the specified . A new XDocument containing the contents of the specified . - 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 . @@ -2962,7 +2966,7 @@ Console.WriteLine(File.ReadAllText("Root2.xml")) A cancellation token. Writes this to an . A task representing the asynchronous save operation. - 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 . @@ -3010,7 +3014,9 @@ Console.WriteLine(File.ReadAllText("Root2.xml")) If is set, the output is not indented. If is set, duplicate namespace declarations will be removed. - ]]> +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 . + +]]> @@ -3059,7 +3065,9 @@ If is set, the output is not indented. If is set, duplicate namespace declarations will be removed. - ]]> +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 . + +]]> @@ -3193,7 +3201,7 @@ Console.WriteLine(sb.ToString()) A cancellation token. Writes this XDocument's underlying XML tree to the specified . A task representing the asynchronous write operation. - 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 . diff --git a/xml/System.Xml.Linq/XDocumentType.xml b/xml/System.Xml.Linq/XDocumentType.xml index fc7a0b1e6d5..c3de5781847 100644 --- a/xml/System.Xml.Linq/XDocumentType.xml +++ b/xml/System.Xml.Linq/XDocumentType.xml @@ -909,7 +909,7 @@ SystemId:Pubs.dtd A token that can be used to request cancellation of the asynchronous operation. Writes this to the specified . A task representing the asynchronous write operation. - 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 . diff --git a/xml/System.Xml.Linq/XElement.xml b/xml/System.Xml.Linq/XElement.xml index e772aaa2775..ec8359b2702 100644 --- a/xml/System.Xml.Linq/XElement.xml +++ b/xml/System.Xml.Linq/XElement.xml @@ -3871,7 +3871,9 @@ Root 1 2 If `options` is set to , then the property is set to `false`. - ]]> +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 . + +]]> @@ -3920,7 +3922,9 @@ If `options` is set to , th If `options` is set to , then the property is set to `false`. - ]]> +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 . + +]]> @@ -3962,7 +3966,7 @@ If `options` is set to , th A token that can be used to request cancellation of the asynchronous operation. 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. - 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 . @@ -7954,7 +7958,7 @@ Console.WriteLine(str) A token that can be used to request cancellation of the asynchronous operation. Asynchronously outputs this to an . A task representing the asynchronous save operation. - 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 . @@ -7995,7 +7999,7 @@ Console.WriteLine(str) A token that can be used to request cancellation of the asynchronous operation. Asynchronously outputs this to a . A task representing the asynchronous save operation. - 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 . @@ -8036,7 +8040,7 @@ Console.WriteLine(str) A token that can be used to request cancellation of the asynchronous operation. Asynchronously outputs this to a . A task representing the asynchronous save operation. - 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 . @@ -8743,7 +8747,7 @@ Console.WriteLine(sb.ToString()) A token that can be used to request cancellation of the asynchronous operation. Asynchronously writes this to the specified writer. A task representing the asynchronous write operation. - 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 . diff --git a/xml/System.Xml.Linq/XNode.xml b/xml/System.Xml.Linq/XNode.xml index 157c8b6e35e..98ce31c283e 100644 --- a/xml/System.Xml.Linq/XNode.xml +++ b/xml/System.Xml.Linq/XNode.xml @@ -2797,7 +2797,7 @@ ccc A token that can be used to request cancellation of the asynchronous operation. Creates an from an . The runtime type of the node is determined by the of the first node encountered in the reader. An XNode that contains the nodes read from the reader. - 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 is not positioned on a recognized node type. @@ -3517,7 +3517,7 @@ Console.WriteLine(sb.ToString()) A token that can be used to request cancellation of the asynchronous operation. Writes the current node to an . A task representing the asynchronous write operation. - 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 . diff --git a/xml/System.Xml.Linq/XProcessingInstruction.xml b/xml/System.Xml.Linq/XProcessingInstruction.xml index f54851b709e..e26502050e8 100644 --- a/xml/System.Xml.Linq/XProcessingInstruction.xml +++ b/xml/System.Xml.Linq/XProcessingInstruction.xml @@ -488,7 +488,7 @@ xml-stylesheet A token that can be used to request cancellation of the asynchronous operation. Writes this to the specified . A task representing the asynchronous write operation. - 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 . diff --git a/xml/System.Xml.Linq/XText.xml b/xml/System.Xml.Linq/XText.xml index 926a076d4dd..1e23a006a70 100644 --- a/xml/System.Xml.Linq/XText.xml +++ b/xml/System.Xml.Linq/XText.xml @@ -474,7 +474,7 @@ Newer text A token that can be used to request cancellation of the asynchronous operation. Asynchronously writes this to the specified . A task representing the asynchronous write operation. - 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 . diff --git a/xml/System.Xml.Resolvers/XmlPreloadedResolver.xml b/xml/System.Xml.Resolvers/XmlPreloadedResolver.xml index bee8126e65b..edf297f124a 100644 --- a/xml/System.Xml.Resolvers/XmlPreloadedResolver.xml +++ b/xml/System.Xml.Resolvers/XmlPreloadedResolver.xml @@ -600,7 +600,7 @@ The type of object to return. The supports objects and objects for URIs that were added as . If the requested type is not supported by the resolver, an exception will be thrown. Use the method to determine whether a certain is supported by this resolver. Asynchronously maps a URI to an object that contains the actual resource. A or object that corresponds to the actual source. - 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 . diff --git a/xml/System.Xml/XmlDictionaryWriter.xml b/xml/System.Xml/XmlDictionaryWriter.xml index fbb59e8fd8a..00b5d2ea6a2 100644 --- a/xml/System.Xml/XmlDictionaryWriter.xml +++ b/xml/System.Xml/XmlDictionaryWriter.xml @@ -3029,7 +3029,9 @@ An asynchronous method was calle ## Remarks This is the asynchronous version of , with the same functionality. To use this method, you must set the flag to `true`. - ]]> + 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 method was called before a previous asynchronous operation finished. In this case, is thrown with the message "An asynchronous operation is already in progress." diff --git a/xml/System.Xml/XmlReader.xml b/xml/System.Xml/XmlReader.xml index 971e3d3d6a8..8d4fd1f15a3 100644 --- a/xml/System.Xml/XmlReader.xml +++ b/xml/System.Xml/XmlReader.xml @@ -3496,7 +3496,9 @@ public class Sample ## Remarks This is the asynchronous version of , with the same functionality. To use this method, you must set the flag to `true`. - ]]> + 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 method was called before a previous asynchronous operation finished. In this case, is thrown with the message "An asynchronous operation is already in progress." @@ -4147,7 +4149,9 @@ An asynchronous method was called without ## Remarks This is the asynchronous version of , with the same functionality. To use this method, you must set the flag to `true`. - ]]> + 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 method was called before a previous asynchronous operation finished. In this case, is thrown with the message "An asynchronous operation is already in progress." @@ -4383,7 +4387,9 @@ An method was called before a previous asy ## Remarks This is the asynchronous version of , with the same functionality. To use this method, you must set the flag to `true`. - ]]> + 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 method was called before a previous asynchronous operation finished. In this case, is thrown with the message "An asynchronous operation is already in progress." @@ -4523,7 +4529,9 @@ An method was called before a previous asy ## Remarks This is the asynchronous version of , with the same functionality. To use this method, you must set the flag to `true`. - ]]> + 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 method was called before a previous asynchronous operation finished. In this case, is thrown with the message "An asynchronous operation is already in progress." @@ -4663,7 +4671,9 @@ An method was called before a previous asy ## Remarks This is the asynchronous version of , with the same functionality. To use this method, you must set the flag to `true`. - ]]> + 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 method was called before a previous asynchronous operation finished. In this case, is thrown with the message "An asynchronous operation is already in progress." @@ -5303,7 +5313,9 @@ An asynchronous method was called without ## Remarks This is the asynchronous version of , with the same functionality. To use this method, you must set the flag to `true`. - ]]> + 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 method was called before a previous asynchronous operation finished. In this case, is thrown with the message "An asynchronous operation is already in progress." @@ -5424,7 +5436,9 @@ An asynchronous method was called without ## Remarks This is the asynchronous version of , with the same functionality. To use this method, you must set the flag to `true`. - ]]> + 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 method was called before a previous asynchronous operation finished. In this case, is thrown with the message "An asynchronous operation is already in progress." @@ -5659,7 +5673,9 @@ An method was called before a previous asy ## Remarks This is the asynchronous version of , with the same functionality. To use this method, you must set the flag to `true`. - ]]> + 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 method was called before a previous asynchronous operation finished. In this case, is thrown with the message "An asynchronous operation is already in progress." -or- @@ -5803,7 +5819,9 @@ An method was called before a previous asy ## Remarks This is the asynchronous version of , with the same functionality. To use this method, you must set the flag to `true`. - ]]> + 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 method was called before a previous asynchronous operation finished. In this case, is thrown with the message "An asynchronous operation is already in progress." @@ -5948,7 +5966,9 @@ An method was called before a previous asy ## Remarks This is the asynchronous version of , with the same functionality. To use this method, you must set the flag to `true`. - ]]> + 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 method was called before a previous asynchronous operation finished. In this case, is thrown with the message "An asynchronous operation is already in progress." @@ -7217,7 +7237,9 @@ An method was called before a previous asy ## Remarks This is the asynchronous version of , with the same functionality. To use this method, you must set the flag to `true`. - ]]> + 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 method was called before a previous asynchronous operation finished. In this case, is thrown with the message "An asynchronous operation is already in progress." @@ -7444,7 +7466,9 @@ An method was called before a previous asy ## Remarks This is the asynchronous version of , with the same functionality. To use this method, you must set the flag to `true`. - ]]> + 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 asynchronous method was called without setting the flag to . In this case, is thrown with the message "Set XmlReaderSettings.Async to true if you want to use Async Methods." Asynchronous programming (C#) @@ -7840,7 +7864,9 @@ An method was called before a previous asy ## Remarks This is the asynchronous version of , with the same functionality. To use this method, you must set the flag to `true`. - ]]> + 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 method was called before a previous asynchronous operation finished. In this case, is thrown with the message "An asynchronous operation is already in progress." @@ -7978,7 +8004,9 @@ An asynchronous method was called without ## Remarks This is the asynchronous version of , with the same functionality. To use this method, you must set the flag to `true`. - ]]> + 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 asynchronous method was called without setting the flag to . In this case, is thrown with the message "Set XmlReaderSettings.Async to true if you want to use Async Methods." Asynchronous programming (C#) @@ -8934,7 +8962,9 @@ An method was called before a previous asy ## Remarks This is the asynchronous version of , with the same functionality. To use this method, you must set the flag to `true`. - ]]> + 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 method was called before a previous asynchronous operation finished. In this case, is thrown with the message "An asynchronous operation is already in progress." -or- @@ -9243,7 +9273,9 @@ If you have to get the post-schema-validation information set (PSVI) for an elem ## Remarks This is the asynchronous version of , with the same functionality. To use this method, you must set the flag to `true`. - ]]> + 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 method was called before a previous asynchronous operation finished. In this case, is thrown with the message "An asynchronous operation is already in progress." diff --git a/xml/System.Xml/XmlResolver.xml b/xml/System.Xml/XmlResolver.xml index 940de610fa9..a393231f0b7 100644 --- a/xml/System.Xml/XmlResolver.xml +++ b/xml/System.Xml/XmlResolver.xml @@ -334,7 +334,9 @@ resolver.Credentials = myCache; ## Remarks This is the asynchronous version of , with the same functionality. To use this method, you must set the flag to `true`. - ]]> + 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 . + +]]> Asynchronous programming (C#) Asynchronous programming with Async and Await (Visual Basic) diff --git a/xml/System.Xml/XmlSecureResolver.xml b/xml/System.Xml/XmlSecureResolver.xml index 04c9e3dae32..c2b8c86bc3c 100644 --- a/xml/System.Xml/XmlSecureResolver.xml +++ b/xml/System.Xml/XmlSecureResolver.xml @@ -543,7 +543,7 @@ See the constructor reference topics for examples of these types of restrictions The type of object to return. The current version only returns objects. Asynchronously maps a URI to an object that contains the actual resource. The stream returned by calling on the underlying . If a type other than is specified, the method returns . - 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 . diff --git a/xml/System.Xml/XmlUrlResolver.xml b/xml/System.Xml/XmlUrlResolver.xml index f4cf3457f11..6ab7029cc2d 100644 --- a/xml/System.Xml/XmlUrlResolver.xml +++ b/xml/System.Xml/XmlUrlResolver.xml @@ -368,7 +368,7 @@ resolver.Credentials = myCache; The type of object to return. The current implementation only returns objects. Asynchronously maps a URI to an object that contains the actual resource. A stream object or if a type other than stream is specified. - 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 . diff --git a/xml/System.Xml/XmlWriter.xml b/xml/System.Xml/XmlWriter.xml index 17b3106493c..427703ce92c 100644 --- a/xml/System.Xml/XmlWriter.xml +++ b/xml/System.Xml/XmlWriter.xml @@ -1217,7 +1217,7 @@ An method was called before a previous asy Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources asynchronously. A task that represents the asynchronous dispose operation. - 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 . @@ -1353,7 +1353,9 @@ An method was called before a previous asy ## Remarks This is the asynchronous version of , with the same functionality. To use this method, you must set the flag to `true`. - ]]> + 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 method was called before a previous asynchronous operation finished. In this case, is thrown with the message "An asynchronous operation is already in progress." @@ -1650,7 +1652,9 @@ This member may behave differently when it is used in a Portable Class Library p ## Remarks This is the asynchronous version of , with the same functionality. To use this method, you must set the flag to `true`. - ]]> + 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 method was called before a previous asynchronous operation finished. In this case, is thrown with the message "An asynchronous operation is already in progress." @@ -1988,7 +1992,9 @@ An method was called before a previous asy ## Remarks This is the asynchronous version of , with the same functionality. To use this method, you must set the flag to `true`. - ]]> + 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 method was called before a previous asynchronous operation finished. In this case, is thrown with the message "An asynchronous operation is already in progress." @@ -2123,7 +2129,9 @@ An asynchronous method was called without ## Remarks This is the asynchronous version of , with the same functionality. To use this method, you must set the flag to `true`. - ]]> + 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 method was called before a previous asynchronous operation finished. In this case, is thrown with the message "An asynchronous operation is already in progress." @@ -2263,7 +2271,9 @@ An method was called before a previous asy ## Remarks This is the asynchronous version of , with the same functionality. To use this method, you must set the flag to `true`. - ]]> + 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 method was called before a previous asynchronous operation finished. In this case, is thrown with the message "An asynchronous operation is already in progress." @@ -2385,7 +2395,9 @@ An asynchronous method was called without ## Remarks This is the asynchronous version of , with the same functionality. To use this method, you must set the flag to `true`. - ]]> + 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 method was called before a previous asynchronous operation finished. In this case, is thrown with the message "An asynchronous operation is already in progress." @@ -2502,7 +2514,9 @@ An asynchronous method was called without ## Remarks This is the asynchronous version of , with the same functionality. To use this method, you must set the flag to `true`. - ]]> + 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 method was called before a previous asynchronous operation finished. In this case, is thrown with the message "An asynchronous operation is already in progress." @@ -2637,7 +2651,9 @@ An asynchronous method was called without ## Remarks This is the asynchronous version of , with the same functionality. To use this method, you must set the flag to `true`. - ]]> + 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 method was called before a previous asynchronous operation finished. In this case, is thrown with the message "An asynchronous operation is already in progress." @@ -2761,7 +2777,9 @@ An asynchronous method was called without ## Remarks This is the asynchronous version of , with the same functionality. To use this method, you must set the flag to `true`. - ]]> + 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 method was called before a previous asynchronous operation finished. In this case, is thrown with the message "An asynchronous operation is already in progress." @@ -2902,7 +2920,9 @@ An method was called before a previous asy ## Remarks This is the asynchronous version of , with the same functionality. To use this method, you must set the flag to `true`. - ]]> + 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 method was called before a previous asynchronous operation finished. In this case, is thrown with the message "An asynchronous operation is already in progress." @@ -3204,7 +3224,9 @@ An asynchronous method was called without ## Remarks This is the asynchronous version of , with the same functionality. To use this method, you must set the flag to `true`. - ]]> + 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 method was called before a previous asynchronous operation finished. In this case, is thrown with the message "An asynchronous operation is already in progress." @@ -3314,7 +3336,9 @@ An asynchronous method was called without ## Remarks This is the asynchronous version of , with the same functionality. To use this method, you must set the flag to `true`. - ]]> + 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 method was called before a previous asynchronous operation finished. In this case, is thrown with the message "An asynchronous operation is already in progress." @@ -3430,7 +3454,9 @@ An asynchronous method was called without ## Remarks This is the asynchronous version of , with the same functionality. To use this method, you must set the flag to `true`. - ]]> + 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 method was called before a previous asynchronous operation finished. In this case, is thrown with the message "An asynchronous operation is already in progress." @@ -3550,7 +3576,9 @@ An method was called before a previous asy ## Remarks This is the asynchronous version of , with the same functionality. To use this method, you must set the flag to `true`. - ]]> + 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 method was called before a previous asynchronous operation finished. In this case, is thrown with the message "An asynchronous operation is already in progress." @@ -3669,7 +3697,9 @@ An asynchronous method was called without ## Remarks This is the asynchronous version of , with the same functionality. To use this method, you must set the flag to `true`. - ]]> + 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 method was called before a previous asynchronous operation finished. In this case, is thrown with the message "An asynchronous operation is already in progress." @@ -3782,7 +3812,9 @@ An asynchronous method was called without ## Remarks This is the asynchronous version of , with the same functionality. To use this method, you must set the flag to `true`. - ]]> + 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 method was called before a previous asynchronous operation finished. In this case, is thrown with the message "An asynchronous operation is already in progress." @@ -3899,7 +3931,9 @@ An asynchronous method was called without ## Remarks This is the asynchronous version of , with the same functionality. To use this method, you must set the flag to `true`. - ]]> + 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 method was called before a previous asynchronous operation finished. In this case, is thrown with the message "An asynchronous operation is already in progress." @@ -4014,7 +4048,9 @@ An asynchronous method was called without ## Remarks This is the asynchronous version of , with the same functionality. To use this method, you must set the flag to `true`. - ]]> + 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 method was called before a previous asynchronous operation finished. In this case, is thrown with the message "An asynchronous operation is already in progress." @@ -4311,7 +4347,9 @@ while (!reader.EOF){ ## Remarks This is the asynchronous version of , with the same functionality. To use this method, you must set the flag to `true`. - ]]> + 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 method was called before a previous asynchronous operation finished. In this case, is thrown with the message "An asynchronous operation is already in progress." @@ -4374,7 +4412,9 @@ An asynchronous method was called without ## Remarks This is the asynchronous version of , with the same functionality. To use this method, you must set the flag to `true`. - ]]> + 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 method was called before a previous asynchronous operation finished. In this case, is thrown with the message "An asynchronous operation is already in progress." @@ -4515,7 +4555,9 @@ writer.Close(); ## Remarks This is the asynchronous version of , with the same functionality. To use this method, you must set the flag to `true`. - ]]> + 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 method was called before a previous asynchronous operation finished. In this case, is thrown with the message "An asynchronous operation is already in progress." @@ -4665,7 +4707,9 @@ An asynchronous method was called without ## Remarks This is the asynchronous version of , with the same functionality. To use this method, you must set the flag to `true`. - ]]> + 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 method was called before a previous asynchronous operation finished. In this case, is thrown with the message "An asynchronous operation is already in progress." @@ -4897,7 +4941,9 @@ An asynchronous method was called without ## Remarks This is the asynchronous version of , with the same functionality. To use this method, you must set the flag to `true`. - ]]> + 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 method was called before a previous asynchronous operation finished. In this case, is thrown with the message "An asynchronous operation is already in progress." @@ -4958,7 +5004,9 @@ An asynchronous method was called without ## Remarks This is the asynchronous version of , with the same functionality. To use this method, you must set the flag to `true`. - ]]> + 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 method was called before a previous asynchronous operation finished. In this case, is thrown with the message "An asynchronous operation is already in progress." @@ -5234,7 +5282,9 @@ An method was called before a previous asy ## Remarks This is the asynchronous version of , with the same functionality. To use this method, you must set the flag to `true`. - ]]> + 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 method was called before a previous asynchronous operation finished. In this case, is thrown with the message "An asynchronous operation is already in progress." @@ -5451,7 +5501,9 @@ An method was called before a previous asy ## Remarks This is the asynchronous version of , with the same functionality. To use this method, you must set the flag to `true`. - ]]> + 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 method was called before a previous asynchronous operation finished. In this case, is thrown with the message "An asynchronous operation is already in progress." @@ -5508,7 +5560,9 @@ An asynchronous method was called without ## Remarks This is the asynchronous version of , with the same functionality. To use this method, you must set the flag to `true`. - ]]> + 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 method was called before a previous asynchronous operation finished. In this case, is thrown with the message "An asynchronous operation is already in progress." @@ -5813,7 +5867,9 @@ An method was called before a previous asy ## Remarks This is the asynchronous version of , with the same functionality. To use this method, you must set the flag to `true`. - ]]> + 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 method was called before a previous asynchronous operation finished. In this case, is thrown with the message "An asynchronous operation is already in progress." @@ -5994,7 +6050,9 @@ test<item>test ## Remarks This is the asynchronous version of , with the same functionality. To use this method, you must set the flag to `true`. - ]]> + 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 method was called before a previous asynchronous operation finished. In this case, is thrown with the message "An asynchronous operation is already in progress." @@ -6116,7 +6174,9 @@ An asynchronous method was called without ## Remarks This is the asynchronous version of , with the same functionality. To use this method, you must set the flag to `true`. - ]]> + 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 method was called before a previous asynchronous operation finished. In this case, is thrown with the message "An asynchronous operation is already in progress." @@ -6885,7 +6945,9 @@ An method was called before a previous asy ## Remarks This is the asynchronous version of , with the same functionality. To use this method, you must set the flag to `true`. - ]]> + 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 method was called before a previous asynchronous operation finished. In this case, is thrown with the message "An asynchronous operation is already in progress." diff --git a/xml/System/BinaryData.xml b/xml/System/BinaryData.xml index 45e56c03a39..9b2e7b46e83 100644 --- a/xml/System/BinaryData.xml +++ b/xml/System/BinaryData.xml @@ -389,7 +389,7 @@ 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 . - 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 .