SyncUpdateProc

The SyncUpdateProc function is an application-defined function that handles update messages passed from the DsReplicaSyncAll function. SyncUpdateProc is a placeholder for the application-defined callback function name.

BOOL SyncUpdateProc(
  LPVOID pData,
  PDS_REPSYNCALL_UPDATE pUpdate
);

Parameters

pData

Pointer to data received from the pCallbackData parameter of the DsReplicaSyncAll function.

pUpdate

Pointer to a DS_REPSYNCALL_UPDATE structure which describes the event in the DsReplicaSyncAll function that caused the SyncUpdateProc callback function to be called.

Return Values

Execution of the DsReplicaSyncAll function pauses when it calls the SyncUpdateProc callback function. If SyncUpdateProc returns TRUE, execution of DsReplicaSyncAll will resume. Otherwise, the DsReplicaSyncAll function will terminate.

Remarks

Developers may use the SyncUpdateProc callback function to display the status of a DsReplicaSyncAll call to the user. The callback might also inform the user that the DsReplicaSyncAll function has encountered an error while synchronizing two servers, then ask the user whether to continue synchronizing other servers or to stop replication.

The DsReplicaSyncAll function will call SyncUpdateProc when any of four events occur.

• Synchronization has resulted in an error.
• Synchronization of two servers has been initiated.
• Synchronization of two servers has finished.
• Replication is complete for all the servers in the site.

The nature of the event that caused the DsReplicaSyncAll function to call SyncUpdateProc is stored in the event member of the DS_REPSYNCALL_UPDATE structure pointed to by pUpdate.

Requirements

  Windows NT/2000: Requires Windows 2000.
  Header: Declared in Ntdsapi.h.

See Also

DC and Replication Management Functions, DsReplicaSyncAll, DS_REPSYNCALL_UPDATE