MetadataStore.InitializeReplicaMetadata 方法

  • 项目

在派生类中重写时，创建、初始化并保存副本的新元数据。

命名空间: Microsoft.Synchronization.MetadataStorage
程序集: Microsoft.Synchronization.MetadataStorage（在 microsoft.synchronization.metadatastorage.dll 中）

语法

声明
Public MustOverride Function InitializeReplicaMetadata ( _
    idFormats As SyncIdFormatGroup, _
    replicaId As SyncId, _
    customItemFieldSchemas As IEnumerable(Of FieldSchema), _
    customIndexedFieldSchemas As IEnumerable(Of IndexSchema) _
) As ReplicaMetadata
用法
Dim instance As MetadataStore
Dim idFormats As SyncIdFormatGroup
Dim replicaId As SyncId
Dim customItemFieldSchemas As IEnumerable(Of FieldSchema)
Dim customIndexedFieldSchemas As IEnumerable(Of IndexSchema)
Dim returnValue As ReplicaMetadata

returnValue = instance.InitializeReplicaMetadata(idFormats, replicaId, customItemFieldSchemas, customIndexedFieldSchemas)

public abstract ReplicaMetadata InitializeReplicaMetadata (
    SyncIdFormatGroup idFormats,
    SyncId replicaId,
    IEnumerable<FieldSchema> customItemFieldSchemas,
    IEnumerable<IndexSchema> customIndexedFieldSchemas
)

public:
virtual ReplicaMetadata^ InitializeReplicaMetadata (
    SyncIdFormatGroup^ idFormats, 
    SyncId^ replicaId, 
    IEnumerable<FieldSchema^>^ customItemFieldSchemas, 
    IEnumerable<IndexSchema^>^ customIndexedFieldSchemas
) abstract

public abstract ReplicaMetadata InitializeReplicaMetadata (
    SyncIdFormatGroup idFormats, 
    SyncId replicaId, 
    IEnumerable<FieldSchema> customItemFieldSchemas, 
    IEnumerable<IndexSchema> customIndexedFieldSchemas
)

public abstract function InitializeReplicaMetadata (
    idFormats : SyncIdFormatGroup, 
    replicaId : SyncId, 
    customItemFieldSchemas : IEnumerable<FieldSchema>, 
    customIndexedFieldSchemas : IEnumerable<IndexSchema>
) : ReplicaMetadata

参数

  • idFormats
    提供程序的 ID 格式架构。
  • replicaId
    由正在创建和初始化的元数据表示的副本的副本 ID。
  • customItemFieldSchemas
    介绍与元数据项相关联的自定义元数据字段的架构信息。如果不存在自定义元数据字段，则可以是 null 引用（在 Visual Basic 中为 Nothing）。
  • customIndexedFieldSchemas
    可用于更有效地查找元数据存储区中的项的索引架构列表。如果不存在索引架构，则可以是 null 引用（在 Visual Basic 中为 Nothing）。

返回值

表示新创建的副本元数据的 ReplicaMetadata 对象。

异常

异常类型 条件

SyncIdFormatMismatchException

idFormats 指定的 ID 格式架构与用于初始化副本元数据的架构不匹配。

备注

此方法必须对元数据存储区执行所有必要的任务，以创建和初始化副本元数据，以便返回的 ReplicaMetadata 对象可立即用于访问和修改元数据。

可以使用 customItemFieldSchemas 为项元数据定义一组自定义字段。每个字段均由一个唯一字符串名称和一个值组成。这些字段可用于存储项的默认元数据集不支持的任何其他元数据。可通过 ItemMetadata 中的多个方法来访问这些字段，如 ItemMetadata.GetByteField 或 Microsoft.Synchronization.MetadataStorage.ItemMetadata.SetCustomField。

可以使用 customIndexedFieldSchemas 定义一组索引架构，这样就可以将自定义字段集用作索引，从而有效地在元数据存储区中查找项。索引架构可定义为唯一，以确保该索引定义单个项。包含在索引架构中的每个字段也还必须存在于为副本定义的自定义字段架构中。可以在 ReplicaMetadata.FindItemMetadataByIndexedField 和 ReplicaMetadata.FindItemMetadataByUniqueIndexedFields 等方法中使用索引字段。

请参阅

参考

MetadataStore 类
MetadataStore 成员
Microsoft.Synchronization.MetadataStorage 命名空间