Edit

Share via

ISyncChangeBatchBase::AddItemMetadataToGroup method (winsync.h)

  • Article

Adds a specified item change to the group that is currently open.

Syntax

HRESULT AddItemMetadataToGroup(
  [in]      const BYTE         *pbOwnerReplicaId,
  [in]      const BYTE         *pbItemId,
  [in]      const SYNC_VERSION *pChangeVersion,
  [in]      const SYNC_VERSION *pCreationVersion,
  [in]      DWORD              dwFlags,
  [in]      DWORD              dwWorkForChange,
  [in, out] ISyncChangeBuilder **ppChangeBuilder
);

Parameters

[in] pbOwnerReplicaId

The replica ID of the replica where pChangeVersion and pCreationVersion are valid. The ID format must match the format that is specified by the ID_PARAMETERS structure of the provider.

[in] pbItemId

The ID of the item. The ID format must match the format that is specified by the ID_PARAMETERS structure of the provider.

[in] pChangeVersion

The version of this change.

[in] pCreationVersion

The creation version of the item.

[in] dwFlags

Flags that specify the state of the item change. For the flag values, see ISyncChange::GetFlags.

[in] dwWorkForChange

The work estimate for the change. This value is used during change application to report completed work to the application.

[in, out] ppChangeBuilder

Returns an object that can be used to add change unit information to the change.

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
 dwFlags contains a flag value that is not valid.
SYNC_E_INVALID_OPERATION
 No group is open or an empty group was previously added to the batch.
SYNC_E_RANGE_OUT_OF_ORDER
 An ordered group is open and pbItemId is less than the item ID of the previous item that was added to the group, or less than the item ID that was specified when the group was opened.
SYNC_E_CHANGE_BATCH_IS_READ_ONLY
 The ISyncChangeBatchBase object has been sent to a change applier or to the synchronization session.

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

ID_PARAMETERS Structure

ISyncChangeBatchBase Interface

SYNC_VERSION Structure