Share via

SqlSyncMetadataStoreSerializer.GetSerializedReplicaId Method

  • Article

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

public void GetSerializedReplicaId (
    String serializedFilePath, 
    /** @attribute OutAttribute() */ /** @ref */ SyncId replicaId, 
    /** @attribute OutAttribute() */ /** @ref */ SyncIdFormatGroup idFormats
)

JScript does not support passing value-type arguments by reference.

Parameters

  • serializedFilePath
    The file that contains the serialized metadata for a particular replica.
  • replicaId
    The ID of the replica that is associated with this metadata.
  • idFormats
    The ID format schema of the provider.

Exceptions

Exception type 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
SqlSyncMetadataStoreSerializer Members
Microsoft.Synchronization.MetadataStorage Namespace