Suspend Process Instance

Description

Suspends a process instance. The process instance status is changed to Suspended, and the statuses of all the work items (tasks) become Pending.

Syntax

public virtual WFEvent SuspendProcInst(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

// This is console application sample
IWFWorkflowService svc = GetWorkflowService();

try
	{
    string processInstanceID = …// process instance to be suspended.
    WFEvent event = svc.SuspendProcInst(processInstanceID);
	}

catch (Exception ex)
	{
    Console.WriteLine("Failed: " + ShUtil.GetSoapMessage(ex));
	}

Supported Versions

3.2.0.4 and higher

Parent topic: Methods for Process Instances