WorkflowRuntime.AddService Method (Object)


Adds the specified service to the workflow run-time engine.

Namespace:   System.Workflow.Runtime
Assembly:  System.Workflow.Runtime (in System.Workflow.Runtime.dll)

public void AddService(
	object service


Type: System.Object

An object that represents the service to add.

Exception Condition

service is a null reference (Nothing in Visual Basic).


The WorkflowRuntime is disposed.


service is already registered with the workflow run-time engine.


service is a core service and the workflow run-time engine is already running (IsStarted is true).

You can configure the workflow run-time engine by adding core services. Core services are those that derive from any of the following service base classes: the WorkflowSchedulerService class, the WorkflowCommitWorkBatchService class, the WorkflowPersistenceService class, and the TrackingService class. Core services can only be added when the workflow run-time engine is not running; that is, when IsStarted is false. The WorkflowRuntime can also be used as a storage container for other services that can be used by other workflows or by applications running on a host. If you add a non-core service that derives from the WorkflowRuntimeService class after the workflow run-time engine has been started, AddService calls the Start method implemented by that service.


AddService enforces the restriction that no two services of the same Type can be added to the WorkflowRuntime. However, you can add multiple services that derive from the same base class. There can be only one service derived from each of the following service base classes in the WorkflowRuntime: the WorkflowSchedulerService class, the WorkflowCommitWorkBatchService class, and the WorkflowPersistenceService class. If you add multiple services derived from one of these classes, for example two persistence services, StartRuntime throws an InvalidOperationException.

The following code example demonstrates how to use WorkflowRuntime functionality from a workflow host. It provides example of how to use the AddService method to add an ExternalDataExchangeService and SqlWorkflowPersistenceService to the workflow run-time engine.

This code example is part of the Cancelling a Workflow sample.

static void Main()
    string connectionString = "Initial Catalog=SqlPersistenceService;Data Source=localhost;Integrated Security=SSPI;";

    using (WorkflowRuntime workflowRuntime = new WorkflowRuntime())
        ExternalDataExchangeService dataService = new ExternalDataExchangeService();

        workflowRuntime.AddService(new SqlWorkflowPersistenceService(connectionString));

        workflowRuntime.WorkflowCompleted += OnWorkflowCompleted;
        workflowRuntime.WorkflowTerminated += OnWorkflowTerminated;
        workflowRuntime.WorkflowIdled += OnWorkflowIdled;
        workflowRuntime.WorkflowAborted += OnWorkflowAborted;

        Type type = typeof(SampleWorkflow1);
        WorkflowInstance workflowInstance = workflowRuntime.CreateWorkflow(type);



.NET Framework
Available since 3.0
Return to top