Edit

ISyncChangeBatchBase::Serialize method (winsync.h)

  • Article

Serializes the change batch to an array of bytes.

Syntax

HRESULT Serialize(
  [in, out] BYTE  *pbChangeBatch,
  [in, out] DWORD *pcbChangeBatch
);

Parameters

[in, out] pbChangeBatch

The byte array that receives the change batch data.

[in, out] pcbChangeBatch

Specifies the number of bytes in pbChangeBatch. Returns the number of bytes required for pbChangeBatch when pbChangeBatch is too small, or the number of bytes written to pbChangeBatch when data is written.

Return value

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_POINTER
 Invalid pointer.
E_OUTOFMEMORY
HRESULT_FROM_WIN32(ERROR_MORE_DATA)
 pbChangeBatch is too small. In this case, the required number of bytes is stored in pcbChangeBatch.
SYNC_E_INVALID_OPERATION
 The last group added to the batch was not ended.

Requirements

Requirement Value
Minimum supported client Windows 7 [desktop apps only]
Minimum supported server Windows Server 2008 R2 [desktop apps only]
Target Platform Windows
Header winsync.h

See also

ISyncChangeBatchBase Interface

SyncSerializationVersion Enumeration