ISyncMgrSyncCallback interface (syncmgr.h)

  • Article

Exposes methods that allow a synchronization process to report progress and events to Sync Center, or to query whether the process has been canceled.

Inheritance

The ISyncMgrSyncCallback interface inherits from the IUnknown interface. ISyncMgrSyncCallback also has these types of members:

Methods

The ISyncMgrSyncCallback interface has these methods.

 
ISyncMgrSyncCallback::AddItemToSession

Adds a specified item to the set of items currently being synchronized.
ISyncMgrSyncCallback::CanContinue

Determines whether the synchronization has been canceled.
ISyncMgrSyncCallback::CommitItem

Confirms a specified item as a member of the handler's sync set and confirms that it should be shown in the UI.
ISyncMgrSyncCallback::ProposeItem

Proposes the addition of a new item to the set of items previously enumerated.
ISyncMgrSyncCallback::QueryForAdditionalItems

Retrieves an enumerator of the set of items that have a pending request to be synchronized. This is the set of items that will be synchronized after the current synchronization is finished.
ISyncMgrSyncCallback::ReportEvent

Provides an event to add to the Sync Results folder for an item being synchronized.
ISyncMgrSyncCallback::ReportManualSync

Reports that a synchronization operation is being performed that was requested manually from outside the Sync Center UI.
ISyncMgrSyncCallback::ReportProgress

Reports the progress of the synchronization of a single sync item to Sync Center.
ISyncMgrSyncCallback::SetHandlerProgressText

Sets the content of an information field for the handler while that handler is performing a synchronization.

Remarks

This interface is passed to ISyncMgrSessionCreator::CreateSession, which in turn is referenced in the call to ISyncMgrHandler::Synchronize.

The handler is expected to call this interface to update the folder's progress UI for each item and to notify Sync Center when it has completed the synchronization of each item.

ISyncMgrSyncCallback is a replacement for ISyncMgrSynchronizeCallback.

Requirements

Requirement Value
Minimum supported client Windows Vista [desktop apps only]
Minimum supported server Windows Server 2008 [desktop apps only]
Target Platform Windows
Header syncmgr.h