ISyncMgrControl::StartHandlerSync method (syncmgr.h)

Initiates the synchronization of all items managed by a particular handler.

Syntax

HRESULT StartHandlerSync(
  [in] LPCWSTR                    pszHandlerID,
  [in] HWND                       hwndOwner,
  [in] IUnknown                   *punk,
  [in] SYNCMGR_SYNC_CONTROL_FLAGS nSyncControlFlags,
  [in] ISyncMgrSyncResult         *pResult
);

Parameters

[in] pszHandlerID

Type: LPCWSTR

A pointer to a buffer containing the unique ID of the handler to synchronize. This string is of maximum length MAX_SYNCMGR_ID including the terminating null character.

[in] hwndOwner

Type: HWND

A handle to the window that the handler can use to display any necessary UI. This value can be NULL.

[in] punk

Type: IUnknown*

A pointer to an IUnknown to be passed to Synchronize. This parameter can be NULL.

[in] nSyncControlFlags

Type: SYNCMGR_SYNC_CONTROL_FLAGS

A member of the SYNCMGR_SYNC_CONTROL_FLAGS enumeration that specifies whether an item found in both a current sync and a queued sync should be synchronized again when the queued sync is performed.

[in] pResult

Type: ISyncMgrSyncResult*

A pointer to an instance of ISyncMgrSyncResult, whose Result method is called when the synchronization ends, either through success, failure, or cancellation. The Result method is called with the aggregated state of the handler synchronization. This parameter can be NULL.

Return value

Type: HRESULT

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Requirements