WorkflowControlClient.Terminate Method

Definition

Terminates the specified workflow instance.

Overloads

Terminate(Guid)

Terminates the specified workflow instance.

Terminate(Guid, String)

Terminates the specified workflow instance with the specified reason.

Terminate(Guid)

Terminates the specified workflow instance.

public void Terminate (Guid instanceId);

Parameters

instanceId
Guid

The workflow instance to terminate.

Examples

The following example shows how to terminate a workflow instance with the WorkflowControlClient.

IWorkflowCreation creationClient = new ChannelFactory<IWorkflowCreation>(new BasicHttpBinding(), "http://localhost/DataflowControl.xaml/Creation").CreateChannel();
Guid instanceId = creationClient.CreateSuspended(null);
WorkflowControlClient controlClient = new WorkflowControlClient(
    new BasicHttpBinding(),
    new EndpointAddress(new Uri("http://localhost/DataflowControl.xaml")));

controlClient.Unsuspend(instanceId);

// ...

controlClient.Terminate(instanceId);

Applies to

.NET Framework 4.8.1 and other versions
Product Versions
.NET Framework 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1

Terminate(Guid, String)

Terminates the specified workflow instance with the specified reason.

public void Terminate (Guid instanceId, string reason);

Parameters

instanceId
Guid

The workflow instance to terminate.

reason
String

The reason to terminate the workflow instance.

Examples

The following example shows how to terminate a workflow instance with the WorkflowControlClient.

IWorkflowCreation creationClient = new ChannelFactory<IWorkflowCreation>(new BasicHttpBinding(), "http://localhost/DataflowControl.xaml/Creation").CreateChannel();
Guid instanceId = creationClient.CreateSuspended(null);
WorkflowControlClient controlClient = new WorkflowControlClient(
    new BasicHttpBinding(),
    new EndpointAddress(new Uri("http://localhost/DataflowControl.xaml")));

controlClient.Unsuspend(instanceId);

// ...

controlClient.Terminate(instanceId, "Sample to terminate");

Applies to

.NET Framework 4.8.1 and other versions
Product Versions
.NET Framework 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1