DsRemoveDsServerA function (ntdsapi.h)

The DsRemoveDsServer function removes all traces of a directory service agent (DSA) from the global area of the directory service.

Syntax

NTDSAPI DWORD DsRemoveDsServerA(
  [in]            HANDLE hDs,
  [in]            LPSTR  ServerDN,
  [in, optional]  LPSTR  DomainDN,
  [out, optional] BOOL   *fLastDcInDomain,
  [in]            BOOL   fCommit
);

Parameters

[in] hDs

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

[in] ServerDN

Pointer to a null-terminated string that specifies the fully qualified distinguished name of the domain controller to remove.

[in, optional] DomainDN

Pointer to a null-terminated string that specifies a domain hosted by ServerDN. If this parameter is NULL, no verification is performed to ensure that ServerDN is the last domain controller in DomainDN.

[out, optional] fLastDcInDomain

Pointer to a Boolean value that receives TRUE if ServerDN is the last DC in DomainDN or FALSE otherwise. This parameter receives FALSE if DomainDN is NULL.

[in] fCommit

Contains a Boolean value that specifies if the domain controller should actually be removed. If this parameter is nonzero, ServerDN is removed. If this parameter is zero, the existence of ServerDN is checked and fLastDcInDomain is written, but the domain controller is not removed.

Return value

Returns ERROR_SUCCESS if successful or a Win32 or RPC error code if unsuccessful. Possible error codes include the following.

Remarks

Requirements

See also

Domain Controller and Replication Management Functions

DsBind

DsBindWithCred

DsRemoveDsDomain