Delete Process Instance

API Type

Web Services

Description

Deletes a process instance. This method removes the specified process instance and all the associated data from the database, such as work items, email, and activity instances associated with this process instance. It may take some time to complete this transaction.

Syntax

public void DeleteProcInst(string processInstanceID)

Parameters

Name	Description
processInstanceID	Definition: Specifies the unique ID of a process instance. Type string Allowed Values: A valid process instance ID

Output

None.

Example

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

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

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

Supported Versions

4.0.1 and higher