ReplicaMetadata.FindItemMetadataById Method

When overridden in a derived class, gets item metadata for the item that has the specified global ID.

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

Syntax

'Declaration
Public MustOverride Function FindItemMetadataById ( _
    globalId As SyncId _
) As ItemMetadata
'Usage
Dim instance As ReplicaMetadata
Dim globalId As SyncId
Dim returnValue As ItemMetadata

returnValue = instance.FindItemMetadataById(globalId)

public abstract ItemMetadata FindItemMetadataById (
    SyncId globalId
)

public:
virtual ItemMetadata^ FindItemMetadataById (
    SyncId^ globalId
) abstract

public abstract ItemMetadata FindItemMetadataById (
    SyncId globalId
)

public abstract function FindItemMetadataById (
    globalId : SyncId
) : ItemMetadata

Parameters

• globalId
  The global ID of the item.

Return Value

The item metadata for the item that has the specified ID. A null reference (Nothing in Visual Basic) when no item exists.

Exceptions

Exception type	Condition
ObjectDisposedException	The object has been disposed or was not initialized correctly.
ArgumentNullException	globalId is a null reference (Nothing in Visual Basic).
SyncIdFormatMismatchException	The format of globalId does not match the format that is specified by the ID format schema for the replica.
ItemMetadataNotFoundException	Item metadata was not found for the specified item.

Remarks

The metadata for an item represents information about an item in the item store, such as its current version, its creation version, and any custom fields available for the item.

See Also

Reference

ReplicaMetadata Class
ReplicaMetadata Members
Microsoft.Synchronization.MetadataStorage Namespace