Platform SDK: Synchronization Manager

ISyncMgrSynchronize::SetItemStatus

The Synchronization Manager calls the ISyncMgrSynchronize::SetItemStatus method in a registered application's handler to change the status of an item either between the time the handler has returned from the ISyncMgrSynchronize::PrepareForSync method and called the ISyncMgrSynchronizeCallback::PrepareForSyncCompleted callback method or after the handler has returned from the ISyncMgrSynchronize::Synchronize method but has not yet called the ISyncMgrSynchronizeCallback::SynchronizeCompleted callback method.

HRESULT SetItemStatus(
  REFSYNCMGRITEMID pItemID,    // Identifies the item with changed status
  DWORD dwSyncMgrStatus        // New status for item from SYNCMGRSTATUS
);

Parameters

pItemID
[in] Identifies the item with changed status.
dwSyncMgrStatus
[in] New status for the specified item taken from the SYNCMGRSTATUS enumeration.

Return Values

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

S_OK
Status was set.

Remarks

Currently, the only SYNCMGRSTATUS status value supported by the SyncMgr is SYNCMGRSTATUS_SKIPPED. The registered application's handler should skip the item specified in pItemID when it receives this status value.

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::SetProgressCallback, ISyncMgrSynchronize::Synchronize, ISyncMgrSynchronizeCallback::PrepareForSyncCompleted, ISyncMgrSynchronizeCallback::SynchronizeCompleted, SYNCMGRSTATUS