UnmanagedSyncProviderWrapper.GetChangeBatch Method
Gets a batch of changes from the unmanaged provider.
Namespace: Microsoft.Synchronization
Assembly: Microsoft.Synchronization (in Microsoft.Synchronization.dll)
Syntax
'Declaration
Public Overrides Function GetChangeBatch ( _
batchSize As UInteger, _
destinationKnowledge As SyncKnowledge, _
<OutAttribute> ByRef changeDataRetriever As Object _
) As ChangeBatch
'Usage
Dim instance As UnmanagedSyncProviderWrapper
Dim batchSize As UInteger
Dim destinationKnowledge As SyncKnowledge
Dim changeDataRetriever As Object
Dim returnValue As ChangeBatch
returnValue = instance.GetChangeBatch(batchSize, _
destinationKnowledge, changeDataRetriever)
public override ChangeBatch GetChangeBatch(
uint batchSize,
SyncKnowledge destinationKnowledge,
out Object changeDataRetriever
)
public:
virtual ChangeBatch^ GetChangeBatch(
unsigned int batchSize,
SyncKnowledge^ destinationKnowledge,
[OutAttribute] Object^% changeDataRetriever
) override
abstract GetChangeBatch :
batchSize:uint32 *
destinationKnowledge:SyncKnowledge *
changeDataRetriever:Object byref -> ChangeBatch
override GetChangeBatch :
batchSize:uint32 *
destinationKnowledge:SyncKnowledge *
changeDataRetriever:Object byref -> ChangeBatch
public override function GetChangeBatch(
batchSize : uint,
destinationKnowledge : SyncKnowledge,
changeDataRetriever : Object
) : ChangeBatch
Parameters
- batchSize
Type: System.UInt32
The number of changes to include in the returned change batch.
- destinationKnowledge
Type: Microsoft.Synchronization.SyncKnowledge
The knowledge of the destination replica.
- changeDataRetriever
Type: System.Object%
Returns an object that can be used to retrieve change data.
Return Value
Type: Microsoft.Synchronization.ChangeBatch
The batch of changes from the unmanaged provider.
Exceptions
| Exception | Condition |
|---|---|
| InvalidOperationException | This UnmanagedSyncProviderWrapper object is not initialized. |
| ArgumentNullException | destinationKnowledge is a null reference (Nothing in Visual Basic). |
Remarks
This method wraps the unmanaged IKnowledgeSyncProvider::GetChangeBatch 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.