FullEnumerationChangeBatch.Deserialize Method (SyncIdFormatGroup, ISyncFilterDeserializer, Byte[])

Static method that creates a change batch object that is used for recovery synchronization, and initializes it by using an ID format schema, a custom filter deserializer, and data from a byte array.

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

Syntax

'Declaration
Public Shared Function Deserialize ( _
    idFormats As SyncIdFormatGroup, _
    syncFilterDeserializer As ISyncFilterDeserializer, _
    data As Byte() _
) As FullEnumerationChangeBatch
'Usage
Dim idFormats As SyncIdFormatGroup
Dim syncFilterDeserializer As ISyncFilterDeserializer
Dim data As Byte()
Dim returnValue As FullEnumerationChangeBatch

returnValue = FullEnumerationChangeBatch.Deserialize(idFormats, syncFilterDeserializer, data)

public static FullEnumerationChangeBatch Deserialize (
    SyncIdFormatGroup idFormats,
    ISyncFilterDeserializer syncFilterDeserializer,
    byte[] data
)

public:
static FullEnumerationChangeBatch^ Deserialize (
    SyncIdFormatGroup^ idFormats, 
    ISyncFilterDeserializer^ syncFilterDeserializer, 
    array<unsigned char>^ data
)

public static FullEnumerationChangeBatch Deserialize (
    SyncIdFormatGroup idFormats, 
    ISyncFilterDeserializer syncFilterDeserializer, 
    byte[] data
)

public static function Deserialize (
    idFormats : SyncIdFormatGroup, 
    syncFilterDeserializer : ISyncFilterDeserializer, 
    data : byte[]
) : FullEnumerationChangeBatch

Parameters

• idFormats
  The ID format schema of the provider.

• syncFilterDeserializer
  An object that is used to deserialize the custom filters that are contained in the serialized filter key map data.

• data
  The serialized change batch data.

Return Value

The newly created change batch object that is initialized by using the serialized data contained in data.

Exceptions

Exception type	Condition
ArgumentNullException	A required argument is a null reference (Nothing in Visual Basic).
SerializationException	A problem occurred during serialization.

Remarks

Typically, the data in the byte array will have been generated from prior serialization of a change batch object.

A filter key map is used by a provider that represents a replica that tracks filters. The filter key map maps filter keys to ISyncFilter objects.

To deserialize the custom filters that are contained in the serialized data, this method calls Deserialize one time for each filter in the serialized data.

See Also

Reference

FullEnumerationChangeBatch Class
FullEnumerationChangeBatch Members
Microsoft.Synchronization Namespace