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.GetByteField や Microsoft.Synchronization.MetadataStorage.ItemMetadata.SetCustomField などのさまざまなメソッドを ItemMetadata に対して使用します。

customIndexedFieldSchemas を使用してインデックス スキーマを定義すると、一連のカスタム フィールドをインデックスとして使用して、メタデータ ストア内の項目を効率的に検索できるようになります。インデックス スキーマを一意に定義すると、インデックスによって単一の項目が定義されるようになります。インデックス スキーマに含まれている各フィールドは、レプリカ用に定義されたカスタム フィールド スキーマ内にも存在する必要があります。インデックス フィールドは、ReplicaMetadata.FindItemMetadataByIndexedField や ReplicaMetadata.FindItemMetadataByUniqueIndexedFields などのメソッドで使用できます。

参照

リファレンス

MetadataStore クラス
MetadataStore メンバー
Microsoft.Synchronization.MetadataStorage 名前空間