DsReplicaDel function
The DsReplicaDel function removes a replication source reference from a destination naming context (NC).
Syntax
DWORD DsReplicaDel( _In_ HANDLE hDS, _In_ LPCTSTR NameContext, _In_ LPCTSTR DsaSrc, _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 (DN) of the destination NC from which to remove the replica. The destination NC record must exist locally as either an object, instantiated or not, or a reference phantom, for example, a phantom with a GUID.
- DsaSrc [in]
-
Pointer to a constant null-terminated Unicode string that specifies the transport-specific address of the source directory system agent (DSA). This source server is identified by a string name, not by its UUID. A string name appropriate for DsaSrc is usually a DNS name that is based on a GUID, where the GUID part of the name is the GUID of the nTDSDSA object for the source server.
- Options [in]
-
Passes additional data used to process the request. This parameter can be a combination of the following values.
-
Performs this operation asynchronously.
-
Ignores any error generated from contacting the source to instruct it to remove this NC from its list of servers to which it replicates.
-
Signifies the replica is mail-based rather than synchronized using native directory service RPC.
-
Does not contact the source to tell it to remove this NC from its list of servers to which it replicates. If this flag is not set and the link is based in RPC, the source is contacted.
-
Deletes all the objects in the NC. This option is valid only for read-only NCs with no source.
-
Allows deletion of a read-only replica even if it sources other read-only replicas.
-
Signifies that the replica deleted can be written to.
Return value
If the function succeeds, the return value is ERROR_SUCCESS.
If the function fails, the return value is a standard Win32 API error or ERROR_INVALID_PARAMETER if a parameter is invalid.
Requirements
|
Minimum supported client |
Windows Vista |
|---|---|
|
Minimum supported server |
Windows Server 2008 |
|
Header |
|
|
Library |
|
|
DLL |
|
|
Unicode and ANSI names |
DsReplicaDelW (Unicode) and DsReplicaDelA (ANSI) |
See also
- Domain Controller and Replication Management Functions
- DsReplicaAdd
- DsReplicaModify
- DsReplicaSync
- DsReplicaUpdateRefs