Cancel Process Instance

Description

Cancels the process instance based on a specified process instance identifier. This method cancels all automatic work items, manual work items, and child process instances.

Syntax

public virtual WFEvent CancelProcInst(string piID)

Parameters

Name	Type	Description
processInstanceID	string	A string that contains the ID of the process instance.

Output

WFEvent object that provides the status of the transaction. Possible statuses are Success, Failed, and Sent.

Example

IWFWorkflowService svc = GetWorkflowService();
string processInstanceID = ..// the ID of the process instance to be
canceled.

try
	{
    WFEvent evt = svc.CancelProcInst(processInstanceID);
	}

catch( Exception ex)
	{
    base.ShowMessage( base.GetSoapMessage(ex));
	}

Supported Versions

3.2.0.4 and higher

Parent topic: Methods for Process Instances