Export (0) Print
Expand All

DsReplicaUpdateRefs function

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

Syntax


DWORD DsReplicaUpdateRefs(
  _In_  HANDLE hDS,
  _In_  LPCTSTR NameContext,
  _In_  LPCTSTR DsaDest,
  _In_  const UUID *pUuidDsaDest,
  _In_  ULONG Options
);

Parameters

hDS [in]

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

NameContext [in]

Pointer to a constant null-terminated string that specifies the distinguished name of the source naming context.

DsaDest [in]

Pointer to a constant null-terminated string that specifies the transport-specific address of the destination directory system agent.

pUuidDsaDest [in]

Pointer to a UUID value that contains the destination directory system agent.

Options [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.

ValueMeaning
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 value

If the function succeeds, ERROR_SUCCESS is returned.

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

Return codeDescription
ERROR_INVALID_PARAMETER

One or more parameters are invalid.

ERROR_NOT_SUPPORTED

Reserved for future use.

 

Remarks

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.

Requirements

Minimum supported client

Windows 2000 Professional [desktop apps only]

Minimum supported server

Windows 2000 Server [desktop apps only]

Redistributable

Active Directory Client Extension on Windows NT 4.0 and Windows Me/98/95

Header

Ntdsapi.h

Library

Ntdsapi.lib

DLL

Ntdsapi.dll

Unicode and ANSI names

DsReplicaUpdateRefsW (Unicode) and DsReplicaUpdateRefsA (ANSI)

See also

Domain Controller and Replication Management Functions
DsReplicaAdd
DsReplicaDel
DsReplicaModify
DsReplicaSync

 

 

Show:
© 2014 Microsoft