IKnowledgeSyncProvider::GetFullEnumerationChangeBatch method (winsync.h)
Gets a change batch that contains item metadata for items that have IDs greater than the specified lower bound, as part of a full enumeration.
Syntax
HRESULT GetFullEnumerationChangeBatch(
[in] DWORD dwBatchSize,
[in] const BYTE *pbLowerEnumerationBound,
[in] ISyncKnowledge *pSyncKnowledge,
[out] ISyncFullEnumerationChangeBatch **ppSyncChangeBatch,
[out] IUnknown **ppUnkDataRetriever
);
Parameters
[in] dwBatchSize
The number of changes to include in the change batch.
[in] pbLowerEnumerationBound
The lower bound for item IDs. This method returns changes that have IDs greater than or equal to this ID value.
[in] pSyncKnowledge
If an item change is contained in this knowledge object, data for that item already exists on the destination replica.
[out] ppSyncChangeBatch
Returns a change batch that contains item metadata for items that have IDs greater than the specified lower bound.
[out] ppUnkDataRetriever
Returns an object that can be used to retrieve change data. It can be an ISynchronousDataRetriever object or a provider-specific object.
Return value
The possible return codes include, but are not limited to, the values shown in the following table.
Return code | Description |
---|---|
|
The method succeeded. |
|
Remarks
This method enumerates, in sorted order by item ID, changes that have an item ID of pbLowerEnumerationBound or greater. This enables a synchronization session to determine which items on the destination provider have been deleted but forgotten by the source provider. Optionally, this method can also add changes to the batch, sorted by item ID, that have item ID less than pbLowerEnumerationBound and that are not contained in the destination knowledge.
For a provider that sends item data together with item change metadata, pSyncKnowledge can be used to determine whether it is necessary to send item data. Item data does not have to be sent when the item change is contained in pSyncKnowledge. Be aware that before it can be used to check items for containment, pSyncKnowledge must be mapped by using the ISyncKnowledge::MapRemoteToLocal method on the knowledge object that is contained in the current provider.
Requirements
Requirement | Value |
---|---|
Minimum supported client | Windows 7 [desktop apps only] |
Minimum supported server | Windows Server 2008 R2 [desktop apps only] |
Target Platform | Windows |
Header | winsync.h |
See also
IKnowledgeSyncProvider Interface
ISyncChangeBatchBase Interface