1 <?xml version="1.0" encoding="utf-8"?>
4 <name>System.Threading.Tasks</name>
7 <member name="T:System.OperationCanceledException">
8 <summary>The exception that is thrown in a thread upon cancellation of an operation that the thread was executing.</summary>
10 <member name="M:System.OperationCanceledException.#ctor">
11 <summary>Initializes a new instance of the <see cref="T:System.OperationCanceledException" /> class with a system-supplied error message.</summary>
13 <member name="M:System.OperationCanceledException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
14 <summary>Initializes a new instance of the <see cref="T:System.OperationCanceledException" /> class with serialized data.</summary>
15 <param name="info">The object that holds the serialized object data.</param>
16 <param name="context">The contextual information about the source or destination.</param>
18 <member name="M:System.OperationCanceledException.#ctor(System.String)">
19 <summary>Initializes a new instance of the <see cref="T:System.OperationCanceledException" /> class with a specified error message.</summary>
20 <param name="message">A <see cref="T:System.String" /> that describes the error.</param>
22 <member name="M:System.OperationCanceledException.#ctor(System.String,System.Exception)">
23 <summary>Initializes a new instance of the <see cref="T:System.OperationCanceledException" /> class with a specified error message and a reference to the inner exception that is the cause of this exception.</summary>
24 <param name="message">The error message that explains the reason for the exception.</param>
25 <param name="innerException">The exception that is the cause of the current exception. If the <paramref name="innerException" /> parameter is not <see langword="null" />, the current exception is raised in a <see langword="catch" /> block that handles the inner exception.</param>
27 <member name="M:System.OperationCanceledException.#ctor(System.String,System.Exception,System.Threading.CancellationToken)">
28 <summary>Initializes a new instance of the <see cref="T:System.OperationCanceledException" /> class with a specified error message, a reference to the inner exception that is the cause of this exception, and a cancellation token.</summary>
29 <param name="message">The error message that explains the reason for the exception.</param>
30 <param name="innerException">The exception that is the cause of the current exception. If the <paramref name="innerException" /> parameter is not <see langword="null" />, the current exception is raised in a <see langword="catch" /> block that handles the inner exception.</param>
31 <param name="token">A cancellation token associated with the operation that was canceled.</param>
33 <member name="M:System.OperationCanceledException.#ctor(System.String,System.Threading.CancellationToken)">
34 <summary>Initializes a new instance of the <see cref="T:System.OperationCanceledException" /> class with a specified error message and a cancellation token.</summary>
35 <param name="message">The error message that explains the reason for the exception.</param>
36 <param name="token">A cancellation token associated with the operation that was canceled.</param>
38 <member name="M:System.OperationCanceledException.#ctor(System.Threading.CancellationToken)">
39 <summary>Initializes a new instance of the <see cref="T:System.OperationCanceledException" /> class with a cancellation token.</summary>
40 <param name="token">A cancellation token associated with the operation that was canceled.</param>
42 <member name="P:System.OperationCanceledException.CancellationToken">
43 <summary>Gets a token associated with the operation that was canceled.</summary>
44 <returns>A token associated with the operation that was canceled, or a default token.</returns>
46 <member name="T:System.Runtime.CompilerServices.AsyncIteratorMethodBuilder">
47 <summary>Represents a builder for asynchronous iterators.</summary>
49 <member name="M:System.Runtime.CompilerServices.AsyncIteratorMethodBuilder.AwaitOnCompleted``2(``0@,``1@)">
50 <summary>Schedules the state machine to proceed to the next action when the specified awaiter completes.</summary>
51 <param name="awaiter">The awaiter.</param>
52 <param name="stateMachine">The state machine.</param>
53 <typeparam name="TAwaiter">The type of the awaiter.</typeparam>
54 <typeparam name="TStateMachine">The type of the state machine.</typeparam>
56 <member name="M:System.Runtime.CompilerServices.AsyncIteratorMethodBuilder.AwaitUnsafeOnCompleted``2(``0@,``1@)">
57 <summary>Schedules the state machine to proceed to the next action when the specified awaiter completes.</summary>
58 <param name="awaiter">The awaiter.</param>
59 <param name="stateMachine">The state machine.</param>
60 <typeparam name="TAwaiter">The type of the awaiter.</typeparam>
61 <typeparam name="TStateMachine">The type of the state machine.</typeparam>
63 <member name="M:System.Runtime.CompilerServices.AsyncIteratorMethodBuilder.Complete">
64 <summary>Marks iteration as being completed, whether successfully or otherwise.</summary>
66 <member name="M:System.Runtime.CompilerServices.AsyncIteratorMethodBuilder.Create">
67 <summary>Creates an instance of the <see cref="T:System.Runtime.CompilerServices.AsyncIteratorMethodBuilder" /> struct.</summary>
68 <returns>The initialized instance.</returns>
70 <member name="M:System.Runtime.CompilerServices.AsyncIteratorMethodBuilder.MoveNext``1(``0@)">
71 <summary>Invokes <see cref="M:System.Runtime.CompilerServices.IAsyncStateMachine.MoveNext" /> on the state machine while guarding the <see cref="T:System.Threading.ExecutionContext" />.</summary>
72 <param name="stateMachine">The state machine instance, passed by reference.</param>
73 <typeparam name="TStateMachine">The type of the state machine.</typeparam>
75 <member name="T:System.Runtime.CompilerServices.AsyncTaskMethodBuilder">
76 <summary>Represents a builder for asynchronous methods that return a task.</summary>
78 <member name="M:System.Runtime.CompilerServices.AsyncTaskMethodBuilder.AwaitOnCompleted``2(``0@,``1@)">
79 <summary>Schedules the state machine to proceed to the next action when the specified awaiter completes.</summary>
80 <param name="awaiter">The awaiter.</param>
81 <param name="stateMachine">The state machine.</param>
82 <typeparam name="TAwaiter">The type of the awaiter.</typeparam>
83 <typeparam name="TStateMachine">The type of the state machine.</typeparam>
85 <member name="M:System.Runtime.CompilerServices.AsyncTaskMethodBuilder.AwaitUnsafeOnCompleted``2(``0@,``1@)">
86 <summary>Schedules the state machine to proceed to the next action when the specified awaiter completes. This method can be called from partially trusted code.</summary>
87 <param name="awaiter">The awaiter.</param>
88 <param name="stateMachine">The state machine.</param>
89 <typeparam name="TAwaiter">The type of the awaiter.</typeparam>
90 <typeparam name="TStateMachine">The type of the state machine.</typeparam>
92 <member name="M:System.Runtime.CompilerServices.AsyncTaskMethodBuilder.Create">
93 <summary>Creates an instance of the <see cref="T:System.Runtime.CompilerServices.AsyncTaskMethodBuilder" /> class.</summary>
94 <returns>A new instance of the builder.</returns>
96 <member name="M:System.Runtime.CompilerServices.AsyncTaskMethodBuilder.SetException(System.Exception)">
97 <summary>Marks the task as failed and binds the specified exception to the task.</summary>
98 <param name="exception">The exception to bind to the task.</param>
99 <exception cref="T:System.ArgumentNullException">
100 <paramref name="exception" /> is <see langword="null" />.</exception>
101 <exception cref="T:System.InvalidOperationException">The task has already completed.
103 The builder is not initialized.</exception>
105 <member name="M:System.Runtime.CompilerServices.AsyncTaskMethodBuilder.SetResult">
106 <summary>Marks the task as successfully completed.</summary>
107 <exception cref="T:System.InvalidOperationException">The task has already completed.
109 The builder is not initialized.</exception>
111 <member name="M:System.Runtime.CompilerServices.AsyncTaskMethodBuilder.SetStateMachine(System.Runtime.CompilerServices.IAsyncStateMachine)">
112 <summary>Associates the builder with the specified state machine.</summary>
113 <param name="stateMachine">The state machine instance to associate with the builder.</param>
114 <exception cref="T:System.ArgumentNullException">
115 <paramref name="stateMachine" /> is <see langword="null" />.</exception>
116 <exception cref="T:System.InvalidOperationException">The state machine was previously set.</exception>
118 <member name="M:System.Runtime.CompilerServices.AsyncTaskMethodBuilder.Start``1(``0@)">
119 <summary>Begins running the builder with the associated state machine.</summary>
120 <param name="stateMachine">The state machine instance, passed by reference.</param>
121 <typeparam name="TStateMachine">The type of the state machine.</typeparam>
122 <exception cref="T:System.ArgumentNullException">
123 <paramref name="stateMachine" /> is <see langword="null" />.</exception>
125 <member name="P:System.Runtime.CompilerServices.AsyncTaskMethodBuilder.Task">
126 <summary>Gets the task for this builder.</summary>
127 <returns>The task for this builder.</returns>
128 <exception cref="T:System.InvalidOperationException">The builder is not initialized.</exception>
130 <member name="T:System.Runtime.CompilerServices.AsyncTaskMethodBuilder`1">
131 <summary>Represents a builder for asynchronous methods that returns a task and provides a parameter for the result.</summary>
132 <typeparam name="TResult">The result to use to complete the task.</typeparam>
134 <member name="M:System.Runtime.CompilerServices.AsyncTaskMethodBuilder`1.AwaitOnCompleted``2(``0@,``1@)">
135 <summary>Schedules the state machine to proceed to the next action when the specified awaiter completes.</summary>
136 <param name="awaiter">The awaiter.</param>
137 <param name="stateMachine">The state machine.</param>
138 <typeparam name="TAwaiter">The type of the awaiter.</typeparam>
139 <typeparam name="TStateMachine">The type of the state machine.</typeparam>
141 <member name="M:System.Runtime.CompilerServices.AsyncTaskMethodBuilder`1.AwaitUnsafeOnCompleted``2(``0@,``1@)">
142 <summary>Schedules the state machine to proceed to the next action when the specified awaiter completes. This method can be called from partially trusted code.</summary>
143 <param name="awaiter">The awaiter.</param>
144 <param name="stateMachine">The state machine.</param>
145 <typeparam name="TAwaiter">The type of the awaiter.</typeparam>
146 <typeparam name="TStateMachine">The type of the state machine.</typeparam>
148 <member name="M:System.Runtime.CompilerServices.AsyncTaskMethodBuilder`1.Create">
149 <summary>Creates an instance of the <see cref="T:System.Runtime.CompilerServices.AsyncTaskMethodBuilder`1" /> class.</summary>
150 <returns>A new instance of the builder.</returns>
152 <member name="M:System.Runtime.CompilerServices.AsyncTaskMethodBuilder`1.SetException(System.Exception)">
153 <summary>Marks the task as failed and binds the specified exception to the task.</summary>
154 <param name="exception">The exception to bind to the task.</param>
155 <exception cref="T:System.ArgumentNullException">
156 <paramref name="exception" /> is <see langword="null" />.</exception>
157 <exception cref="T:System.InvalidOperationException">The task has already completed.</exception>
159 <member name="M:System.Runtime.CompilerServices.AsyncTaskMethodBuilder`1.SetResult(`0)">
160 <summary>Marks the task as successfully completed.</summary>
161 <param name="result">The result to use to complete the task.</param>
162 <exception cref="T:System.InvalidOperationException">The task has already completed.</exception>
164 <member name="M:System.Runtime.CompilerServices.AsyncTaskMethodBuilder`1.SetStateMachine(System.Runtime.CompilerServices.IAsyncStateMachine)">
165 <summary>Associates the builder with the specified state machine.</summary>
166 <param name="stateMachine">The state machine instance to associate with the builder.</param>
167 <exception cref="T:System.ArgumentNullException">
168 <paramref name="stateMachine" /> is <see langword="null" />.</exception>
169 <exception cref="T:System.InvalidOperationException">The state machine was previously set.</exception>
171 <member name="M:System.Runtime.CompilerServices.AsyncTaskMethodBuilder`1.Start``1(``0@)">
172 <summary>Begins running the builder with the associated state machine.</summary>
173 <param name="stateMachine">The state machine instance, passed by reference.</param>
174 <typeparam name="TStateMachine">The type of the state machine.</typeparam>
175 <exception cref="T:System.ArgumentNullException">
176 <paramref name="stateMachine" /> is <see langword="null" />.</exception>
178 <member name="P:System.Runtime.CompilerServices.AsyncTaskMethodBuilder`1.Task">
179 <summary>Gets the task for this builder.</summary>
180 <returns>The task for this builder.</returns>
182 <member name="T:System.Runtime.CompilerServices.AsyncVoidMethodBuilder">
183 <summary>Represents a builder for asynchronous methods that do not return a value.</summary>
185 <member name="M:System.Runtime.CompilerServices.AsyncVoidMethodBuilder.AwaitOnCompleted``2(``0@,``1@)">
186 <summary>Schedules the state machine to proceed to the next action when the specified awaiter completes.</summary>
187 <param name="awaiter">The awaiter.</param>
188 <param name="stateMachine">The state machine.</param>
189 <typeparam name="TAwaiter">The type of the awaiter.</typeparam>
190 <typeparam name="TStateMachine">The type of the state machine.</typeparam>
192 <member name="M:System.Runtime.CompilerServices.AsyncVoidMethodBuilder.AwaitUnsafeOnCompleted``2(``0@,``1@)">
193 <summary>Schedules the state machine to proceed to the next action when the specified awaiter completes. This method can be called from partially trusted code.</summary>
194 <param name="awaiter">The awaiter.</param>
195 <param name="stateMachine">The state machine.</param>
196 <typeparam name="TAwaiter">The type of the awaiter.</typeparam>
197 <typeparam name="TStateMachine">The type of the state machine.</typeparam>
199 <member name="M:System.Runtime.CompilerServices.AsyncVoidMethodBuilder.Create">
200 <summary>Creates an instance of the <see cref="T:System.Runtime.CompilerServices.AsyncVoidMethodBuilder" /> class.</summary>
201 <returns>A new instance of the builder.</returns>
203 <member name="M:System.Runtime.CompilerServices.AsyncVoidMethodBuilder.SetException(System.Exception)">
204 <summary>Binds an exception to the method builder.</summary>
205 <param name="exception">The exception to bind.</param>
206 <exception cref="T:System.ArgumentNullException">
207 <paramref name="exception" /> is <see langword="null" />.</exception>
208 <exception cref="T:System.InvalidOperationException">The builder is not initialized.</exception>
210 <member name="M:System.Runtime.CompilerServices.AsyncVoidMethodBuilder.SetResult">
211 <summary>Marks the method builder as successfully completed.</summary>
212 <exception cref="T:System.InvalidOperationException">The builder is not initialized.</exception>
214 <member name="M:System.Runtime.CompilerServices.AsyncVoidMethodBuilder.SetStateMachine(System.Runtime.CompilerServices.IAsyncStateMachine)">
215 <summary>Associates the builder with the specified state machine.</summary>
216 <param name="stateMachine">The state machine instance to associate with the builder.</param>
217 <exception cref="T:System.ArgumentNullException">
218 <paramref name="stateMachine" /> is <see langword="null" />.</exception>
219 <exception cref="T:System.InvalidOperationException">The state machine was previously set.</exception>
221 <member name="M:System.Runtime.CompilerServices.AsyncVoidMethodBuilder.Start``1(``0@)">
222 <summary>Begins running the builder with the associated state machine.</summary>
223 <param name="stateMachine">The state machine instance, passed by reference.</param>
224 <typeparam name="TStateMachine">The type of the state machine.</typeparam>
225 <exception cref="T:System.ArgumentNullException">
226 <paramref name="stateMachine" /> is <see langword="null" />.</exception>
228 <member name="T:System.Runtime.CompilerServices.ConfiguredAsyncDisposable">
229 <summary>Provides a type that can be used to configure how awaits on an <see cref="T:System.IAsyncDisposable" /> are performed.</summary>
231 <member name="M:System.Runtime.CompilerServices.ConfiguredAsyncDisposable.DisposeAsync">
232 <summary>Asynchronously releases the unmanaged resources used by the <see cref="T:System.Runtime.CompilerServices.ConfiguredAsyncDisposable" />.</summary>
233 <returns>A task that represents the asynchronous dispose operation.</returns>
235 <member name="T:System.Runtime.CompilerServices.ConfiguredCancelableAsyncEnumerable`1">
236 <summary>Provides an awaitable async enumerable that enables cancelable iteration and configured awaits.</summary>
237 <typeparam name="T">The type of values to enumerate.</typeparam>
239 <member name="M:System.Runtime.CompilerServices.ConfiguredCancelableAsyncEnumerable`1.ConfigureAwait(System.Boolean)">
240 <summary>Configures how awaits on the tasks returned from an async iteration will be performed.</summary>
241 <param name="continueOnCapturedContext">
242 <see langword="true" /> to capture and marshal back to the current context; otherwise, <see langword="false" />.</param>
243 <returns>The configured enumerable.</returns>
245 <member name="T:System.Runtime.CompilerServices.ConfiguredCancelableAsyncEnumerable`1.Enumerator">
246 <summary>Provides an awaitable async enumerator that enables cancelable iteration and configured awaits.</summary>
247 <typeparam name="T">The type of values to enumerate.</typeparam>
249 <member name="P:System.Runtime.CompilerServices.ConfiguredCancelableAsyncEnumerable`1.Enumerator.Current">
250 <summary>Gets the element in the collection at the current position of the enumerator.</summary>
251 <returns>The element in the collection at the current position of the enumerator.</returns>
253 <member name="M:System.Runtime.CompilerServices.ConfiguredCancelableAsyncEnumerable`1.Enumerator.DisposeAsync">
254 <summary>Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources asynchronously.</summary>
255 <returns>A task that represents the asynchronous dispose operation.</returns>
257 <member name="M:System.Runtime.CompilerServices.ConfiguredCancelableAsyncEnumerable`1.Enumerator.MoveNextAsync">
258 <summary>Advances the enumerator asynchronously to the next element of the collection.</summary>
259 <returns>A <see cref="T:System.Runtime.CompilerServices.ConfiguredValueTaskAwaitable`1" /> that will complete with a result of <see langword="true" /> if the enumerator was successfully advanced to the next element, or <see langword="false" /> if the enumerator has passed the end of the collection.</returns>
261 <member name="M:System.Runtime.CompilerServices.ConfiguredCancelableAsyncEnumerable`1.GetAsyncEnumerator">
262 <summary>Returns an enumerator that iterates asynchronously through collections that enables cancelable iteration and configured awaits.</summary>
263 <returns>An enumerator for the <see cref="T:System.Runtime.CompilerServices.ConfiguredCancelableAsyncEnumerable`1" /> class.</returns>
265 <member name="M:System.Runtime.CompilerServices.ConfiguredCancelableAsyncEnumerable`1.WithCancellation(System.Threading.CancellationToken)">
266 <summary>Sets the <see cref="T:System.Threading.CancellationToken" /> to be passed to <see cref="M:System.Collections.Generic.IAsyncEnumerable`1.GetAsyncEnumerator(System.Threading.CancellationToken)" /> when iterating.</summary>
267 <param name="cancellationToken">The cancellation token to use.</param>
268 <returns>The configured enumerable.</returns>
270 <member name="T:System.Threading.CancellationTokenSource">
271 <summary>Signals to a <see cref="T:System.Threading.CancellationToken" /> that it should be canceled.</summary>
273 <member name="M:System.Threading.CancellationTokenSource.#ctor">
274 <summary>Initializes a new instance of the <see cref="T:System.Threading.CancellationTokenSource" /> class.</summary>
276 <member name="M:System.Threading.CancellationTokenSource.#ctor(System.Int32)">
277 <summary>Initializes a new instance of the <see cref="T:System.Threading.CancellationTokenSource" /> class that will be canceled after the specified delay in milliseconds.</summary>
278 <param name="millisecondsDelay">The time interval in milliseconds to wait before canceling this <see cref="T:System.Threading.CancellationTokenSource" />.</param>
279 <exception cref="T:System.ArgumentOutOfRangeException">
280 <paramref name="millisecondsDelay" /> is less than -1.</exception>
282 <member name="M:System.Threading.CancellationTokenSource.#ctor(System.TimeSpan)">
283 <summary>Initializes a new instance of the <see cref="T:System.Threading.CancellationTokenSource" /> class that will be canceled after the specified time span.</summary>
284 <param name="delay">The time interval to wait before canceling this <see cref="T:System.Threading.CancellationTokenSource" />.</param>
285 <exception cref="T:System.ArgumentOutOfRangeException">
286 <paramref name="delay" />.<see cref="P:System.TimeSpan.TotalMilliseconds" /> is less than -1 or greater than <see cref="F:System.Int32.MaxValue" />.</exception>
288 <member name="M:System.Threading.CancellationTokenSource.Cancel">
289 <summary>Communicates a request for cancellation.</summary>
290 <exception cref="T:System.ObjectDisposedException">This <see cref="T:System.Threading.CancellationTokenSource" /> has been disposed.</exception>
291 <exception cref="T:System.AggregateException">An aggregate exception containing all the exceptions thrown by the registered callbacks on the associated <see cref="T:System.Threading.CancellationToken" />.</exception>
293 <member name="M:System.Threading.CancellationTokenSource.Cancel(System.Boolean)">
294 <summary>Communicates a request for cancellation, and specifies whether remaining callbacks and cancelable operations should be processed if an exception occurs.</summary>
295 <param name="throwOnFirstException">
296 <see langword="true" /> if exceptions should immediately propagate; otherwise, <see langword="false" />.</param>
297 <exception cref="T:System.ObjectDisposedException">This <see cref="T:System.Threading.CancellationTokenSource" /> has been disposed.</exception>
298 <exception cref="T:System.AggregateException">An aggregate exception containing all the exceptions thrown by the registered callbacks on the associated <see cref="T:System.Threading.CancellationToken" />.</exception>
300 <member name="M:System.Threading.CancellationTokenSource.CancelAfter(System.Int32)">
301 <summary>Schedules a cancel operation on this <see cref="T:System.Threading.CancellationTokenSource" /> after the specified number of milliseconds.</summary>
302 <param name="millisecondsDelay">The time span to wait before canceling this <see cref="T:System.Threading.CancellationTokenSource" />.</param>
303 <exception cref="T:System.ObjectDisposedException">The exception thrown when this <see cref="T:System.Threading.CancellationTokenSource" /> has been disposed.</exception>
304 <exception cref="T:System.ArgumentOutOfRangeException">The exception thrown when <paramref name="millisecondsDelay" /> is less than -1.</exception>
306 <member name="M:System.Threading.CancellationTokenSource.CancelAfter(System.TimeSpan)">
307 <summary>Schedules a cancel operation on this <see cref="T:System.Threading.CancellationTokenSource" /> after the specified time span.</summary>
308 <param name="delay">The time span to wait before canceling this <see cref="T:System.Threading.CancellationTokenSource" />.</param>
309 <exception cref="T:System.ObjectDisposedException">The exception thrown when this <see cref="T:System.Threading.CancellationTokenSource" /> has been disposed.</exception>
310 <exception cref="T:System.ArgumentOutOfRangeException">The exception that is thrown when <paramref name="delay" /> is less than -1 or greater than Int32.MaxValue.</exception>
312 <member name="M:System.Threading.CancellationTokenSource.CreateLinkedTokenSource(System.Threading.CancellationToken,System.Threading.CancellationToken)">
313 <summary>Creates a <see cref="T:System.Threading.CancellationTokenSource" /> that will be in the canceled state when any of the source tokens are in the canceled state.</summary>
314 <param name="token1">The first cancellation token to observe.</param>
315 <param name="token2">The second cancellation token to observe.</param>
316 <returns>A <see cref="T:System.Threading.CancellationTokenSource" /> that is linked to the source tokens.</returns>
317 <exception cref="T:System.ObjectDisposedException">A <see cref="T:System.Threading.CancellationTokenSource" /> associated with one of the source tokens has been disposed.</exception>
319 <member name="M:System.Threading.CancellationTokenSource.CreateLinkedTokenSource(System.Threading.CancellationToken[])">
320 <summary>Creates a <see cref="T:System.Threading.CancellationTokenSource" /> that will be in the canceled state when any of the source tokens in the specified array are in the canceled state.</summary>
321 <param name="tokens">An array that contains the cancellation token instances to observe.</param>
322 <returns>A <see cref="T:System.Threading.CancellationTokenSource" /> that is linked to the source tokens.</returns>
323 <exception cref="T:System.ObjectDisposedException">A <see cref="T:System.Threading.CancellationTokenSource" /> associated with one of the source tokens has been disposed.</exception>
324 <exception cref="T:System.ArgumentNullException">
325 <paramref name="tokens" /> is <see langword="null" />.</exception>
326 <exception cref="T:System.ArgumentException">
327 <paramref name="tokens" /> is empty.</exception>
329 <member name="M:System.Threading.CancellationTokenSource.Dispose">
330 <summary>Releases all resources used by the current instance of the <see cref="T:System.Threading.CancellationTokenSource" /> class.</summary>
332 <member name="M:System.Threading.CancellationTokenSource.Dispose(System.Boolean)">
333 <summary>Releases the unmanaged resources used by the <see cref="T:System.Threading.CancellationTokenSource" /> class and optionally releases the managed resources.</summary>
334 <param name="disposing">
335 <see langword="true" /> to release both managed and unmanaged resources; <see langword="false" /> to release only unmanaged resources.</param>
337 <member name="P:System.Threading.CancellationTokenSource.IsCancellationRequested">
338 <summary>Gets whether cancellation has been requested for this <see cref="T:System.Threading.CancellationTokenSource" />.</summary>
340 <see langword="true" /> if cancellation has been requested for this <see cref="T:System.Threading.CancellationTokenSource" />; otherwise, <see langword="false" />.</returns>
342 <member name="P:System.Threading.CancellationTokenSource.Token">
343 <summary>Gets the <see cref="T:System.Threading.CancellationToken" /> associated with this <see cref="T:System.Threading.CancellationTokenSource" />.</summary>
344 <returns>The <see cref="T:System.Threading.CancellationToken" /> associated with this <see cref="T:System.Threading.CancellationTokenSource" />.</returns>
345 <exception cref="T:System.ObjectDisposedException">The token source has been disposed.</exception>
347 <member name="T:System.Threading.Tasks.ConcurrentExclusiveSchedulerPair">
348 <summary>Provides task schedulers that coordinate to execute tasks while ensuring that concurrent tasks may run concurrently and exclusive tasks never do.</summary>
350 <member name="M:System.Threading.Tasks.ConcurrentExclusiveSchedulerPair.#ctor">
351 <summary>Initializes a new instance of the <see cref="T:System.Threading.Tasks.ConcurrentExclusiveSchedulerPair" /> class.</summary>
353 <member name="M:System.Threading.Tasks.ConcurrentExclusiveSchedulerPair.#ctor(System.Threading.Tasks.TaskScheduler)">
354 <summary>Initializes a new instance of the <see cref="T:System.Threading.Tasks.ConcurrentExclusiveSchedulerPair" /> class that targets the specified scheduler.</summary>
355 <param name="taskScheduler">The target scheduler on which this pair should execute.</param>
357 <member name="M:System.Threading.Tasks.ConcurrentExclusiveSchedulerPair.#ctor(System.Threading.Tasks.TaskScheduler,System.Int32)">
358 <summary>Initializes a new instance of the <see cref="T:System.Threading.Tasks.ConcurrentExclusiveSchedulerPair" /> class that targets the specified scheduler with a maximum concurrency level.</summary>
359 <param name="taskScheduler">The target scheduler on which this pair should execute.</param>
360 <param name="maxConcurrencyLevel">The maximum number of tasks to run concurrently.</param>
362 <member name="M:System.Threading.Tasks.ConcurrentExclusiveSchedulerPair.#ctor(System.Threading.Tasks.TaskScheduler,System.Int32,System.Int32)">
363 <summary>Initializes a new instance of the <see cref="T:System.Threading.Tasks.ConcurrentExclusiveSchedulerPair" /> class that targets the specified scheduler with a maximum concurrency level and a maximum number of scheduled tasks that may be processed as a unit.</summary>
364 <param name="taskScheduler">The target scheduler on which this pair should execute.</param>
365 <param name="maxConcurrencyLevel">The maximum number of tasks to run concurrently.</param>
366 <param name="maxItemsPerTask">The maximum number of tasks to process for each underlying scheduled task used by the pair.</param>
368 <member name="M:System.Threading.Tasks.ConcurrentExclusiveSchedulerPair.Complete">
369 <summary>Informs the scheduler pair that it should not accept any more tasks.</summary>
371 <member name="P:System.Threading.Tasks.ConcurrentExclusiveSchedulerPair.Completion">
372 <summary>Gets a <see cref="T:System.Threading.Tasks.Task" /> that will complete when the scheduler has completed processing.</summary>
373 <returns>The asynchronous operation that will complete when the scheduler finishes processing.</returns>
375 <member name="P:System.Threading.Tasks.ConcurrentExclusiveSchedulerPair.ConcurrentScheduler">
376 <summary>Gets a <see cref="T:System.Threading.Tasks.TaskScheduler" /> that can be used to schedule tasks to this pair that may run concurrently with other tasks on this pair.</summary>
377 <returns>An object that can be used to schedule tasks concurrently.</returns>
379 <member name="P:System.Threading.Tasks.ConcurrentExclusiveSchedulerPair.ExclusiveScheduler">
380 <summary>Gets a <see cref="T:System.Threading.Tasks.TaskScheduler" /> that can be used to schedule tasks to this pair that must run exclusively with regards to other tasks on this pair.</summary>
381 <returns>An object that can be used to schedule tasks that do not run concurrently with other tasks.</returns>
383 <member name="T:System.Threading.Tasks.TaskAsyncEnumerableExtensions">
384 <summary>Provides a set of static methods for configuring task-related behaviors on asynchronous enumerables and disposables.</summary>
386 <member name="M:System.Threading.Tasks.TaskAsyncEnumerableExtensions.ConfigureAwait(System.IAsyncDisposable,System.Boolean)">
387 <summary>Configures how awaits on the tasks returned from an async disposable are performed.</summary>
388 <param name="source">The source async disposable.</param>
389 <param name="continueOnCapturedContext">
390 <see langword="true" /> to capture and marshal back to the current context; otherwise, <see langword="false" />.</param>
391 <returns>The configured async disposable.</returns>
393 <member name="M:System.Threading.Tasks.TaskAsyncEnumerableExtensions.ConfigureAwait``1(System.Collections.Generic.IAsyncEnumerable{``0},System.Boolean)">
394 <summary>Configures how awaits on the tasks returned from an async iteration are performed.</summary>
395 <param name="source">The source enumerable to iterate.</param>
396 <param name="continueOnCapturedContext">
397 <see langword="true" /> to capture and marshal back to the current context; otherwise, <see langword="false" />.</param>
398 <typeparam name="T">The type of the objects to iterate.</typeparam>
399 <returns>The configured enumerable.</returns>
401 <member name="M:System.Threading.Tasks.TaskAsyncEnumerableExtensions.WithCancellation``1(System.Collections.Generic.IAsyncEnumerable{``0},System.Threading.CancellationToken)">
402 <summary>Sets the <see cref="T:System.Threading.CancellationToken" /> to be passed to <see cref="M:System.Collections.Generic.IAsyncEnumerable`1.GetAsyncEnumerator(System.Threading.CancellationToken)" /> when iterating.</summary>
403 <param name="source">The source enumerable to iterate.</param>
404 <param name="cancellationToken">The cancellation token to use.</param>
405 <typeparam name="T">The type of the objects to iterate.</typeparam>
406 <returns>The configured enumerable.</returns>
408 <member name="T:System.Threading.Tasks.TaskCanceledException">
409 <summary>Represents an exception used to communicate task cancellation.</summary>
411 <member name="M:System.Threading.Tasks.TaskCanceledException.#ctor">
412 <summary>Initializes a new instance of the <see cref="T:System.Threading.Tasks.TaskCanceledException" /> class with a system-supplied message that describes the error.</summary>
414 <member name="M:System.Threading.Tasks.TaskCanceledException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
415 <summary>Initializes a new instance of the <see cref="T:System.Threading.Tasks.TaskCanceledException" /> class with serialized data.</summary>
416 <param name="info">The object that holds the serialized object data.</param>
417 <param name="context">The contextual information about the source or destination.</param>
419 <member name="M:System.Threading.Tasks.TaskCanceledException.#ctor(System.String)">
420 <summary>Initializes a new instance of the <see cref="T:System.Threading.Tasks.TaskCanceledException" /> class with a specified message that describes the error.</summary>
421 <param name="message">The message that describes the exception. The caller of this constructor is required to ensure that this string has been localized for the current system culture.</param>
423 <member name="M:System.Threading.Tasks.TaskCanceledException.#ctor(System.String,System.Exception)">
424 <summary>Initializes a new instance of the <see cref="T:System.Threading.Tasks.TaskCanceledException" /> class with a specified error message and a reference to the inner exception that is the cause of this exception.</summary>
425 <param name="message">The message that describes the exception. The caller of this constructor is required to ensure that this string has been localized for the current system culture.</param>
426 <param name="innerException">The exception that is the cause of the current exception. If the <paramref name="innerException" /> parameter is not <see langword="null" />, the current exception is raised in a <see langword="catch" /> block that handles the inner exception.</param>
428 <member name="M:System.Threading.Tasks.TaskCanceledException.#ctor(System.String,System.Exception,System.Threading.CancellationToken)">
429 <summary>Initializes a new instance of the <see cref="T:System.Threading.Tasks.TaskCanceledException" /> class with a specified error message, a reference to the inner exception that is the cause of this exception, and the <see cref="T:System.Threading.CancellationToken" /> that triggered the cancellation.</summary>
430 <param name="message">The error message that explains the reason for the exception.</param>
431 <param name="innerException">The exception that is the cause of the current exception.</param>
432 <param name="token">The cancellation token that triggered the cancellation.</param>
434 <member name="M:System.Threading.Tasks.TaskCanceledException.#ctor(System.Threading.Tasks.Task)">
435 <summary>Initializes a new instance of the <see cref="T:System.Threading.Tasks.TaskCanceledException" /> class with a reference to the <see cref="T:System.Threading.Tasks.Task" /> that has been canceled.</summary>
436 <param name="task">A task that has been canceled.</param>
438 <member name="P:System.Threading.Tasks.TaskCanceledException.Task">
439 <summary>Gets the task associated with this exception.</summary>
440 <returns>A reference to the <see cref="T:System.Threading.Tasks.Task" /> that is associated with this exception.</returns>
442 <member name="T:System.Threading.Tasks.TaskCompletionSource`1">
443 <summary>Represents the producer side of a <see cref="T:System.Threading.Tasks.Task`1" /> unbound to a delegate, providing access to the consumer side through the <see cref="P:System.Threading.Tasks.TaskCompletionSource`1.Task" /> property.</summary>
444 <typeparam name="TResult">The type of the result value associated with this <see cref="T:System.Threading.Tasks.TaskCompletionSource`1" />.</typeparam>
446 <member name="M:System.Threading.Tasks.TaskCompletionSource`1.#ctor">
447 <summary>Creates a <see cref="T:System.Threading.Tasks.TaskCompletionSource`1" />.</summary>
449 <member name="M:System.Threading.Tasks.TaskCompletionSource`1.#ctor(System.Object)">
450 <summary>Creates a <see cref="T:System.Threading.Tasks.TaskCompletionSource`1" /> with the specified state.</summary>
451 <param name="state">The state to use as the underlying <see cref="T:System.Threading.Tasks.Task`1" />'s AsyncState.</param>
453 <member name="M:System.Threading.Tasks.TaskCompletionSource`1.#ctor(System.Object,System.Threading.Tasks.TaskCreationOptions)">
454 <summary>Creates a <see cref="T:System.Threading.Tasks.TaskCompletionSource`1" /> with the specified state and options.</summary>
455 <param name="state">The state to use as the underlying <see cref="T:System.Threading.Tasks.Task`1" />'s AsyncState.</param>
456 <param name="creationOptions">The options to use when creating the underlying <see cref="T:System.Threading.Tasks.Task`1" />.</param>
457 <exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="creationOptions" /> represent options invalid for use with a <see cref="T:System.Threading.Tasks.TaskCompletionSource`1" />.</exception>
459 <member name="M:System.Threading.Tasks.TaskCompletionSource`1.#ctor(System.Threading.Tasks.TaskCreationOptions)">
460 <summary>Creates a <see cref="T:System.Threading.Tasks.TaskCompletionSource`1" /> with the specified options.</summary>
461 <param name="creationOptions">The options to use when creating the underlying <see cref="T:System.Threading.Tasks.Task`1" />.</param>
462 <exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="creationOptions" /> represent options invalid for use with a <see cref="T:System.Threading.Tasks.TaskCompletionSource`1" />.</exception>
464 <member name="M:System.Threading.Tasks.TaskCompletionSource`1.SetCanceled">
465 <summary>Transitions the underlying <see cref="T:System.Threading.Tasks.Task`1" /> into the <see cref="F:System.Threading.Tasks.TaskStatus.Canceled" /> state.</summary>
466 <exception cref="T:System.InvalidOperationException">The underlying <see cref="T:System.Threading.Tasks.Task`1" /> is already in one of the three final states: <see cref="F:System.Threading.Tasks.TaskStatus.RanToCompletion" />, <see cref="F:System.Threading.Tasks.TaskStatus.Faulted" />, or <see cref="F:System.Threading.Tasks.TaskStatus.Canceled" />, or if the underlying <see cref="T:System.Threading.Tasks.Task`1" /> has already been disposed.</exception>
467 <exception cref="T:System.ObjectDisposedException">The <see cref="P:System.Threading.Tasks.TaskCompletionSource`1.Task" /> was disposed.</exception>
469 <member name="M:System.Threading.Tasks.TaskCompletionSource`1.SetException(System.Collections.Generic.IEnumerable{System.Exception})">
470 <summary>Transitions the underlying <see cref="T:System.Threading.Tasks.Task`1" /> into the <see cref="F:System.Threading.Tasks.TaskStatus.Faulted" /> state and binds a collection of exception objects to it.</summary>
471 <param name="exceptions">The collection of exceptions to bind to this <see cref="T:System.Threading.Tasks.Task`1" />.</param>
472 <exception cref="T:System.ObjectDisposedException">The <see cref="P:System.Threading.Tasks.TaskCompletionSource`1.Task" /> was disposed.</exception>
473 <exception cref="T:System.ArgumentNullException">The <paramref name="exceptions" /> argument is <see langword="null" />.</exception>
474 <exception cref="T:System.ArgumentException">There are one or more null elements in <paramref name="exceptions" />.</exception>
475 <exception cref="T:System.InvalidOperationException">The underlying <see cref="T:System.Threading.Tasks.Task`1" /> is already in one of the three final states: <see cref="F:System.Threading.Tasks.TaskStatus.RanToCompletion" />, <see cref="F:System.Threading.Tasks.TaskStatus.Faulted" />, or <see cref="F:System.Threading.Tasks.TaskStatus.Canceled" />.</exception>
477 <member name="M:System.Threading.Tasks.TaskCompletionSource`1.SetException(System.Exception)">
478 <summary>Transitions the underlying <see cref="T:System.Threading.Tasks.Task`1" /> into the <see cref="F:System.Threading.Tasks.TaskStatus.Faulted" /> state and binds it to a specified exception.</summary>
479 <param name="exception">The exception to bind to this <see cref="T:System.Threading.Tasks.Task`1" />.</param>
480 <exception cref="T:System.ObjectDisposedException">The <see cref="P:System.Threading.Tasks.TaskCompletionSource`1.Task" /> was disposed.</exception>
481 <exception cref="T:System.ArgumentNullException">The <paramref name="exception" /> argument is <see langword="null" />.</exception>
482 <exception cref="T:System.InvalidOperationException">The underlying <see cref="T:System.Threading.Tasks.Task`1" /> is already in one of the three final states: <see cref="F:System.Threading.Tasks.TaskStatus.RanToCompletion" />, <see cref="F:System.Threading.Tasks.TaskStatus.Faulted" />, or <see cref="F:System.Threading.Tasks.TaskStatus.Canceled" />.</exception>
484 <member name="M:System.Threading.Tasks.TaskCompletionSource`1.SetResult(`0)">
485 <summary>Transitions the underlying <see cref="T:System.Threading.Tasks.Task`1" /> into the <see cref="F:System.Threading.Tasks.TaskStatus.RanToCompletion" /> state.</summary>
486 <param name="result">The result value to bind to this <see cref="T:System.Threading.Tasks.Task`1" />.</param>
487 <exception cref="T:System.ObjectDisposedException">The <see cref="P:System.Threading.Tasks.TaskCompletionSource`1.Task" /> was disposed.</exception>
488 <exception cref="T:System.InvalidOperationException">The underlying <see cref="T:System.Threading.Tasks.Task`1" /> is already in one of the three final states: <see cref="F:System.Threading.Tasks.TaskStatus.RanToCompletion" />, <see cref="F:System.Threading.Tasks.TaskStatus.Faulted" />, or <see cref="F:System.Threading.Tasks.TaskStatus.Canceled" />.</exception>
490 <member name="P:System.Threading.Tasks.TaskCompletionSource`1.Task">
491 <summary>Gets the <see cref="T:System.Threading.Tasks.Task`1" /> created by this <see cref="T:System.Threading.Tasks.TaskCompletionSource`1" />.</summary>
492 <returns>Returns the <see cref="T:System.Threading.Tasks.Task`1" /> created by this <see cref="T:System.Threading.Tasks.TaskCompletionSource`1" />.</returns>
494 <member name="M:System.Threading.Tasks.TaskCompletionSource`1.TrySetCanceled">
495 <summary>Attempts to transition the underlying <see cref="T:System.Threading.Tasks.Task`1" /> into the <see cref="F:System.Threading.Tasks.TaskStatus.Canceled" /> state.</summary>
497 <see langword="true" /> if the operation was successful; false if the operation was unsuccessful or the object has already been disposed.</returns>
498 <exception cref="T:System.ObjectDisposedException">The <see cref="P:System.Threading.Tasks.TaskCompletionSource`1.Task" /> was disposed.</exception>
500 <member name="M:System.Threading.Tasks.TaskCompletionSource`1.TrySetCanceled(System.Threading.CancellationToken)">
501 <summary>Attempts to transition the underlying <see cref="T:System.Threading.Tasks.Task`1" /> into the <see cref="F:System.Threading.Tasks.TaskStatus.Canceled" /> state and enables a cancellation token to be stored in the canceled task.</summary>
502 <param name="cancellationToken">A cancellation token.</param>
504 <see langword="true" /> if the operation is successful; otherwise, <see langword="false" />.</returns>
506 <member name="M:System.Threading.Tasks.TaskCompletionSource`1.TrySetException(System.Collections.Generic.IEnumerable{System.Exception})">
507 <summary>Attempts to transition the underlying <see cref="T:System.Threading.Tasks.Task`1" /> into the <see cref="F:System.Threading.Tasks.TaskStatus.Faulted" /> state and binds a collection of exception objects to it.</summary>
508 <param name="exceptions">The collection of exceptions to bind to this <see cref="T:System.Threading.Tasks.Task`1" />.</param>
510 <see langword="true" /> if the operation was successful; otherwise, <see langword="false" />.</returns>
511 <exception cref="T:System.ObjectDisposedException">The <see cref="P:System.Threading.Tasks.TaskCompletionSource`1.Task" /> was disposed.</exception>
512 <exception cref="T:System.ArgumentNullException">The <paramref name="exceptions" /> argument is <see langword="null" />.</exception>
513 <exception cref="T:System.ArgumentException">There are one or more null elements in <paramref name="exceptions" />.
515 The <paramref name="exceptions" /> collection is empty.</exception>
517 <member name="M:System.Threading.Tasks.TaskCompletionSource`1.TrySetException(System.Exception)">
518 <summary>Attempts to transition the underlying <see cref="T:System.Threading.Tasks.Task`1" /> into the <see cref="F:System.Threading.Tasks.TaskStatus.Faulted" /> state and binds it to a specified exception.</summary>
519 <param name="exception">The exception to bind to this <see cref="T:System.Threading.Tasks.Task`1" />.</param>
521 <see langword="true" /> if the operation was successful; otherwise, <see langword="false" />.</returns>
522 <exception cref="T:System.ObjectDisposedException">The <see cref="P:System.Threading.Tasks.TaskCompletionSource`1.Task" /> was disposed.</exception>
523 <exception cref="T:System.ArgumentNullException">The <paramref name="exception" /> argument is <see langword="null" />.</exception>
525 <member name="M:System.Threading.Tasks.TaskCompletionSource`1.TrySetResult(`0)">
526 <summary>Attempts to transition the underlying <see cref="T:System.Threading.Tasks.Task`1" /> into the <see cref="F:System.Threading.Tasks.TaskStatus.RanToCompletion" /> state.</summary>
527 <param name="result">The result value to bind to this <see cref="T:System.Threading.Tasks.Task`1" />.</param>
529 <see langword="true" /> if the operation was successful; otherwise, <see langword="false" />.</returns>
530 <exception cref="T:System.ObjectDisposedException">The <see cref="P:System.Threading.Tasks.TaskCompletionSource`1.Task" /> was disposed.</exception>
532 <member name="T:System.Threading.Tasks.TaskExtensions">
533 <summary>Provides a set of static (Shared in Visual Basic) methods for working with specific kinds of <see cref="T:System.Threading.Tasks.Task" /> instances.</summary>
535 <member name="M:System.Threading.Tasks.TaskExtensions.Unwrap(System.Threading.Tasks.Task{System.Threading.Tasks.Task})">
536 <summary>Creates a proxy <see cref="T:System.Threading.Tasks.Task" /> that represents the asynchronous operation of a <see cref="M:System.Threading.Tasks.TaskScheduler.TryExecuteTaskInline(System.Threading.Tasks.Task,System.Boolean)" />.</summary>
537 <param name="task">The <see langword="Task<Task>" /> (C#) or <see langword="Task (Of Task)" /> (Visual Basic) to unwrap.</param>
538 <returns>A Task that represents the asynchronous operation of the provided <see langword="System.Threading.Tasks.Task(Of Task)" />.</returns>
539 <exception cref="T:System.ArgumentNullException">The exception that is thrown if the <paramref name="task" /> argument is null.</exception>
541 <member name="M:System.Threading.Tasks.TaskExtensions.Unwrap``1(System.Threading.Tasks.Task{System.Threading.Tasks.Task{``0}})">
542 <summary>Creates a proxy <see cref="T:System.Threading.Tasks.Task" /> that represents the asynchronous operation of a <see langword="Task<Task<T>>" /> (C#) or <see langword="Task (Of Task(Of T))" /> (Visual Basic).</summary>
543 <param name="task">The <see langword="Task<Task<T>>" /> (C#) or <see langword="Task (Of Task(Of T))" /> (Visual Basic) to unwrap.</param>
544 <typeparam name="TResult">The type of the task's result.</typeparam>
545 <returns>A <see cref="T:System.Threading.Tasks.Task" /> that represents the asynchronous operation of the provided <see langword="Task<Task<T>>" /> (C#) or <see langword="Task (Of Task(Of T))" /> (Visual Basic).</returns>
546 <exception cref="T:System.ArgumentNullException">The exception that is thrown if the <paramref name="task" /> argument is null.</exception>
548 <member name="T:System.Threading.Tasks.TaskSchedulerException">
549 <summary>Represents an exception used to communicate an invalid operation by a <see cref="T:System.Threading.Tasks.TaskScheduler" />.</summary>
551 <member name="M:System.Threading.Tasks.TaskSchedulerException.#ctor">
552 <summary>Initializes a new instance of the <see cref="T:System.Threading.Tasks.TaskSchedulerException" /> class with a system-supplied message that describes the error.</summary>
554 <member name="M:System.Threading.Tasks.TaskSchedulerException.#ctor(System.Exception)">
555 <summary>Initializes a new instance of the <see cref="T:System.Threading.Tasks.TaskSchedulerException" /> class using the default error message and a reference to the inner exception that is the cause of this exception.</summary>
556 <param name="innerException">The exception that is the cause of the current exception.</param>
558 <member name="M:System.Threading.Tasks.TaskSchedulerException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
559 <summary>Initializes a new instance of the <see cref="T:System.Threading.Tasks.TaskSchedulerException" /> class with serialized data.</summary>
560 <param name="info">The object that holds the serialized object data.</param>
561 <param name="context">The contextual information about the source or destination.</param>
563 <member name="M:System.Threading.Tasks.TaskSchedulerException.#ctor(System.String)">
564 <summary>Initializes a new instance of the <see cref="T:System.Threading.Tasks.TaskSchedulerException" /> class with a specified message that describes the error.</summary>
565 <param name="message">The message that describes the exception. The caller of this constructor is required to ensure that this string has been localized for the current system culture.</param>
567 <member name="M:System.Threading.Tasks.TaskSchedulerException.#ctor(System.String,System.Exception)">
568 <summary>Initializes a new instance of the <see cref="T:System.Threading.Tasks.TaskSchedulerException" /> class with a specified error message and a reference to the inner exception that is the cause of this exception.</summary>
569 <param name="message">The message that describes the exception. The caller of this constructor is required to ensure that this string has been localized for the current system culture.</param>
570 <param name="innerException">The exception that is the cause of the current exception. If the <paramref name="innerException" /> parameter is not <see langword="null" />, the current exception is raised in a <see langword="catch" /> block that handles the inner exception.</param>