Unloads the workflow instance from memory to the persistence store. This call blocks until after the currently scheduled work is finished, or the end of a transaction scope.
Assembly: System.Workflow.Runtime (in System.Workflow.Runtime.dll)
There is no persistence service registered with the workflow runtime engine.
is synchronous; that is, it returns after completing any action that it performs. If the workflow instance is not idle, the runtime waits until the instance can be interrupted. An instance can only be interrupted after the currently scheduled work item completes; this is typically when the currently running Activity returns from its Execute method. However, if the instance is executing a TransactionScopeActivity, the transaction scope must complete execution before the instance can be interrupted. Unload then uses the persistence service to remove the workflow instance from memory and persists it to a data store. If there is no persistence service registered with the WorkflowRuntime, throws an InvalidOperationException. If the workflow instance is successfully persisted, the runtime raises the WorkflowUnloaded event.
The host can use to reclaim system resources from an idle workflow.
The following example demonstrates calling on a WorkflowInstance object.
// Create a WorkflowRuntime object WorkflowRuntime workflowRuntime = new WorkflowRuntime(); // Create a new instance of the out-of-box SqlWorkflowPersistenceService SqlWorkflowPersistenceService persistenceService = new SqlWorkflowPersistenceService( "Initial Catalog=SqlPersistenceService;Data Source=localhost;Integrated Security=SSPI;"); // Add the service to the runtime workflowRuntime.AddService(persistenceService); // Create a WorkflowInstance object WorkflowInstance workflowInstance = workflowRuntime.CreateWorkflow(typeof(Workflow1)); // Start the workflow instance workflowInstance.Start(); //Unload the instance workflowInstance.Unload();
- Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.
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)