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.

Syntax


HRESULT SetProgressCallback(
  [in] ISyncMgrSynchronizeCallback *pSyncCallBack
);

Parameters

pSyncCallBack [in]

Type: ISyncMgrSynchronizeCallback*

A 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 value

Type: HRESULT

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

Return codeDescription
S_OK

Synchronization callback interface was successfully set.

 

Remarks

Registered applications must call the ISyncMgrSynchronizeCallback::AddRef method 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 the pSyncCallBack parameter set to NULL. The registered application should then release the ISyncMgrSynchronize interface previously passed.

Requirements

Minimum supported client

Windows 2000 Professional [desktop apps only]

Minimum supported server

Windows 2000 Server [desktop apps only]

Header

Mobsync.h

DLL

Mobsync.dll

See also

ISyncMgrSynchronize
ISyncMgrSynchronizeCallback

 

 

Show: