Export (0) Print
Expand All

WorkflowApplication.BeginCancel Method (TimeSpan, AsyncCallback, Object)

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)

member BeginCancel : 
        timeout:TimeSpan * 
        callback:AsyncCallback * 
        state:Object -> IAsyncResult

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

Supported in: 4.6, 4.5, 4

.NET Framework Client Profile

Supported in: 4

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Show:
© 2014 Microsoft