IProviderCustomFilteredSyncServices::DeserializeChangeBatchWithFilterKeyMap

Creates an ISyncChangeBatch object that contains an IFilterKeyMap object, and initializes it by using serialized data.

Syntax

HRESULT DeserializeChangeBatchWithFilterKeyMap(
  ISyncFilterDeserializer * pISyncFilterDeserializer,
  const BYTE * pbChangeBatch,
  DWORD cbChangeBatch,
  ISyncChangeBatch ** ppChangeBatch);

Parameters

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

  • pbChangeBatch
    [in, size_is(cbChangeBatch)] The serialized change batch data.

  • cbChangeBatch
    [in] The number of bytes in pbChangeBatch.

  • ppChangeBatch
    [out] Returns a change batch object that is initialized by using the serialized data contained in pbChangeBatch.

Return Value

  • S_OK.

  • E_OUTOFMEMORY.

  • E_POINTER.

  • SYNC_E_DESERIALIZATION when a problem occurs during serialization.

  • SYNC_E_INVALID_OPERATION when this object has not been initialized by calling IProviderSyncServices::Initialize.

Remarks

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

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

See Also

Reference

IProviderCustomFilteredSyncServices Interface