Platform SDK: Synchronization Manager

ISyncMgrSynchronizeCallback::PrepareForSyncCompleted

The registered application's handler must call the ISyncMgrSynchronizeCallback::PrepareForSyncCompleted method after the ISyncMgrSynchronize::PrepareForSync method has completed execution.

HRESULT PrepareForSyncCompleted(
  HRESULT hr          // HRESULT for the PrepareForSync method.
);

Parameters

hr
[in] Return value of the ISyncMgrSynchronize::PrepareForSync method. If S_OK is returned, SyncMgr calls ISyncMgrSynchronize::Synchronize for the item. If the HRESULT is set to anything other than S_OK, SyncMgr releases the handler without calling the ISyncMgrSynchronize::Synchronize method.

Return Values

S_OK
Call was completed successfully.

Remarks

A registered application's handler should return as soon as possible from the ISyncMgrSynchronize::PrepareForSync method and then call this method to notify the SyncMgr that the registered application is preparing for synchronization.

It is acceptable for the registered application's handler to call this method before returning from the ISyncMgrSynchronize::PrepareForSync method.

The registered application's handler should not call this method if the ISyncMgrSynchronize::PrepareForSync method returns any value other than S_OK.

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

ISyncMgrSynchronize::PrepareForSync, ISyncMgrSynchronize::Synchronize