Method GetAsyncEnumerator
GetAsyncEnumerator(CancellationToken)
Exposes an asynchronous enumerator for progress reporting.
Declaration
public IAsyncEnumerator<ProgressValue> GetAsyncEnumerator(CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| IAsyncEnumerator<ProgressValue> |
Implements
Remarks
If awaiting has already been started (via either GetAwaiter (i.e., await on this task) or GetAsyncEnumerator), then
this method will throw an InvalidOperationException.
To get the final result of this task, you must await on this instance again (which calls to GetAwaiter).
The provided cancellationToken only cancels the progress reporting enumeration (which can be cancelled through Dispose also).