ISyncChangeBuilder::AddChangeUnitMetadata method (winsync.h)

Adds change unit metadata to an item change.

Syntax

HRESULT AddChangeUnitMetadata(
  [in] const BYTE         *pbChangeUnitId,
  [in] const SYNC_VERSION *pChangeUnitVersion
);

[in] pbChangeUnitId

The ID of the change unit to add to the item change.

[in] pChangeUnitVersion

The version of the change unit change to add to the item change.

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
SYNC_E_ID_FORMAT_MISMATCH	The format of the change unit ID that is contained in pbChangeUnitId does not match the format that is specified by the ID format schema of the provider.
SYNC_E_INVALID_OPERATION	The item change to which to add this change unit to has SYNC_CHANGE_FLAG_DELETE or SYNC_CHANGE_FLAG_DOES_NOT_EXIST set as one of its flags.

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