IReplicaKeyMap::Serialize method (winsync.h)

  • Article

Serializes the replica key map data to a byte array.

Syntax

HRESULT Serialize(
  [in, out] BYTE  *pbReplicaKeyMap,
  [in, out] DWORD *pcbReplicaKeyMap
);

Parameters

[in, out] pbReplicaKeyMap

The byte array that receives the serialized data.

[in, out] pcbReplicaKeyMap

Specifies the number of bytes in pbReplicaKeyMap. Returns the number of bytes required to serialize the replica key map data when pbReplicaKeyMap 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_INVALIDARG
 A replica ID or replica key stored in the map is not valid.
E_POINTER
 Invalid pointer.
E_OUTOFMEMORY
HRESULT_FROM_WIN32(ERROR_MORE_DATA)
 pbReplicaKeyMap is too small. In this case, the required number of bytes is returned in pcbReplicaKeyMap.

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