Share via


ISimpleSyncServices::RemoveItemFromReplica

Removes metadata for an item from a replica, but not the item itself. The item will be re-enumerated as a newly created item during a subsequent synchronization session.

Syntax

HRESULT RemoveItemFromReplica(
  const ITEM_FIELDS *pKeyInfo);

Parameters

  • pKeyInfo
    [in] An ITEM_FIELDS object that represents the item to remove.

Return Value

  • S_OK.

  • SYNC_E_PFX_INVALID_OPERATION when ISimpleSyncServices::BeginRemoveItemsFromReplica was not called before this method is called.

  • E_INVALIDARG when the simple provider requires that pKeyInfo contains values for the primary identity rules.

Remarks

BeginRemoveItemsFromReplica must be called to start a transaction before RemoveItemFromReplica is called. Items removed by calling RemoveItemFromReplica are not committed until ISimpleSyncServices::EndRemoveItemsFromReplica is called after all calls to RemoveItemFromReplica are finished.

See Also

Reference

ISimpleSyncServices Interface