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

abstract GetReplicaMetadata : 
        idFormats:SyncIdFormatGroup * 
        replicaId:SyncId -> ReplicaMetadata 

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

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.

Exceptions

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

Microsoft.Synchronization.MetadataStorage Namespace