IItemMetadata Interface

Represents the metadata that is associated with an item in the synchronization scope.

Syntax

interface IItemMetadata : IUnknown

Members

IItemMetadata methods	Description
IItemMetadata::GetGlobalId	Gets the global ID of the item.
IItemMetadata::SetGlobalId	Sets the global ID of the item.
IItemMetadata::GetChangeVersion	Gets the version of the most recent change made to the item.
IItemMetadata::SetChangeVersion	Sets the version of the most recent change made to the item.
IItemMetadata::GetCreationVersion	Gets the creation version of the item.
IItemMetadata::SetCreationVersion	Sets the creation version of the item.
IItemMetadata::GetChangeUnitVersion	Gets the version of a change unit that is contained in the item.
IItemMetadata::SetChangeUnitVersion	Sets the version of a change unit that is contained in the item.
IItemMetadata::GetChangeUnitEnumerator	Gets an object that can be used to enumerate the change units that are contained in this item.
IItemMetadata::GetIsDeleted	Gets a value that indicates whether the item was deleted from the item store.
IItemMetadata::MarkAsDeleted	Marks an item as deleted from the item store.
IItemMetadata::ResurrectDeletedItem	Restores an item that was previously marked as deleted in the metadata store.
IItemMetadata::TryGetFieldByteArray	Gets the value of a byte array field.
IItemMetadata::TryGetFieldGuid	Gets the value of a GUID field.
IItemMetadata::TryGetFieldString	Gets the value of a string field.
IItemMetadata::TryGetFieldUInt8	Gets the value of an 8-bit unsigned integer field.
IItemMetadata::TryGetFieldUInt16	Gets the value of a 16-bit unsigned integer field.
IItemMetadata::TryGetFieldUInt32	Gets the value of a 32-bit unsigned integer field.
IItemMetadata::TryGetFieldUInt64	Gets the value of a 64-bit unsigned integer field.
IItemMetadata::SetFieldByteArray	Sets the value of a byte array field.
IItemMetadata::SetFieldGuid	Sets the value of a GUID field.
IItemMetadata::SetFieldString	Sets the value of a string field.
IItemMetadata::SetFieldUInt8	Sets the value of an 8-bit unsigned integer field.
IItemMetadata::SetFieldUInt16	Sets the value of a 16-bit unsigned integer field.
IItemMetadata::SetFieldUInt32	Sets the value of a 32-bit unsigned integer field.
IItemMetadata::SetFieldUInt64	Sets the value of a 64-bit unsigned integer field.

Remarks

The metadata for an item contains its creation version, current version, global ID, and a value that indicates whether the item has been deleted from the item store. The metadata can also contain custom fields as defined by the CUSTOM_FIELD_DEFINITION structure that is used to initialize the replica metadata.

The metadata storage service implements IItemMetadata. To obtain an instance of this implementation of IItemMetadata, first create an ISqlCESyncMetadataStore object. Then, create or get an IReplicaMetadata object by using the appropriate ISqlCESyncMetadataStore method, and then call IReplicaMetadata::CreateNewItemMetadata to create a new metadata entry, or a method such as IReplicaMetadata::FindItemMetadataByGlobalId to find metadata for an item that already exists in the metadata store.

The metadata storage service implementation of this class does not save property changes to the disk until the object is passed to IReplicaMetadata::SaveItemMetadata.

Requirements

Header: Metastore.h

See Also

Concepts

Sync Framework Metadata Storage Service Components

Accessing Replica Metadata