UID

title

description

helpviewer_keywords

old-location

tech.root

ms.assetid

ms.date

ms.keywords

req.header

req.include-header

req.target-type

req.target-min-winverclnt

req.target-min-winversvr

req.kmdf-ver

req.umdf-ver

req.ddi-compliance

req.unicode-ansi

req.idl

req.max-support

req.namespace

req.assembly

req.type-library

req.lib

req.dll

req.irql

targetos

req.typenames

req.redist

ms.custom

f1_keywords

dev_langs

topic_type

api_type

api_location

api_name

NF:winsync.ISyncChangeBatchBase2.SerializeWithOptions

ISyncChangeBatchBase2::SerializeWithOptions (winsync.h)

Serializes the change batch object data to a byte array, based on the specified version and serialization options.

ISyncChangeBatchBase2 interface [Windows Sync]

SerializeWithOptions method

ISyncChangeBatchBase2.SerializeWithOptions

ISyncChangeBatchBase2::SerializeWithOptions

SerializeWithOptions

SerializeWithOptions method [Windows Sync]

ISyncChangeBatchBase2 interface

winsync.isyncchangebatchbase2_serializewithoptions

winsync/ISyncChangeBatchBase2::SerializeWithOptions

winsync\isyncchangebatchbase2_serializewithoptions.htm

winsync

6e686e6f-08b1-4a58-ac0f-30c48f70dd60

12/05/2018

ISyncChangeBatchBase2 interface [Windows Sync],SerializeWithOptions method, ISyncChangeBatchBase2.SerializeWithOptions, ISyncChangeBatchBase2::SerializeWithOptions, SerializeWithOptions, SerializeWithOptions method [Windows Sync], SerializeWithOptions method [Windows Sync],ISyncChangeBatchBase2 interface, winsync.isyncchangebatchbase2_serializewithoptions, winsync/ISyncChangeBatchBase2::SerializeWithOptions

winsync.h

Windows

Windows 7 [desktop apps only]

Windows Server 2008 R2 [desktop apps only]

Windows

19H1

ISyncChangeBatchBase2::SerializeWithOptions

winsync/ISyncChangeBatchBase2::SerializeWithOptions

c++

APIRef

kbSyntax

COM

winsync.h

ISyncChangeBatchBase2.SerializeWithOptions

ISyncChangeBatchBase2::SerializeWithOptions

-description

Serializes the change batch object data to a byte array, based on the specified version and serialization options.

-parameters

-param targetFormatVersion [in]

The serialized change batch is compatible with this version.

-param dwFlags [in]

Reserved. Must be zero.

-param pbBuffer [in, out]

The serialized change batch object data is serialized to this buffer.

-param pdwSerializedSize [in, out]

The number of bytes in pbBuffer. Returns either the number of bytes that are required to serialize the change batch data when pbBuffer is too small, or the number of bytes written.

-returns

The possible return codes include, but are not limited to, the values shown in the following table.

Return code	Description
S_OK	The method succeeded.
E_INVALIDARG	dwFlags is not zero, or the version that is specified by targetFormatVersion is incompatible with the change batch object data.
E_OUTOFMEMORY
E_POINTER	Invalid pointer.
HRESULT_FROM_WIN32(ERROR_MORE_DATA)	pBuffer is too small. In this situation, the required number of bytes is returned in pdwSerializedSize.
SYNC_E_INVALID_OPERATION	The change batch contains a group that was started but not ended.
SYNC_E_INVALID_VERSION	The value of targetFormatVersion is higher than the version of the object, or the object contains elements that are not compatible with targetFormatVersion.

-remarks

The following table describes the flags that specify information about an ISyncFilterInfo object.

SYNC_FILTER_INFO_FLAG value	Description
SYNC_FILTER_INFO_FLAG_ITEM_LIST	This flag indicates that the set of items synchronized is restricted by an item filter.
SYNC_FILTER_INFO_FLAG_CHANGE_UNIT_LIST	An IChangeUnitListFilterInfo object specifies that changes apply only to a subset of the change units that are defined for the scope.