Change TaskCanceledException to OperationCanceledException (#37364)

Author: gewarren

docs/core/extensions/snippets/workers/6.0/windows-service/WindowsBackgroundService.cs

@@ -22,7 +22,7 @@ protected override async Task ExecuteAsync(CancellationToken stoppingToken)
                 await Task.Delay(TimeSpan.FromMinutes(1), stoppingToken);
             }
         }
-        catch (TaskCanceledException)
+        catch (OperationCanceledException)
         {
             // When the stopping token is canceled, for example, a call made from services.msc,
             // we shouldn't exit with a non-zero exit code. In other words, this is expected...

docs/core/extensions/snippets/workers/7.0/windows-service/WindowsBackgroundService.cs

@@ -22,7 +22,7 @@ protected override async Task ExecuteAsync(CancellationToken stoppingToken)
                 await Task.Delay(TimeSpan.FromMinutes(1), stoppingToken);
             }
         }
-        catch (TaskCanceledException)
+        catch (OperationCanceledException)
         {
             // When the stopping token is canceled, for example, a call made from services.msc,
             // we shouldn't exit with a non-zero exit code. In other words, this is expected...

docs/csharp/asynchronous-programming/snippets/cancel-tasks/Program.cs

@@ -59,7 +59,7 @@ static async Task Main()
                 await sumPageSizesTask;
                 Console.WriteLine("Download task completed before cancel request was processed.");
             }
-            catch (TaskCanceledException)
+            catch (OperationCanceledException)
             {
                 Console.WriteLine("Download task has been cancelled.");
             }

docs/fundamentals/networking/snippets/httpclient/Program.Cancellation.cs

@@ -12,7 +12,7 @@ static async Task WithCancellationAsync(HttpClient httpClient)
             using var response = await httpClient.GetAsync(
                 "http://localhost:5001/sleepFor?seconds=100", cts.Token);
         }
-        catch (TaskCanceledException ex) when (cts.IsCancellationRequested)
+        catch (OperationCanceledException ex) when (cts.IsCancellationRequested)
         {
             // When the token has been canceled, it is not a timeout.
             Console.WriteLine($"Canceled: {ex.Message}");

docs/fundamentals/networking/snippets/httpclient/Program.CancellationInnerTimeout.cs

@@ -11,7 +11,7 @@ static async Task WithCancellationAndInnerTimeoutAsync(HttpClient httpClient)
             using var response = await httpClient.GetAsync(
                 "http://localhost:5001/sleepFor?seconds=100");
         }
-        catch (TaskCanceledException ex) when (ex.InnerException is TimeoutException tex)
+        catch (OperationCanceledException ex) when (ex.InnerException is TimeoutException tex)
         {
             Console.WriteLine($"Timed out: {ex.Message}, {tex.Message}");
         }

samples/snippets/csharp/VS_Snippets_Misc/tpl_cancellation/cs/cancel1.cs

@@ -61,7 +61,7 @@ public static async Task Main()
             // Optional: Observe the change in the Status property on the task.
             // It is not necessary to wait on tasks that have canceled. However,
             // if you do wait, you must enclose the call in a try-catch block to
-            // catch the TaskCanceledExceptions that are thrown. If you do
+            // catch the OperationCanceledExceptions that are thrown. If you do
             // not wait, no exception is thrown if the token that was passed to the
             // Task.Run method is the same token that requested the cancellation.
         }

samples/snippets/visualbasic/VS_Snippets_Misc/tpl_cancellation/vb/cancel1.vb

@@ -8,8 +8,8 @@ Module Example
         Dim tokenSource As New CancellationTokenSource()
         Dim token As CancellationToken = tokenSource.Token
 
-        ' Store references to the tasks so that we can wait on them and  
-        ' observe their status after cancellation. 
+        ' Store references to the tasks so that we can wait on them and
+        ' observe their status after cancellation.
         Dim t As Task
         Dim tasks As New ConcurrentBag(Of Task)()
 
@@ -18,26 +18,26 @@ Module Example
         Console.WriteLine("To terminate the example, press 'c' to cancel and exit...")
         Console.WriteLine()
 
-        ' Request cancellation of a single task when the token source is canceled. 
-        ' Pass the token to the user delegate, and also to the task so it can  
+        ' Request cancellation of a single task when the token source is canceled.
+        ' Pass the token to the user delegate, and also to the task so it can
         ' handle the exception correctly.
         t = Task.Factory.StartNew(Sub() DoSomeWork(1, token), token)
         Console.WriteLine("Task {0} executing", t.Id)
         tasks.Add(t)
 
-        ' Request cancellation of a task and its children. Note the token is passed 
-        ' to (1) the user delegate and (2) as the second argument to StartNew, so  
+        ' Request cancellation of a task and its children. Note the token is passed
+        ' to (1) the user delegate and (2) as the second argument to StartNew, so
         ' that the task instance can correctly handle the OperationCanceledException.
         t = Task.Factory.StartNew(Sub()
-                                      ' Create some cancelable child tasks.  
+                                      ' Create some cancelable child tasks.
                                       Dim tc As Task
                                       For i As Integer = 3 To 10
-                                          ' For each child task, pass the same token 
+                                          ' For each child task, pass the same token
                                           ' to each user delegate and to StartNew.
                                           tc = Task.Factory.StartNew(Sub(iteration) DoSomeWork(iteration, token), i, token)
                                           Console.WriteLine("Task {0} executing", tc.Id)
                                           tasks.Add(tc)
-                                          ' Pass the same token again to do work on the parent task.  
+                                          ' Pass the same token again to do work on the parent task.
                                           ' All will be signaled by the call to tokenSource.Cancel below.
                                           DoSomeWork(2, token)
                                       Next
@@ -47,30 +47,29 @@ Module Example
         Console.WriteLine("Task {0} executing", t.Id)
         tasks.Add(t)
 
-        ' Request cancellation from the UI thread. 
+        ' Request cancellation from the UI thread.
         Dim ch As Char = Console.ReadKey().KeyChar
         If ch = "c"c Or ch = "C"c Then
             tokenSource.Cancel()
             Console.WriteLine(vbCrLf + "Task cancellation requested.")
 
-            ' Optional: Observe the change in the Status property on the task. 
-            ' It is not necessary to wait on tasks that have canceled. However, 
-            ' if you do wait, you must enclose the call in a try-catch block to 
-            ' catch the TaskCanceledExceptions that are thrown. If you do  
-            ' not wait, no exception is thrown if the token that was passed to the  
-            ' StartNew method is the same token that requested the cancellation. 
+            ' Optional: Observe the change in the Status property on the task.
+            ' It is not necessary to wait on tasks that have canceled. However,
+            ' if you do wait, you must enclose the call in a try-catch block to
+            ' catch the OperationCanceledExceptions that are thrown. If you do
+            ' not wait, no exception is thrown if the token that was passed to the
+            ' StartNew method is the same token that requested the cancellation.
         End If
 
         Try
             Task.WaitAll(tasks.ToArray())
         Catch e As AggregateException
             Console.WriteLine()
             Console.WriteLine("AggregateException thrown with the following inner exceptions:")
-            ' Display information about each exception. 
+            ' Display information about each exception.
             For Each v In e.InnerExceptions
-                If TypeOf v Is TaskCanceledException
-                    Console.WriteLine("   TaskCanceledException: Task {0}",
-                                      DirectCast(v, TaskCanceledException).Task.Id)
+                If TypeOf v Is OperationCanceledException Then
+                    Console.WriteLine("   The operation was canceled.")
                 Else
                     Console.WriteLine("   Exception: {0}", v.GetType().Name)
                 End If
@@ -80,14 +79,14 @@ Module Example
             tokenSource.Dispose()
         End Try
 
-        ' Display status of all tasks. 
+        ' Display status of all tasks.
         For Each t In tasks
             Console.WriteLine("Task {0} status is now {1}", t.Id, t.Status)
         Next
     End Sub
 
     Sub DoSomeWork(ByVal taskNum As Integer, ByVal ct As CancellationToken)
-        ' Was cancellation already requested? 
+        ' Was cancellation already requested?
         If ct.IsCancellationRequested = True Then
             Console.WriteLine("Task {0} was cancelled before it got started.",
                               taskNum)
@@ -96,13 +95,13 @@ Module Example
 
         Dim maxIterations As Integer = 100
 
-        ' NOTE!!! A "TaskCanceledException was unhandled 
-        ' by user code" error will be raised here if "Just My Code" 
-        ' is enabled on your computer. On Express editions JMC is 
-        ' enabled and cannot be disabled. The exception is benign. 
-        ' Just press F5 to continue executing your code. 
+        ' NOTE!!! A "TaskCanceledException was unhandled
+        ' by user code" error will be raised here if "Just My Code"
+        ' is enabled on your computer. On Express editions JMC is
+        ' enabled and cannot be disabled. The exception is benign.
+        ' Just press F5 to continue executing your code.
         For i As Integer = 0 To maxIterations
-            ' Do a bit of work. Not too much. 
+            ' Do a bit of work. Not too much.
             Dim sw As New SpinWait()
             For j As Integer = 0 To 100
                 sw.SpinOnce()
@@ -117,7 +116,7 @@ End Module
 ' The example displays output like the following:
 '    Press any key to begin tasks...
 '    To terminate the example, press 'c' to cancel and exit...
-'    
+'
 '    Task 1 executing
 '    Task 2 executing
 '    Task 3 executing
@@ -130,12 +129,12 @@ End Module
 '    Task cancellation requested.
 '    Task 2 cancelled
 '    Task 7 cancelled
-'    
+'
 '    AggregateException thrown with the following inner exceptions:
 '       TaskCanceledException: Task 2
 '       TaskCanceledException: Task 8
 '       TaskCanceledException: Task 7
-'    
+'
 '    Task 2 status is now Canceled
 '    Task 1 status is now RanToCompletion
 '    Task 8 status is now Canceled

samples/snippets/visualbasic/VS_Snippets_Misc/tpl_cancellation/vb/project.vbproj

@@ -0,0 +1,8 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <OutputType>Library</OutputType>
+    <TargetFramework>net7.0</TargetFramework>
+  </PropertyGroup>
+
+</Project>