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)

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

Parameters

idFormats
Type: Microsoft.Synchronization::SyncIdFormatGroup
The ID format schema for the provider.
replicaId
Type: Microsoft.Synchronization::SyncId
The replica ID for which replica metadata will be retrieved.

Return Value

Type: Microsoft.Synchronization.MetadataStorage::ReplicaMetadata
The ReplicaMetadata object that represents the metadata for a particular replica.

ExceptionCondition
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.

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

Show: