BeginTerminate Method (String, TimeSpan, AsyncCallback, Object)

WorkflowApplication.BeginTerminate Method (String, TimeSpan, AsyncCallback, Object)

.NET Framework (current version)
 

Terminates a workflow instance asynchronously using the specified error message, time-out interval, callback method, and user-provided state.

Namespace:   System.Activities
Assembly:  System.Activities (in System.Activities.dll)

Public Function BeginTerminate (
	reason As String,
	timeout As TimeSpan,
	callback As AsyncCallback,
	state As Object
) As IAsyncResult

Parameters

reason
Type: System.String

The reason for terminating the workflow instance.

timeout
Type: System.TimeSpan

The interval in which the BeginTerminate operation must complete before the operation is canceled and a TimeoutException is thrown.

callback
Type: System.AsyncCallback

The method to be called when the BeginTerminate operation has completed.

state
Type: System.Object

An optional application-specific object that contains information about the asynchronous operation.

Return Value

Type: System.IAsyncResult

A reference to the asynchronous BeginTerminate operation.

This method schedules the termination of the workflow instance. To be notified when the termination has completed, use the P:System.Activities.WorkflowApplication.OnCompleted handle.

To determine whether the BeginTerminate operation was successful, call EndTerminate. EndTerminate can be called from inside or outside of the method reference in the callback parameter. If EndTerminate is called before the BeginTerminate operation completes, it blocks until the BeginTerminate operation completes. If the BeginTerminate operation does not complete within the specified time-out interval a TimeoutException is thrown from EndTerminate.

This method terminates a workflow instance asynchronously using the IAsyncResult asynchronous design pattern. For more information, seeAsynchronous Programming Overview.

.NET Framework
Available since 4.0
Return to top
Show:
© 2016 Microsoft