ILoadChangeContext::SetRecoverableErrorOnChangeUnit method (winsync.h)

Article
02/22/2024

Indicates that a recoverable error occurred when data for the specified change unit was loaded from the item store.

Syntax

HRESULT SetRecoverableErrorOnChangeUnit(
  [in] HRESULT               hrError,
  [in] ISyncChangeUnit       *pChangeUnit,
  [in] IRecoverableErrorData *pErrorData
);

Parameters

[in] hrError

The error code that is associated with the error that prevented the change unit data from being loaded.

[in] pChangeUnit

The change unit change that caused the error.

[in] pErrorData

Additional information about the error.

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	hrError does not specify an error.
E_POINTER	Invalid pointer.
SYNC_E_ON_CREATE_MUST_FAIL_ENTIRE_ITEM	The change that contains this change unit refers to an item creation. In this case, the error must be reported on the item change by using ILoadChangeContext::SetRecoverableErrorOnChange.
SYNC_E_INTERNAL_ERROR	An internal error has occurred.

Remarks

When this method is called, an IChangeUnitException object is added to the learned knowledge; and the change unit change will not be enumerated again for the duration of 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

Share via