IForgottenKnowledge::ForgetToVersion method (winsync.h)

  • Article

Updates the forgotten knowledge to reflect that all versions that are less than or equal to the specified version might have been forgotten, and that corresponding tombstones might have been deleted.

Syntax

HRESULT ForgetToVersion(
  [in] ISyncKnowledge     *pKnowledge,
  [in] const SYNC_VERSION *pVersion
);

Parameters

[in] pKnowledge

The current knowledge of the replica that owns this forgotten knowledge object.

[in] pVersion

The version of the tombstone that has been cleaned up.

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
E_OUTOFMEMORY

Remarks

When a replica cleans up the tombstone for an item, its associated provider must call this method and specify the version of the tombstone that was removed.

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

IForgottenKnowledge Interface

SYNC_VERSION Structure