ItemMetadata.MarkAsDeleted Method

When overridden in a derived class, marks an item as deleted from the item store.

Namespace: Microsoft.Synchronization.MetadataStorage
Assembly: Microsoft.Synchronization.MetadataStorage (in microsoft.synchronization.metadatastorage.dll)

Syntax

'Declaration
Public MustOverride Sub MarkAsDeleted ( _
    changeVersion As SyncVersion _
)
'Usage
Dim instance As ItemMetadata
Dim changeVersion As SyncVersion

instance.MarkAsDeleted(changeVersion)

public abstract void MarkAsDeleted (
    SyncVersion changeVersion
)

public:
virtual void MarkAsDeleted (
    SyncVersion^ changeVersion
) abstract

public abstract void MarkAsDeleted (
    SyncVersion changeVersion
)

public abstract function MarkAsDeleted (
    changeVersion : SyncVersion
)

Parameters

• changeVersion
  The change version that is associated with the deletion of the item.

Exceptions

Exception type	Condition
ArgumentNullException	changeVersion is a null reference (Nothing in Visual Basic).

Remarks

An item that is marked as deleted is also known as a tombstone.

Marking an item as deleted indicates that the item has been deleted from the item store. The metadata for the item continues to exist in the metadata store until tombstones are cleaned up.

To protect user data, when an item is marked as deleted, all user data, such as custom index fields, should be removed from the metadata for that item. When an item is marked as deleted, the metadata storage service automatically removes all change unit information for the item.

See Also

Reference

ItemMetadata Class
ItemMetadata Members
Microsoft.Synchronization.MetadataStorage Namespace