Important:
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.
A version of this page is also available for
4/8/2010

This function purges old tracking data. Tracking data is retained by the engine. However, for space consideration, it is useful to periodically purge some tracking-specific information.

Syntax

BOOL CePurgeTrackingData(
	PCEGUID pVolGuid,
	PCEGUID pSyncPartnerGuid,
	SYSTEMTIME* pstThreshold
);

Parameters

pVolGuid

[in] Pointer to the CEGUIDstructure that contains the GUID of a mounted database volume or the shared volume. This parameter cannot be set to NULL.

pSyncPartnerGuid

[in] Pointer to the CEGUIDstructure that uniquely identifies the synchronization partner. This parameter cannot be set to NULL.

pstThreshold

[in] Pointer to a structure that contains the time information that specifies the time before which any change information that has been gathered will be purged. This parameter cannot be set to NULL.

Return Value

TRUE indicates success. FALSE indicates failure. To get extended error information, call GetLastError. The following table shows possible values.

Return Value Description

ERROR_BAD_LENGTH

The database is too big.

ERROR_FILE_NOT_FOUND

The tracking tables could not be found.

ERROR_INTERNAL_DB_CORRUPTION

The database is corrupted.

ERROR_INVALID_PARAMETER

One or more parameters are invalid.

ERROR_NOT_FOUND

The volume pointed to by pVolGuidcould not be found.

ERROR_NOT_SUPPORTED

Too many sessions are open.

Remarks

Invoking the tracking functions on a CEDB volume causes an error, and GetLastErrorreturns ERROR_INVALID_PARAMETER.

Requirements

Header windbase.h
Library coredll.lib
Windows Embedded CE Windows Embedded CE 6.0 and later
Windows Mobile Windows Mobile Version 5.0 and later

See Also