NetDfsRemoveFtRootForced function

Removes the specified root target from a domain-based Distributed File System (DFS) namespace, even if the root target server is offline. If the last root target of the DFS namespace is being removed, the function also deletes the DFS namespace. A DFS namespace can be deleted without first deleting all the links in it.

Note  The NetDfsRemoveFtRootForced function does not update the registry on the DFS root target server. For more information, see the Remarks section.
 

Syntax

NET_API_STATUS NET_API_FUNCTION NetDfsRemoveFtRootForced(
  LPWSTR DomainName,
  LPWSTR ServerName,
  LPWSTR RootShare,
  LPWSTR FtDfsName,
  DWORD  Flags
);

Parameters

DomainName

Pointer to a string that specifies the name of the Active Directory domain that contains the domain-based DFS namespace to be removed. This parameter is required.

ServerName

Pointer to a string that specifies the name of the DFS root target server to be removed. The server must host a root of the domain-based DFS namespace. This parameter is required.

RootShare

Pointer to a string that specifies the name of the DFS root target share to be removed. This parameter is required.

FtDfsName

Pointer to a string that specifies the name of the domain-based DFS namespace from which to remove the root target. This parameter is required. Typically, it is the same as the RootShare parameter.

Flags

Must be zero.

Return Value

If the function succeeds, the return value is NERR_Success.

If the function fails, the return value is a system error code. For a list of error codes, see System Error Codes.

Remarks

The caller must have permission to update the DFS container in the directory service and must have Administrator privilege on the DFS host (root) server.

The NetDfsRemoveFtRootForced function forcibly removes a domain-based DFS root target from a DFS namespace. It is used to delete a domain-based DFS namespace when the root target servers of the namespace are no longer available (for example, because they have been decommissioned).

Because the DFS root target is removed by contacting the primary domain controller (PDC) and not by removing the DFS root target server, NetDfsRemoveFtRootForced does not update the registry of the root target server. Under normal circumstances, you can remove the root target from a DFS domain root by calling the NetDfsRemoveFtRoot function.

Requirements

   
Windows version Windows Vista Windows Server 2008
Target Platform Windows
Header lmdfs.h (include LmDfs.h, Lm.h)
Library Netapi32.lib
DLL Netapi32.dll

See Also

Distributed File System (DFS) Functions

NetDfsAddFtRoot

NetDfsRemoveFtRoot

Network Management Functions

Network Management Overview