ISyncFilterInfo::Serialize method (winsync.h)

  • Article

Serializes the filter data to an array of bytes.

Syntax

HRESULT Serialize(
  [in, out] BYTE  *pbBuffer,
  [in, out] DWORD *pcbBuffer
);

Parameters

[in, out] pbBuffer

Returns the serialized filter information. Set this value to NULL to request the required size of the buffer.

[in, out] pcbBuffer

Specifies the number of bytes in pbBuffer. Returns the number of bytes required to serialize the filter when pcbBuffer is too small, or the number of bytes 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_INVALIDARG
0x800700EA (HRESULT_FROM_WIN32(ERROR_MORE_DATA))
 pbBuffer is NULL or pcbBuffer is too small. In this case, the number of bytes required to serialize the filter is returned in pcbBuffer.

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

ISyncFilterInfo Interface