ChangeBatch.Deserialize Method (SyncIdFormatGroup, ISyncFilterDeserializer, array<Byte )
Static method that creates a change batch object 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 ChangeBatch
'Usage
Dim idFormats As SyncIdFormatGroup
Dim syncFilterDeserializer As ISyncFilterDeserializer
Dim data As Byte()
Dim returnValue As ChangeBatch
returnValue = ChangeBatch.Deserialize(idFormats, _
syncFilterDeserializer, data)
public static ChangeBatch Deserialize(
SyncIdFormatGroup idFormats,
ISyncFilterDeserializer syncFilterDeserializer,
byte[] data
)
public:
static ChangeBatch^ Deserialize(
SyncIdFormatGroup^ idFormats,
ISyncFilterDeserializer^ syncFilterDeserializer,
array<unsigned char>^ data
)
static member Deserialize :
idFormats:SyncIdFormatGroup *
syncFilterDeserializer:ISyncFilterDeserializer *
data:byte[] -> ChangeBatch
public static function Deserialize(
idFormats : SyncIdFormatGroup,
syncFilterDeserializer : ISyncFilterDeserializer,
data : byte[]
) : ChangeBatch
Parameters
- idFormats
Type: Microsoft.Synchronization.SyncIdFormatGroup
The ID format schema of the provider.
- syncFilterDeserializer
Type: Microsoft.Synchronization.ISyncFilterDeserializer
An object that is used to deserialize the custom filters that are contained in the serialized filter key map data.
- data
Type: System.Byte[]
The serialized change batch data.
Return Value
Type: Microsoft.Synchronization.ChangeBatch
The newly created change batch object that is initialized by using the serialized data that is contained in data.
Exceptions
| Exception | Condition |
|---|---|
| ArgumentNullException | idFormats, syncFilterDeserializer, or data 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.