BeginCancel Method (TimeSpan, AsyncCallback, Object)
Collapse the table of content
Expand the table of content

WorkflowApplication::BeginCancel Method (TimeSpan, AsyncCallback^, Object^)

.NET Framework (current version)
 

Cancels a workflow instance asynchronously using the specified time-out interval, AsyncCallback, and user-provided state.

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

public:
IAsyncResult^ BeginCancel(
	TimeSpan timeout,
	AsyncCallback^ callback,
	Object^ state
)

Parameters

timeout
Type: System::TimeSpan

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

callback
Type: System::AsyncCallback^

The method to be called when the cancel 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 cancel operation.

To determine whether the cancel operation was successful, call EndCancel. EndCancel can be called from inside or outside of the method specified in the callback parameter. If EndCancel is called before the cancel operation completes, it blocks until the cancel operation completes. If the cancel operation does not complete in the interval specified by the timeOut parameter, a TimeoutException is thrown from EndCancel.

This method cancels a workflow 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