MetadataStore.GetReplicaMetadata Method

When overridden in a derived class, gets the ReplicaMetadata object that represents the metadata for a particular replica.

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

Syntax

'Declaration
Public MustOverride Function GetReplicaMetadata ( _
    idFormats As SyncIdFormatGroup, _
    replicaId As SyncId _
) As ReplicaMetadata
'Usage
Dim instance As MetadataStore
Dim idFormats As SyncIdFormatGroup
Dim replicaId As SyncId
Dim returnValue As ReplicaMetadata

returnValue = instance.GetReplicaMetadata(idFormats, replicaId)

public abstract ReplicaMetadata GetReplicaMetadata (
    SyncIdFormatGroup idFormats,
    SyncId replicaId
)

public:
virtual ReplicaMetadata^ GetReplicaMetadata (
    SyncIdFormatGroup^ idFormats, 
    SyncId^ replicaId
) abstract

public abstract ReplicaMetadata GetReplicaMetadata (
    SyncIdFormatGroup idFormats, 
    SyncId replicaId
)

public abstract function GetReplicaMetadata (
    idFormats : SyncIdFormatGroup, 
    replicaId : SyncId
) : ReplicaMetadata

Parameters

• idFormats
  The ID format schema for the provider.

• replicaId
  The replica ID for which replica metadata will be retrieved.

Return Value

The ReplicaMetadata object that represents the metadata for a particular replica.

Exceptions

Exception type	Condition
ReplicaMetadataNotFoundException	Metadata for the replica that is specified by replicaId does not exist in the metadata store.
SyncIdFormatMismatchException	The ID format schema that is specified by idFormats does not match the schema that is used to initialize the replica metadata.

Remarks

This method is used to access replica metadata that already exists in the metadata store. To create new metadata for a replica, use InitializeReplicaMetadata.

See Also

Reference

MetadataStore Class
MetadataStore Members
Microsoft.Synchronization.MetadataStorage Namespace