Cancel Work Item (Extended Method)

Description

Cancels a manual work item based on a specified manual work item identifier. This method also contains an added routine to track the method call duration. Only the following manual work item status can transition to a Canceled status: Assigned, New, Pseudo, and Overdue.

Syntax

public virtual WFEvent CancelWorkItemEx(string wID, string clientData)

Parameters

Name	Type	Description
wID	string	A 32-byte unique work item (task) ID that represents a manual work item.
clientData	string	A string that contains the client data. If clientData is null, the system will keep existing client data, otherwise the relevant data would be overwritten.

Output

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

Example

IWFWorkflowService svc = GetWorkflowService();
string workItemID = …// work item ID
string clientData = null;

try
	{
    WFEvent evt = svc. CancelWorkItemEx(workItemID, clientData);
	}

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

Supported Versions

3.2.0.4 and higher

Parent topic: Methods for Manual Work Items (Tasks)