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 大于或等于此 ID 值的变更。
  • knowledgeForDataRetrieval
    如果某项变更包含在此知识对象中，则该项的数据已经存在于目标副本中。
  • changeDataRetriever
    返回一个可用于检索变更数据的对象。可以是 IChangeDataRetriever 对象，也可以是提供程序特定的对象。

返回值

作为完全枚举一部分的变更批，该变更批包含 ID 大于指定下限的项的项元数据。

备注

此方法在遗忘知识恢复期间由 Sync Framework 调用。

此方法按照项 ID 的排序顺序枚举项 ID 等于或大于 lowerEnumerationBound 的变更。这使 Sync Framework 能够确定目标提供程序中的哪些项已被删除但又被源提供程序遗忘。此外，此方法还可以向批中添加变更，这些变更按项 ID 排序、所具有的项 ID 小于 lowerEnumerationBound 且未包含在目标知识中。

实施者注意事项： 如果在此批之后再无变更要发送，则必须将返回的变更批的 IsLastBatch 设置为 true。否则，Sync Framework 将再次调用 GetFullEnumerationChangeBatch 来检索另一个变更批。 对于将项数据与项变更元数据一起发送的提供程序，可以使用 knowledgeForDataRetrieval 来确定是否有必要发送项数据。当项变更包含在 knowledgeForDataRetrieval 中时，不必发送项数据。

请参阅

参考

KnowledgeSyncProvider 类
KnowledgeSyncProvider 成员
Microsoft.Synchronization 命名空间

概念

恢复过期副本