MetadataStore.RemoveReplicaMetadata Method
When overridden in a derived class, removes all metadata associated with the specified replica.
Namespace: Microsoft.Synchronization.MetadataStorage
Assembly: Microsoft.Synchronization.MetadataStorage (in Microsoft.Synchronization.MetadataStorage.dll)
Syntax
'Declaration
Public MustOverride Sub RemoveReplicaMetadata ( _
idFormats As SyncIdFormatGroup, _
replicaId As SyncId _
)
'Usage
Dim instance As MetadataStore
Dim idFormats As SyncIdFormatGroup
Dim replicaId As SyncId
instance.RemoveReplicaMetadata(idFormats, _
replicaId)
public abstract void RemoveReplicaMetadata(
SyncIdFormatGroup idFormats,
SyncId replicaId
)
public:
virtual void RemoveReplicaMetadata(
SyncIdFormatGroup^ idFormats,
SyncId^ replicaId
) abstract
abstract RemoveReplicaMetadata :
idFormats:SyncIdFormatGroup *
replicaId:SyncId -> unit
public abstract function RemoveReplicaMetadata(
idFormats : SyncIdFormatGroup,
replicaId : SyncId
)
Parameters
- idFormats
Type: Microsoft.Synchronization.SyncIdFormatGroup
The ID format schema of the provider.
- replicaId
Type: Microsoft.Synchronization.SyncId
All metadata associated with this replica ID is removed from the metadata store.
Exceptions
| Exception | Condition |
|---|---|
| ReplicaMetadataInUseException | An instance of ReplicaMetadata for replicaId is currently active. |
| ReplicaMetadataNotFoundException | Metadata for replicaId does not exist in the metadata store. |
| MetadataStoreInvalidOperationException | The metadata store has not been opened. For example, OpenStore must be called to open the metadata store before this method can be called on a SqlMetadataStore object. |