Share via

DbSyncProvider.GetSyncBatchParameters Method

  • Article

Get the parameters for the change batch when given batch size and knowledge parameters.

This method is not CLS-compliant.  The CLS-compliant alternative is .

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

Syntax

'Declaration
<CLSCompliantAttribute(False)> _
Public Overrides Sub GetSyncBatchParameters ( _
    <OutAttribute> ByRef batchSize As UInteger, _
    <OutAttribute> ByRef knowledge As SyncKnowledge _
)
'Usage
Dim instance As DbSyncProvider
Dim batchSize As UInteger
Dim knowledge As SyncKnowledge

instance.GetSyncBatchParameters(batchSize, knowledge)

[CLSCompliantAttribute(false)] 
public override void GetSyncBatchParameters (
    out uint batchSize,
    out SyncKnowledge knowledge
)

[CLSCompliantAttribute(false)] 
public:
virtual void GetSyncBatchParameters (
    [OutAttribute] unsigned int% batchSize, 
    [OutAttribute] SyncKnowledge^% knowledge
) override

/** @attribute CLSCompliantAttribute(false) */ 
public void GetSyncBatchParameters (
    /** @attribute OutAttribute() */ /** @ref */ UInt32 batchSize, 
    /** @attribute OutAttribute() */ /** @ref */ SyncKnowledge knowledge
)

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

Parameters

  • batchSize
    The number of changes to synchronize in each change batch.
  • knowledge
    A SyncKnowledge object that contains the knowledge a provider has about the store at which changes are applied.

Remarks

Microsoft.Synchronization.dll and associated concepts about synchronization knowledge are documented in the Sync Framework core documentation. To download this documentation, go to this Microsoft Web site.

See Also

Reference

DbSyncProvider Class
DbSyncProvider Members
Microsoft.Synchronization.Data Namespace