ISyncMetadataStore2::GetSingleReplicaMetadata

  • Article

Gets the metadata for the single replica that is contained in the metadata store.

Syntax

HRESULT GetSingleReplicaMetadata(
  IReplicaMetadata ** ppReplicaMetadata);

Parameters

Term

Definition

ppReplicaMetadata

[out] Returns the metadata for the single replica that is contained in the metadata store.

Return Value

  • S_OK.

  • E_POINTER.

  • SYNC_E_METADATA_INVALID_OPERATION when the metadata store has not been opened. For example, ISqlSyncMetadataStore::OpenStore must be called to open the metadata store before this method can be called on an ISqlSyncMetadataStore object.

  • SYNC_E_METADATA_MORE_THAN_ONE_REPLICA_IN_STORE when the metadata store contains metadata for more than one replica. In this case, ISyncMetadataStore::GetReplicaMetadata must be used.

  • SYNC_E_METADATA_REPLICA_NOT_FOUND when metadata does not exist for any replica in the metadata store.

Remarks

This method is a convenient way to get replica metadata from a metadata store that contains metadata for a single replica. To get replica metadata from a metadata store that contains more than one replica, use ISyncMetadataStore::GetReplicaMetadata.

See Also

Reference

ISyncMetadataStore2 Interface