Directory Services


The DsReplicaUpdateRefs function adds or removes a replication reference for a destination from a source naming context.

DWORD DsReplicaUpdateRefs(
  LPCTSTR NameContext,
  LPCTSTR DsaDest,
  const UUID* pUuidDsaDest,
  ULONG Options


[in] Contains the bind handle to the directory service. This handle is returned by a call to the DsBind or DsBindWithCred function.
[in] Pointer to a constant null-terminated string that specifies the distinguished name of the source naming context.
[in] Pointer to a constant null-terminated string that specifies the transport-specific address of the destination directory system agent.
[in] Pointer to a UUID value that contains the destination directory system agent.
[in] Contains a set of flags that provide additional data used to process the request. This can be zero or a combination of one or more of the following values.
Value Meaning
DS_REPUPD_ADD_REFERENCE A reference to the destination is added to the source server.
DS_REPUPD_ASYNCHRONOUS_OPERATION The operation is performed asynchronously.
DS_REPUPD_DELETE_REFERENCE A reference to the destination is removed from the source server.
DS_REPUPD_WRITEABLE The reference to the replica added or removed is writable. Otherwise, it is read-only.

Return Values

If the function succeeds, ERROR_SUCCESS is returned.

If the function fails, the return value can be one of the following.

Return Code Description
ERROR_INVALID_PARAMETER One or more parameters are invalid.
ERROR_NOT_SUPPORTED Reserved for future use.


If both DS_REPUPD_ADD_REFERENCE and DS_REPUPD_DELETE_REFERENCE are set in the Options parameter, a reference to the destination is added if one does not already exist on the server. If a reference to the destination already exists, the reference is updated.


Client: Included in Windows XP and Windows 2000 Professional.
Server: Included in Windows Server 2003 and Windows 2000 Server.
Redistributable: Requires Active Directory Client Extension on Windows NT 4.0 SP6a and Windows 95/98/Me.
Unicode: Implemented as Unicode and ANSI versions on Windows NT/2000/XP.
Header: Declared in Ntdsapi.h.
Library: Use Ntdsapi.lib.

See Also

DsReplicaAdd, DsReplicaDel, DsReplicaModify, DsReplicaSync, Domain Controller and Replication Management Functions