IWorkflowContext.QueueClearScopeAsync Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
| Name | Description |
|---|---|
| QueueClearScopeAsync(CancellationToken) |
Asynchronously clears all state entries within the specified scope. This semantically equivalent to retrieving all keys in the scope and deleting them one-by-one. |
| QueueClearScopeAsync(String, CancellationToken) |
Asynchronously clears all state entries within the specified scope. This semantically equivalent to retrieving all keys in the scope and deleting them one-by-one. |
QueueClearScopeAsync(CancellationToken)
Asynchronously clears all state entries within the specified scope.
This semantically equivalent to retrieving all keys in the scope and deleting them one-by-one.
public virtual System.Threading.Tasks.ValueTask QueueClearScopeAsync(System.Threading.CancellationToken cancellationToken);abstract member QueueClearScopeAsync : System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask
override this.QueueClearScopeAsync : System.Threading.CancellationToken -> System.Threading.Tasks.ValueTaskPublic Overridable Function QueueClearScopeAsync (cancellationToken As CancellationToken) As ValueTaskParameters
- cancellationToken
- CancellationToken
The CancellationToken to monitor for cancellation requests.
Returns
A ValueTask that represents the asynchronous clear operation.
Remarks
Subsequent reads by this executor will not find any entries in the cleared scope. Other executors will only see the cleared state starting from the next SuperStep.
Applies to
QueueClearScopeAsync(String, CancellationToken)
Asynchronously clears all state entries within the specified scope.
This semantically equivalent to retrieving all keys in the scope and deleting them one-by-one.
public System.Threading.Tasks.ValueTask QueueClearScopeAsync(string? scopeName = default, System.Threading.CancellationToken cancellationToken = default);abstract member QueueClearScopeAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTaskPublic Function QueueClearScopeAsync (Optional scopeName As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As ValueTaskParameters
- scopeName
- String
An optional name that specifies the scope to clear. If null, the default scope is used.
- cancellationToken
- CancellationToken
The CancellationToken to monitor for cancellation requests. The default is None.
Returns
A ValueTask that represents the asynchronous clear operation.
Remarks
Subsequent reads by this executor will not find any entries in the cleared scope. Other executors will only see the cleared state starting from the next SuperStep.