Share via


IKnowledgeSyncProvider::GetSyncBatchParameters

Gets the requested number of item changes that will be included in change batches, and the current knowledge for the synchronization scope.

HRESULT GetSyncBatchParameters(
  ISyncKnowledge ** ppSyncKnowledge,
  DWORD * pdwRequestedBatchSize);

Parameters

  • ppSyncKnowledge
    [out] Returns the current knowledge for the synchronization scope, or a newly created knowledge object if no current knowledge exists.
  • pdwRequestedBatchSize
    [out] Returns the requested number of item changes that will be included in change batches returned by the source provider.

Return Value

  • S_OK

  • Provider-determined error codes

Remarks

Typically, Sync Framework calls this method after it calls IKnowledgeSyncProvider::BeginSession and before it calls IKnowledgeSyncProvider::EndSession. However, the IEndpointState::LoadFromProvider method calls this method before it calls BeginSession.

Notes for Implementers

If no knowledge exists for the replica, use IProviderSyncServices::CreateSyncKnowledge to create a new knowledge object.

Before the knowledge object is returned in this method,ISyncKnowledge::SetLocalTickCount must be called on the knowledge object to set the tick count to the current tick count for the replica.

The number of item changes that are sent in pdwRequestedBatchSize is a requested number only. The source provider can ignore this value and return batches of any size.

See Also

Reference

IKnowledgeSyncProvider Interface