WorkflowApplication.BeginPersist Method

Definition

Persists a workflow instance to an instance store asynchronously using the IAsyncResult asynchronous design pattern.

Overloads

BeginPersist(AsyncCallback, Object)

Persists a workflow instance to an instance store asynchronously using the specified callback method and user-provided state.

BeginPersist(TimeSpan, AsyncCallback, Object)

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

Remarks

For more information, see Asynchronous Programming Overview.

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.

BeginPersist(AsyncCallback, Object)

Persists a workflow instance to an instance store asynchronously using the specified callback method and user-provided state.

public:
 IAsyncResult ^ BeginPersist(AsyncCallback ^ callback, System::Object ^ state);
public IAsyncResult BeginPersist (AsyncCallback callback, object state);
member this.BeginPersist : AsyncCallback * obj -> IAsyncResult
Public Function BeginPersist (callback As AsyncCallback, state As Object) As IAsyncResult

Parameters

callback
AsyncCallback

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

state
Object

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

Returns

A reference to the asynchronous persist operation.

Remarks

To determine whether the persist operation was successful, call EndPersist. EndPersist can be called from inside or outside of the method referenced in the callback parameter. If EndPersist is called before the persist operation completes, it blocks until the persist operation completes. If the persist operation does not complete within 30 seconds, a TimeoutException is thrown from EndPersist.

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 a workflow asynchronously using the IAsyncResult asynchronous design pattern. For more information, see Asynchronous Programming Overview.

Applies to

BeginPersist(TimeSpan, AsyncCallback, Object)

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

public:
 IAsyncResult ^ BeginPersist(TimeSpan timeout, AsyncCallback ^ callback, System::Object ^ state);
public IAsyncResult BeginPersist (TimeSpan timeout, AsyncCallback callback, object state);
member this.BeginPersist : TimeSpan * AsyncCallback * obj -> IAsyncResult
Public Function BeginPersist (timeout As TimeSpan, callback As AsyncCallback, state As Object) As IAsyncResult

Parameters

timeout
TimeSpan

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

callback
AsyncCallback

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

state
Object

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

Returns

A reference to the asynchronous persist operation.

Remarks

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

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 a workflow instance asynchronously using the IAsyncResult asynchronous design pattern. For more information, see Asynchronous Programming Overview.

Applies to