Expand Minimize

SYNCMGR_HANDLER_CAPABILITIES enumeration

Specifies the capabilities of a handler regarding the actions that can be performed against it.

Syntax


typedef enum SYNCMGR_HANDLER_CAPABILITIES { 
  SYNCMGR_HCM_NONE                          = 0x00000000,
  SYNCMGR_HCM_PROVIDES_ICON                 = 0x00000001,
  SYNCMGR_HCM_EVENT_STORE                   = 0x00000002,
  SYNCMGR_HCM_CONFLICT_STORE                = 0x00000004,
  SYNCMGR_HCM_SUPPORTS_CONCURRENT_SESSIONS  = 0x00000010,
  SYNCMGR_HCM_CAN_BROWSE_CONTENT            = 0x00010000,
  SYNCMGR_HCM_CAN_SHOW_SCHEDULE             = 0x00020000,
  SYNCMGR_HCM_QUERY_BEFORE_ACTIVATE         = 0x00100000,
  SYNCMGR_HCM_QUERY_BEFORE_DEACTIVATE       = 0x00200000,
  SYNCMGR_HCM_QUERY_BEFORE_ENABLE           = 0x00400000,
  SYNCMGR_HCM_QUERY_BEFORE_DISABLE          = 0x00800000,
  SYNCMGR_HCM_VALID_MASK                    = 0x00F3003F
} SYNCMGR_HANDLER_CAPABILITIES;

Constants

SYNCMGR_HCM_NONE

No capability flags are set.

SYNCMGR_HCM_PROVIDES_ICON

The handler returns a valid object from ISyncMgrHandler::GetObject when that method is called with the SYNCMGR_OBJECTID_Icon flag. The object returned from ISyncMgrHandler::GetObject must implement IExtractIcon. Generally, this value should not be returned if possible.

SYNCMGR_HCM_EVENT_STORE

The handler returns a valid object from ISyncMgrHandler::GetObject when that method is called with the SYNCMGR_OBJECTID_EventStore flag. The object returned from ISyncMgrHandler::GetObject must implement ISyncMgrEventStore.

SYNCMGR_HCM_CONFLICT_STORE

The handler returns a valid object from ISyncMgrHandler::GetObject when that method is called with the SYNCMGR_OBJECTID_ConflictStore flag. The object returned from ISyncMgrHandler::GetObject must implement ISyncMgrConflictStore.

SYNCMGR_HCM_SUPPORTS_CONCURRENT_SESSIONS

If a handler sets this flag in the mask returned from the handler's ISyncMgrHandler::GetCapabilities method, it indicates that the handler plans to create multiple simultaneous synchronization sessions using ISyncMgrSessionCreator::CreateSession. This is useful for handlers that implement a background synchronization architecture in which the handler simply signals another process to perform the synchronization rather than performing the synchronization in its ISyncMgrHandler::Synchronize method directly. This allows synchronization engines to report progress, conflicts, and events (through ISyncMgrSyncCallback) when synchronization requests come from sources other than Sync Center. For example, this could be the result of a data change notification or through application-specific UI. If more than one session is synchronizing the same item, then the progress for that item will be reported as indeterminate.

SYNCMGR_HCM_CAN_BROWSE_CONTENT

The handler returns a valid object from ISyncMgrHandler::GetObject when that method is called with the SYNCMGR_OBJECTID_BrowseContent flag. If this value is set, the Browse Content task is added to the handler's shortcut menu. The object returned from ISyncMgrHandler::GetObject must implement ISyncMgrUIOperation.

SYNCMGR_HCM_CAN_SHOW_SCHEDULE

The handler returns a valid object from ISyncMgrHandler::GetObject when that method is called with the SYNCMGR_OBJECTID_ShowSchedule flag. If this value is set, the Show Schedule task is added to the handler's shortcut menu. The object returned from ISyncMgrHandler::GetObject must implement ISyncMgrUIOperation. This value is used by ISyncMgrScheduleWizardUIOperation.

SYNCMGR_HCM_QUERY_BEFORE_ACTIVATE

The handler returns a valid object from ISyncMgrHandler::GetObject when that method is called with the SYNCMGR_OBJECTID_QueryBeforeActivate flag. The object returned from ISyncMgrHandler::GetObject must implement ISyncMgrUIOperation.

SYNCMGR_HCM_QUERY_BEFORE_DEACTIVATE

The handler returns a valid object from ISyncMgrHandler::GetObject when that method is called with the SYNCMGR_OBJECTID_QueryBeforeDeactivate flag. The object returned from ISyncMgrHandler::GetObject must implement ISyncMgrUIOperation.

SYNCMGR_HCM_QUERY_BEFORE_ENABLE

The handler returns a valid object from ISyncMgrHandler::GetObject when that method is called with the SYNCMGR_OBJECTID_QueryBeforeEnable flag. The object returned from ISyncMgrHandler::GetObject must implement ISyncMgrUIOperation.

SYNCMGR_HCM_QUERY_BEFORE_DISABLE

The handler returns a valid object from ISyncMgrHandler::GetObject when that method is called with the SYNCMGR_OBJECTID_QueryBeforeDisable flag. The object returned from ISyncMgrHandler::GetObject must implement ISyncMgrUIOperation.

SYNCMGR_HCM_VALID_MASK

A mask used to determine valid SYNCMGR_HANDLER_CAPABILITIES flags. Compare against the value retrieved by ISyncMgrHandler::GetCapabilities to verify valid results.

Remarks

Sync Center queries the handler for its capabilities through ISyncMgrHandler::GetCapabilities whenever the ISyncMgrControl::UpdateHandler or ISyncMgrControl::UpdateHandlerCollection method is called.

Requirements

Minimum supported client

Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2008 [desktop apps only]

Header

Syncmgr.h

IDL

Syncmgr.idl

 

 

Community Additions

ADD
Show:
© 2014 Microsoft