WorkflowControlClient.CancelAsync 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.
Begins an asynchronous operation that cancels the specified workflow instance.
Overloads
| CancelAsync(Guid) |
Begins an asynchronous operation that cancels the specified workflow instance. |
| CancelAsync(Guid, Object) |
Begins an asynchronous operation that cancels the specified workflow instance with the specified user-defined data. |
CancelAsync(Guid)
Begins an asynchronous operation that cancels the specified workflow instance.
public:
void CancelAsync(Guid instanceId);public void CancelAsync (Guid instanceId);member this.CancelAsync : Guid -> unitPublic Sub CancelAsync (instanceId As Guid)Parameters
- instanceId
- Guid
The workflow instance to cancel.
Remarks
This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as ArgumentException, are still thrown synchronously. For the stored exceptions, see the exceptions thrown by Cancel(Guid).
Applies to
CancelAsync(Guid, Object)
Begins an asynchronous operation that cancels the specified workflow instance with the specified user-defined data.
public:
void CancelAsync(Guid instanceId, System::Object ^ userState);public void CancelAsync (Guid instanceId, object userState);member this.CancelAsync : Guid * obj -> unitPublic Sub CancelAsync (instanceId As Guid, userState As Object)Parameters
- instanceId
- Guid
The workflow instance to cancel.
- userState
- Object
The user-defined data.
