DsReplicaConsistencyCheck function (ntdsapi.h)

Article
02/22/2024

The DsReplicaConsistencyCheck function invokes the Knowledge Consistency Checker (KCC) to verify the replication topology. The KCC dynamically adjusts the data replication topology of your network when domain controllers are added to or removed from the network, when a domain controller is unavailable, or when the data replication schedules are changed.

Syntax

NTDSAPI DWORD DsReplicaConsistencyCheck(
  [in] HANDLE        hDS,
  [in] DS_KCC_TASKID TaskID,
  [in] DWORD         dwFlags
);

Parameters

[in] hDS

Contains a directory service handle obtained from either the DSBind, DSBindWithCred, or DsBindWithSpn function.

[in] TaskID

Identifies the task that the KCC should execute. DS_KCC_TASKID_UPDATE_TOPOLOGY is the only currently supported value.

[in] dwFlags

Contains a set of flags that modify the function behavior. This can be zero or a combination of one or more of the following values.

DS_KCC_FLAG_ASYNC_OP

The task is queued and then the function returns without waiting for the task to complete.

DS_KCC_FLAG_DAMPED

The task will not be added to the queue if another queued task will run soon.

Return value

If the function performs its operation successfully, the return value is ERROR_SUCCESS. If the function fails, the return value can be one of the following.

Requirements

Requirement	Value
Minimum supported client	Windows Vista
Minimum supported server	Windows Server 2008
Target Platform	Windows
Header	ntdsapi.h
Library	Ntdsapi.lib
DLL	Ntdsapi.dll