This documentation is archived and is not being maintained.

WorkflowApplication.BeginUnload Method (TimeSpan, AsyncCallback, Object)

Persists and disposes a workflow instance asynchronously using the specified time-out interval, callback method, and user-provided state.

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

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


Type: System.TimeSpan
The interval in which the BeginTerminate() operation must complete before the operation is canceled and a TimeoutException is thrown.
Type: System.AsyncCallback
The method to be called when the BeginUnload() operation has completed.
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 BeginUnload() operation.

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

If the workflow instance was previously loaded from persistence, then the same InstanceStore used to load the workflow is used for persistence. If the workflow was created and has not yet been persisted, then an InstanceStore must be configured before calling this method or else an InvalidOperationException is thrown when this method is called.

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

.NET Framework

Supported in: 4

.NET Framework Client Profile

Supported in: 4

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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