SqlSyncMetadataStoreSerializer::GetSerializedReplicaId Method

Returns the replica ID for the replica whose metadata was serialized to the specified destination file.

Namespace:  Microsoft.Synchronization.MetadataStorage
Assembly:  Microsoft.Synchronization.MetadataStorage (in Microsoft.Synchronization.MetadataStorage.dll)

public:
virtual void GetSerializedReplicaId(
	String^ serializedFilePath, 
	[OutAttribute] SyncId^% replicaId, 
	[OutAttribute] SyncIdFormatGroup^% idFormats
) override

Parameters

serializedFilePath
Type: System::String
The file that contains the serialized metadata for a particular replica.
replicaId
Type: Microsoft.Synchronization::SyncId%
The ID of the replica that is associated with this metadata.
idFormats
Type: Microsoft.Synchronization::SyncIdFormatGroup%
The ID format schema of the provider.

ExceptionCondition
ArgumentNullException

A required parameter is a nullptr.

ArgumentException

serializedFilePath is an empty string.

SyncInvalidOperationException

The metadata store is not open.

The metadata store must be opened before this method is called. Open a store by calling OpenStore or CreateStore. Calling this method without first opening the store results in an exception.

Show: