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)

Syntax

'Declaration
Public Overrides Sub GetSerializedReplicaId ( _
    serializedFilePath As String, _
    <OutAttribute> ByRef replicaId As SyncId, _
    <OutAttribute> ByRef idFormats As SyncIdFormatGroup _
)
'Usage
Dim instance As SqlSyncMetadataStoreSerializer
Dim serializedFilePath As String
Dim replicaId As SyncId
Dim idFormats As SyncIdFormatGroup

instance.GetSerializedReplicaId(serializedFilePath, _
    replicaId, idFormats)

public override void GetSerializedReplicaId(
    string serializedFilePath,
    out SyncId replicaId,
    out SyncIdFormatGroup idFormats
)

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

abstract GetSerializedReplicaId : 
        serializedFilePath:string * 
        replicaId:SyncId byref * 
        idFormats:SyncIdFormatGroup byref -> unit 
override GetSerializedReplicaId : 
        serializedFilePath:string * 
        replicaId:SyncId byref * 
        idFormats:SyncIdFormatGroup byref -> unit 

public override function GetSerializedReplicaId(
    serializedFilePath : String, 
    replicaId : SyncId, 
    idFormats : SyncIdFormatGroup
)

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.

Exceptions

Exception	Condition
ArgumentNullException	A required parameter is a null reference (Nothing in Visual Basic).
ArgumentException	serializedFilePath is an empty string.
SyncInvalidOperationException	The metadata store is not open.

Remarks

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.

See Also

Reference

SqlSyncMetadataStoreSerializer Class

Microsoft.Synchronization.MetadataStorage Namespace