Share via

DeleteWorkflowItem Method

  • Article

DeleteWorkflowItem Method

This content is no longer actively maintained. It is provided as is, for anyone who may still be using these technologies, with no warranties or claims of accuracy with regard to the most recent product version or service release.

Deletes the ProcessInstance item.

Applies To

IWorkflowSession Interface

Type Library

Microsoft CDO Workflow Objects for Microsoft Exchange

DLL Implemented In

CDOWF.DLL

Syntax



[Visual Basic]Sub DeleteWorkflowItem
()






[C++]HRESULT DeleteWorkflowItem
();



Return Value




Returns S_OK if successful, or an error value otherwise.




Remarks




You can call this method from your script for the following event types:


    

  • OnChange
    • 

  • OnCreate
    • 

  • OnDelete
    • 

  • OnExpiry
    • 



This method deletes the ProcessInstance row from the Exchange store, but the workflow event sink will not invoke the workflow engine with an OnDelete event. If you want to take special action when deleting a ProcessInstance, do it before or after calling DeleteWorkflowItem.




Example






'Action Script Procedure:
WorkflowSession.DeleteWorkflowItem



See Also




ProcessInstance CoClass


IProcessInstance Interface




Send us your feedback about the Microsoft Exchange Server 2003 SDK.


Build: June 2007 (2007.618.1)


© 2003-2006 Microsoft Corporation. All rights reserved. Terms of use.