KnowledgeSyncProvider.GetFullEnumerationChangeBatch メソッド
派生クラスでオーバーライドされると、ID が指定された下限を上回る項目の項目メタデータが含まれる変更バッチを、完全な列挙の一部として取得します。
名前空間: Microsoft.Synchronization
アセンブリ: Microsoft.Synchronization (microsoft.synchronization.dll 内)
構文
'宣言
Public MustOverride Function GetFullEnumerationChangeBatch ( _
batchSize As UInteger, _
lowerEnumerationBound As SyncId, _
knowledgeForDataRetrieval As SyncKnowledge, _
<OutAttribute> ByRef changeDataRetriever As Object _
) As FullEnumerationChangeBatch
'使用
Dim instance As KnowledgeSyncProvider
Dim batchSize As UInteger
Dim lowerEnumerationBound As SyncId
Dim knowledgeForDataRetrieval As SyncKnowledge
Dim changeDataRetriever As Object
Dim returnValue As FullEnumerationChangeBatch
returnValue = instance.GetFullEnumerationChangeBatch(batchSize, lowerEnumerationBound, knowledgeForDataRetrieval, changeDataRetriever)
public abstract FullEnumerationChangeBatch GetFullEnumerationChangeBatch (
uint batchSize,
SyncId lowerEnumerationBound,
SyncKnowledge knowledgeForDataRetrieval,
out Object changeDataRetriever
)
public:
virtual FullEnumerationChangeBatch^ GetFullEnumerationChangeBatch (
unsigned int batchSize,
SyncId^ lowerEnumerationBound,
SyncKnowledge^ knowledgeForDataRetrieval,
[OutAttribute] Object^% changeDataRetriever
) abstract
public abstract FullEnumerationChangeBatch GetFullEnumerationChangeBatch (
UInt32 batchSize,
SyncId lowerEnumerationBound,
SyncKnowledge knowledgeForDataRetrieval,
/** @attribute OutAttribute() */ /** @ref */ Object changeDataRetriever
)
JScript does not support passing value-type arguments by reference.
パラメーター
- batchSize
変更バッチに含める変更の数です。
- lowerEnumerationBound
項目 ID の下限です。このメソッドでは、ID がこの値以上の変更が返されます。
- knowledgeForDataRetrieval
項目変更がこのナレッジ オブジェクトに含まれている場合、その項目のデータは既に同期先レプリカに存在します。
- changeDataRetriever
変更データを取得するために使用できるオブジェクトを返します。これには、IChangeDataRetriever オブジェクトまたはプロバイダー固有のオブジェクトを指定できます。
戻り値
完全な列挙の一部として、ID が指定された下限を上回る項目の項目メタデータが含まれた変更バッチです。
解説
このメソッドは、忘れられたナレッジの復旧時に Sync Framework によって呼び出されます。
このメソッドは、項目 ID が lowerEnumerationBound 以上の変更を項目 ID の順で列挙します。これにより、Sync Framework は、同期先プロバイダーのどの項目が同期元プロバイダーによって削除され、忘れられているかを特定できます。このメソッドでは、オプションで、同期先ナレッジに含まれていない、項目 ID が lowerEnumerationBound より小さい変更を、項目 ID の順にバッチに追加することもできます。
実装に関するメモ : このバッチの後で送信する変更がもうない場合は、返される変更バッチで IsLastBatch を true に設定する必要があります。そうしないと、次の変更バッチを取得するために、Sync Framework によって GetFullEnumerationChangeBatch が再度呼び出されます。 項目変更に関するメタデータと共に項目データを送信するプロバイダーでは、knowledgeForDataRetrieval を使用して、項目データの送信が必要かどうかを判断できます。項目の変更が knowledgeForDataRetrieval に含まれている場合は、項目データを送信する必要はありません。
参照
リファレンス
KnowledgeSyncProvider クラス
KnowledgeSyncProvider メンバー
Microsoft.Synchronization 名前空間