ISyncKnowledge::Serialize method (winsync.h)

  • Article

Serializes the knowledge object data to a byte array.

Syntax

HRESULT Serialize(
  [in]      BOOL  fSerializeReplicaKeyMap,
  [in, out] BYTE  *pbKnowledge,
  [in, out] DWORD *pcbKnowledge
);

Parameters

[in] fSerializeReplicaKeyMap

TRUE to serialize the IReplicaKeyMap object that is contained in the knowledge; otherwise, FALSE.

[in, out] pbKnowledge

The byte array that receives the serialized knowledge data.

[in, out] pcbKnowledge

Specifies the number of bytes in pbKnowledge. Returns the number of bytes required to serialize the replica key map data when pbKnowledge is too small, or returns 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_POINTER
 Invalid pointer.
E_INVALIDARG
E_OUTOFMEMORY
HRESULT_FROM_WIN32(ERROR_MORE_DATA)
 pbKnowledge is too small. In this case, the required number of bytes is returned in pbKnowledge.

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

IReplicaKeyMap Interface

ISyncKnowledge Interface