ISyncMgrSynchronize::SetItemStatus method (mobsync.h)

Called by the synchronization manager in a registered application's handler to change the status of an item in the following two cases: between the time the handler has returned from the ISyncMgrSynchronize::PrepareForSync method and called the PrepareForSyncCompleted callback method, or after the handler has returned from the ISyncMgrSynchronize::Synchronize method but has not yet called the SynchronizeCompleted callback method.

Syntax

HRESULT SetItemStatus(
  [in] REFGUID pItemID,
  [in] DWORD   dwSyncMgrStatus
);

Parameters

[in] pItemID

Type: REFGUID

Identifies the item with changed status.

[in] dwSyncMgrStatus

Type: DWORD

The new status for the specified item taken from the SYNCMGRSTATUS enumeration.

Return value

Type: HRESULT

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

Return code Description
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

Requirement Value
Minimum supported client Windows 2000 Professional [desktop apps only]
Minimum supported server Windows 2000 Server [desktop apps only]
Target Platform Windows
Header mobsync.h
DLL Mobsync.dll

See also

ISyncMgrSynchronize

ISyncMgrSynchronize::PrepareForSync

ISyncMgrSynchronize::SetProgressCallback

ISyncMgrSynchronize::Synchronize

PrepareForSyncCompleted

SYNCMGRSTATUS

SynchronizeCompleted