SyncDataConverter.TryConvertDataRetrieverFromProviderFormat Method

When overridden in a derived class, converts the data retriever from the associated provider’s format to the required data retriever format.

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

Syntax

'Declaration
Public Overridable Function TryConvertDataRetrieverFromProviderFormat ( _
    dataRetrieverIn As Object, _
    itemChanges As IEnumerable(Of ItemChange), _
    <OutAttribute> ByRef dataRetrieverOut As Object _
) As Boolean
'Usage
Dim instance As SyncDataConverter
Dim dataRetrieverIn As Object
Dim itemChanges As IEnumerable(Of ItemChange)
Dim dataRetrieverOut As Object
Dim returnValue As Boolean

returnValue = instance.TryConvertDataRetrieverFromProviderFormat(dataRetrieverIn, itemChanges, dataRetrieverOut)

public virtual bool TryConvertDataRetrieverFromProviderFormat (
    Object dataRetrieverIn,
    IEnumerable<ItemChange> itemChanges,
    out Object dataRetrieverOut
)

public:
virtual bool TryConvertDataRetrieverFromProviderFormat (
    Object^ dataRetrieverIn, 
    IEnumerable<ItemChange^>^ itemChanges, 
    [OutAttribute] Object^% dataRetrieverOut
)

public boolean TryConvertDataRetrieverFromProviderFormat (
    Object dataRetrieverIn, 
    IEnumerable<ItemChange> itemChanges, 
    /** @attribute OutAttribute() */ /** @ref */ Object dataRetrieverOut
)

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

Parameters

• dataRetrieverIn
  An object that represents the data retriever to be converted.

• itemChanges
  An ItemChange object that represents a set of item changes.

• dataRetrieverOut
  An object that represents the converted data retriever.

Return Value

true if the data retriever conversion succeeded; otherwise false.

Remarks

This method is required only if one or both of the providers in a synchronization session retrieves data using an interface other than IChangeDataRetriever. In many cases, the most efficient way to convert a data retriever is to create a proxy that implements the required data retriever interface and holds a reference to the provider's data retriever interface. The proxy can then retrieve data from the provider interface as changes are processed during the synchronization session. In some cases, such as remote change application scenarios, you must retrieve all of the changes up front, convert them as necessary, and serialize the data retriever with all the data in it. For these cases, use itemChanges to enumerate all of the changes that should be serialized.

For more information about data conversion, see Converting Data Between Providers.

See Also

Reference

SyncDataConverter Class
SyncDataConverter Members
Microsoft.Synchronization Namespace