Share via

UnmanagedSyncProviderWrapper.GetFullEnumerationChangeBatch Method

  • Article

Gets a batch of changes from the unmanaged provider as part of a full enumeration.

Namespace: Microsoft.Synchronization
Assembly: Microsoft.Synchronization (in microsoft.synchronization.dll)

Syntax

'Declaration
Public Overrides Function GetFullEnumerationChangeBatch ( _
    batchSize As UInteger, _
    lowerEnumerationBound As SyncId, _
    knowledgeForDataRetrieval As SyncKnowledge, _
    <OutAttribute> ByRef changeDataRetriever As Object _
) As FullEnumerationChangeBatch
'Usage
Dim instance As UnmanagedSyncProviderWrapper
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 override 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
) override

public FullEnumerationChangeBatch GetFullEnumerationChangeBatch (
    UInt32 batchSize, 
    SyncId lowerEnumerationBound, 
    SyncKnowledge knowledgeForDataRetrieval, 
    /** @attribute OutAttribute() */ /** @ref */ Object changeDataRetriever
)

JScript does not support passing value-type arguments by reference.

Parameters

  • batchSize
    The number of changes to include in the returned change batch.
  • lowerEnumerationBound
    The closed lower bound for item IDs to enumerate. This method returns changes that have item IDs greater than or equal to this value.
  • knowledgeForDataRetrieval
    A knowledge object that specifies items for which data is already known.
  • changeDataRetriever
    Returns an object that can be used to retrieve change data.

Return Value

The batch of changes from the unmanaged provider.

Remarks

This method wraps the unmanaged IKnowledgeSyncProvider::GetFullEnumerationChangeBatch method.

If a change data retriever adapter was specified, this method converts the change data retriever that is returned by the unmanaged provider to its managed representation before it returns changeDataRetriever. Otherwise, the change data retriever is just returned with no conversion.

See Also

Reference

UnmanagedSyncProviderWrapper Class
UnmanagedSyncProviderWrapper Members
Microsoft.Synchronization Namespace