Share via

ReplCheckpoint (Compact 2013)

  • Article

3/26/2014

This function is used by synchronization clients to mark the synchronization of a set of changes as complete. This function frees the client to read a new set of changes.

Syntax

BOOL ReplCheckpoint(
  HREPL hRepl,
  DWORD dwReserved
);

Parameters

  • hRepl
    [in] Handle to an open synchronization session, obtained from a call to the ReplOpenSync function.
  • dwReserved
    [in] Reserved; set to 0 (zero).

Return Value

TRUE indicates success. FALSE indicates failure. For extended error information, call GetLastError.

Remarks

It is not necessary to call this function immediately before closing a session or immediately after opening a new one. The state of the synchronization session remains the same as saved in the buffer returned by the ReplGetSyncState function. Typically, use this function to mark the completion of synchronization.

Performing the checkpoint resets the enumeration state used by the ReplFindNextChange function. Following a checkpoint, ReplFindNextChange returns the changes made by other threads and applications since the previous checkpoint. Calling this function before all changes finish enumerating discards change-tracking information and could result in some unsynchronized data.

A client completes synchronization when it calls this function, and then ReplFindNextChange reports ERROR_NO_MORE_ITEMS.

Requirements

Header

pwindbas.h

Library

coredll.lib

See Also

Reference

Database Replication Functions
ReplGetSyncState
ReplFindNextChange
ReplOpenSync