Platform SDK: Exchange Server

IExchangeImportContentsChanges::ImportMessageChange

The ImportMessageChange method accepts a message change notification from the synchronizer.

HRESULT ImportMessageChange(
  ULONG cValue,            
  LPSPropValue lpPropArray,  
  ULONG ulFlags,           
  LPMESSAGE * lppMessage   
);
 

Parameters

cValue
Input parameter. The number of MAPI SPropValue array elements in lpPropArray.
lpPropArray
Input parameter. Points to an array of SPropValue structures, each of which contains a property tag and its value.

The array must contain at least the PR_SOURCE_KEY, PR_CHANGE_KEY, and PR_PREDECESSOR_CHANGE_LIST properties.

ulFlags
Input parameter. Defined flags that control the collector:
SYNC_ASSOCIATED
Specifes that the synchronizer only exports folder associated information (FAI) messages. Typically, FAI messages represent forms and views.
lppMessage
Output parameter. Points to a MAPI IMessage interface that can receive an open message object. The synchronizer can set additional properties on this object by using the MAPI IMAPIProp::SetProps method or through an OLE stream.

Return Values

See Return Values.

In addition, ImportMessageChange can return one of the following values:

SUCCESS_SUCCESS
The method completed successfully.
SYNC_E_CONFLICT
A conflict has occurred.
SYNC_E_ERROR
An unknown error occurred.
SYNC_OBJECT_DELETED
The object has been deleted.

Remarks

The ImportMessageChange method is called by the synchronizer for each message that is created or modified. This method should not be called from the agent.

Collector implementers need only provide the MAPI IMAPIProp::SetProps method, the MAPI IMAPIProp::SaveChanges method, and the Win32 IUnknown interface.

See Also

IExchangeImportContentsChanges