IExchangeExportChanges::Config

The Config method initializes the synchronization process (synchronizer) in preparation to export changes to the collection process (collector).

HRESULT Config(
  LPSTREAM lpStream,             
  ULONG ulFlags,                 
  LPUNKNOWN lpCollector,         
  LPSRestriction lpRestriction,  
  LPSPropTagArray lpIncludeProps,  
  LPSPropTagArray lpExcludeProps,  
  ULONG ulBufferSize             
);
 

Parameters

lpStream

Input parameter. Points to a Win32 IStream interface, which contains the current synchronization state. The state information is binary and specific to this synchronization/collection session.

ulFlags

Input parameter. Defined flags that control the synchronizer:

SYNC_UNICODE

Specifies that text is Unicode. If this flag is not set, the text is returned as the type of text in the client's code page.

SYNC_NO_DELETIONS

Specifies that the synchronizer does not export deletions.

SYNC_READ_STATE

Specifies that the synchronizer exports the MAPI PR_CONTENT_UNREAD property for folders and the MAPI PR_MESSAGE_FLAGS property for messages. This flag only makes sense for information stores that maintain a per-user read state.

SYNC_ASSOCIATED

Specifes that the synchronizer only exports folder associated information (FAI) messages. Typically, FAI messages represent forms and views.

SYNC_NORMAL

Specifies that the synchronizer only exports non-FAI messages.

lpCollector

Input parameter. Points to a Win32 IUnknown interface object that support either the IExchangeImportHierarchyChanges interface or the IExchangeImportContentsChanges interface. This parameter cannot be NULL.

lpRestriction

Input parameter. Set this parameter to NULL.

lpIncludeProps

Input parameter. Points to a SPropTagArray structure, which can contain the MAPI PR_MESSAGE_SIZE or MAPI PR_ENTRYID properties (it can contain both of these properties). These properties are exported in addition to the properties that are normally exported.

lpExcludeProps

Input parameter. Points to a SPropTagArray structure, which contains an array of property tags. These properties are excluded from the properties that are normally exported.

ulBufferSize

Input parameter. Specifies the size, in bytes, of the bufffer that the synchronizer uses to receive information from the collector. If this parameter is zero, Config uses the default buffer size. Microsoft recommends using the default buffer size.

Return Values

See Return Values. In addition, Config can return one of the following values:

SUCCESS_SUCCESS

The method completed successfully.

SYNC_E_ERROR

An unknown error occurred.

SYNC_E_INVALID_PARAMETER

One of the parameters was not valid.

SYNC_E_UNKNOWN_FLAGS

One of the flags was not valid.

Remarks

The Config method is called once by the agent to initialize the synchronizer.

If neither the SYNC_ASSOCIATED nor the SYNC_NORMAL flag is set, no folder contents are synchronized.

See Also

IExchangeExportChanges