IProcessInstance Interface

  • Article

IProcessInstance Interface

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. Represents a document in a workflow folder.

CLSID

CD001023-8B95-11D1-82DB-00C04FB1625D

Extends

IDispatch

Type Library

Microsoft CDO Workflow Objects for Microsoft Exchange

DLL Implemented In

CDOWF.DLL

Member Summary

The following table lists the properties of the IProcessInstance interface.

Name Description
AuditTrail Contains a pointer to the current object bound to the process instance that implements the IAuditTrail interface. This property is read-only.
CurrentState Contains any string of characters that represents the state of the ProcessInstance item set by the workflow engine. This property is read-only.
DataSource Returns the IDataSource Interface on the object. This property is read-only.
Fields The property collection for the object. This property is read-only.
ProcessDefinition Returns a pointer to ProcessDefinition for ProcessInstance. This property is read-only.
ProcessDefinitionURL Contains an absolute URL to a row containing an existing ProcessDefinition. Allows a new ProcessInstance to specify which ProcessDefinition it should use for its workflow.
TrackingTable Contains records of all messages correlated with ProcessInstance in an e-mail-based workflow.

The following table lists the methods of the IProcessInstance interface.

Name Description
Advance Evaluates the action table for this process instance and executes appropriate actions. This method is called internally by the Collaboration Data Objects (CDO) workflow event sink, and does not need to be used by most applications.
DisableSuccessEntries Allows the user to configure entry types for AuditTrail.
EnableDebug Enables script Just-In-Time (JIT) debugging.
OnAbort Runs compensating action scripts and cleans up when a workflow transaction is aborted.

Remarks

A new item in a workflow folder becomes a ProcessInstance, except in the following instances:

  • The new item was mailed and can be correlated to an existing ProcessInstance in the folder.
  • The new item is a hidden item.

You do not have to do anything to create the ProcessInstance object. The event sink takes care of this whenever an item is saved or mailed to the folder. Normally, you will not use the ProcessInstance object directly unless you want to implement your own event sink.

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.