ISyncMgrSynchronize::SetProgressCallback

The ISyncMgrSynchronize::SetProgressCallback method sets the ISyncMgrSynchronizeCallback interface. Registered applications use this callback interface to give status information from within the ISyncMgrSynchronize::PrepareForSync and ISyncMgrSynchronize::Synchronize methods.

HRESULT SetProgressCallback(
  ISyncMgrSynchronizeCallback *pSyncCallBack  // Pointer to callback interface
);

Parameters

pSyncCallBack

[in] Pointer to ISyncMgrSynchronizeCallback interface the registered application uses to provide feedback to SyncMgr about the synchronization status and to notify SyncMgr when the synchronization is complete.

Return Values

This method supports the standard return values, E_INVALIDARG, E_UNEXPECTED, and E_OUTOFMEMORY, as well as the following:

S_OK

Synchronization callback interface was successfully set.

Remarks

Registered applications must call the AddRef method in the ISyncMgrSynchronizeCallback interface and use it when calling SyncMgr to provide status text and progress indicator feedback.

If the registered application already has an ISyncMgrSynchronizeCallback interface when the method is called, the old interface must be released and the AddRef method of the new interface must be called. The new interface must be maintained by the registered application.

Before the ISyncMgrSynchronize interface is released, SyncMgr calls this method with pSyncCallBack parameter set to NULL. The registered application should then release the pSyncCallback interface previously passed.

Requirements

  Windows NT/2000: Requires Windows 2000 (or Windows NT 4.0 with Internet Explorer 5 or later).
  Windows 95/98: Requires Windows 95 or later (with Internet Explorer 5 or later).
  Header: Declared in Mobsync.h.

See Also

ISyncMgrSynchronizeCallback