Edit

IKnowledgeSyncProvider::GetChangeBatch method (winsync.h)

  • Article

Gets a change batch that contains item metadata for items that are not contained in the specified knowledge from the destination provider.

Syntax

HRESULT GetChangeBatch(
  [in]  DWORD            dwBatchSize,
  [in]  ISyncKnowledge   *pSyncKnowledge,
  [out] ISyncChangeBatch **ppSyncChangeBatch,
  [out] IUnknown         **ppUnkDataRetriever
);

Parameters

[in] dwBatchSize

The requested number of changes to include in the change batch.

[in] pSyncKnowledge

The knowledge from the destination provider. This knowledge must be mapped by calling ISyncKnowledge::MapRemoteToLocal on the source knowledge before it can be used for change enumeration.

[out] ppSyncChangeBatch

Returns a change batch that contains item metadata for items that are not contained in pSyncKnowledge.

[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
S_OK
 The method succeeded.
Provider-determined error codes

Remarks

Be aware that dwBatchSize is a requested number only. A smaller or larger batch can be returned.

Note  If there are no more changes to send after this batch, ISyncChangeBatchBase::SetLastBatch must be called on the returned change batch before GetChangeBatch is called again.
 

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