ISyncMgrEventStore interface (syncmgr.h)

  • Article

Exposes methods that allow a handler to provide its own event store and manage its own sync events, instead of using the default Sync Center event store. These events are displayed in the Sync Results folder.

Inheritance

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

Methods

The ISyncMgrEventStore interface has these methods.

 
ISyncMgrEventStore::GetEvent

Gets a specified event object.
ISyncMgrEventStore::GetEventCount

Gets the event count.
ISyncMgrEventStore::GetEventEnumerator

Gets an enumerator for a handler's events.
ISyncMgrEventStore::RemoveEvent

Removes events, as specified.

Remarks

When to Implement

Sync Center provides a default event store that handlers can use to report events, which are then displayed in the Sync Results folder. If a component already logs events, it might be more convenient for it to provide its own event store that enumerates events for that handler. The event store in that case would simply translate the event as logged by the component into a form that can be used by Sync Center.

Sync Center requests an event store from a handler by first examining the mask returned by ISyncMgrHandler::GetCapabilities for the SYNCMGR_HCM_EVENT_STORE flag. If that value is present, Sync Center calls ISyncMgrHandler::GetObject with the SYNCMGR_OBJECTID_EventStore value. The handler can also provide an event store filtered by item by setting the SYNCMGR_ICM_EVENT_STORE flag in the mask returned from ISyncMgrSyncItem::GetCapabilities.

If events are added to the event store, the handler (or a related component) should call ISyncMgrControl::UpdateEvents so that the Sync Results folder and the error counts can be updated.

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