RemoveItemMetadata メソッド
派生クラスでオーバーライドされると、メタデータ ストアから項目メタデータを削除します。
名前空間: Microsoft.Synchronization.MetadataStorage
アセンブリ: Microsoft.Synchronization.MetadataStorage (Microsoft.Synchronization.MetadataStorage.dll 内)
構文
'宣言
Public MustOverride Sub RemoveItemMetadata ( _
globalIds As IEnumerable(Of SyncId) _
)
'使用
Dim instance As ReplicaMetadata
Dim globalIds As IEnumerable(Of SyncId)
instance.RemoveItemMetadata(globalIds)
public abstract void RemoveItemMetadata(
IEnumerable<SyncId> globalIds
)
public:
virtual void RemoveItemMetadata(
IEnumerable<SyncId^>^ globalIds
) abstract
abstract RemoveItemMetadata :
globalIds:IEnumerable<SyncId> -> unit
public abstract function RemoveItemMetadata(
globalIds : IEnumerable<SyncId>
)
パラメーター
- globalIds
型 : System.Collections.Generic. . :: . .IEnumerable< (Of < ( <'SyncId> ) > ) >
削除する項目のグローバル ID のコレクションです。
例外
| 例外 | 条件 |
|---|---|
| ObjectDisposedException | オブジェクトが破棄されているか、正しく初期化されていません。 |
| ArgumentNullException | globalIds が null Nothing nullptr unit NULL 参照 (Visual Basic では Nothing) です。 |
| SyncIdFormatMismatchException | globalIds 内の ID の形式が、このレプリカ メタデータを初期化したときに指定された形式スキーマと一致しません。 |
| ItemMetadataNotFoundException | globalIds に含まれた項目がメタデータで見つかりませんでした。SqlMetadataStore を使用することによって可能になるこのクラスの実装では、例外の原因となった項目の前に列挙されたすべての項目がメタデータから削除されます。 |
説明
SqlMetadataStore を使用することによって可能になるこのクラスの実装では、この操作がストアに対して直ちに実行されます。未処理の明示的なトランザクションがある場合、操作はそのトランザクション内で行われます。トランザクションがコミットされていないか、ロールバックされている場合、操作はロールバックされます。
注意
これは、項目を廃棄標識としてマーク付けするための正しい方法ではありません。項目に廃棄標識マークを付けるには、ItemMetadata..::..IsDeleted を true に設定します。プロバイダーは、廃棄標識のクリーンアップ時など、項目に関するメタデータの追跡を停止して、項目をストアから完全に削除する必要がある場合に、このメソッドを使用します。