WorkflowApplication.Persist Method

Definition

Namespace:

System.Activities

Assembly:

System.Activities.dll

Persists a workflow instance to an instance store.

Overloads

Persist()	Persists a workflow instance to an instance store.
Persist(TimeSpan)	Persists a workflow instance to an instance store using the specified time-out interval.

Remarks

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.

Persist()

Persists a workflow instance to an instance store.

public:
 void Persist();

public void Persist ();

member this.Persist : unit -> unit

Public Sub Persist ()

Examples

The following example calls Persist to persist a workflow instance before the workflow is started.

WorkflowApplication application = new WorkflowApplication(activity);

application.InstanceStore = instanceStore;

//returning IdleAction.Unload instructs the WorkflowApplication to persists application state and remove it from memory
application.PersistableIdle = (e) =>
{
    return PersistableIdleAction.Unload;
};

application.Unloaded = (e) =>
{
    instanceUnloaded.Set();
};

//This call is not required
//Calling persist here captures the application durably before it has been started
application.Persist();
id = application.Id;
application.Run();

instanceUnloaded.WaitOne();

Remarks

If the persist operation does not complete within 30 seconds, a TimeoutException is thrown.

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.

Persist(TimeSpan)

Persists a workflow instance to an instance store using the specified time-out interval.

public:
 void Persist(TimeSpan timeout);

public void Persist (TimeSpan timeout);

member this.Persist : TimeSpan -> unit

Public Sub Persist (timeout As TimeSpan)

Parameters

timeout

TimeSpan

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

Examples

The following example calls Persist to persist a workflow instance before the workflow is started.

WorkflowApplication application = new WorkflowApplication(activity);

application.InstanceStore = instanceStore;

//returning IdleAction.Unload instructs the WorkflowApplication to persists application state and remove it from memory
application.PersistableIdle = (e) =>
{
    return PersistableIdleAction.Unload;
};

application.Unloaded = (e) =>
{
    instanceUnloaded.Set();
};

//This call is not required
//Calling persist here captures the application durably before it has been started
application.Persist();
id = application.Id;
application.Run();

instanceUnloaded.WaitOne();

Remarks

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.