Skip to content

Latest commit

 

History

History
115 lines (79 loc) · 4.57 KB

nf-lmdfs-netdfsremoveftrootforced.md

File metadata and controls

115 lines (79 loc) · 4.57 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:lmdfs.NetDfsRemoveFtRootForced
NetDfsRemoveFtRootForced function (lmdfs.h)
Removes the specified root target from a domain-based Distributed File System (DFS) namespace, even if the root target server is offline.
NetDfsRemoveFtRootForced
NetDfsRemoveFtRootForced function [Distributed File System]
_win32_netdfsremoveftrootforced
dfs.netdfsremoveftrootforced
fs.netdfsremoveftrootforced
lmdfs/NetDfsRemoveFtRootForced
netmgmt.netdfsremoveftrootforced
dfs\netdfsremoveftrootforced.htm
Dfs
4eaa0e2a-fa09-4a20-98e1-4c0c4ff5d0ef
12/05/2018
NetDfsRemoveFtRootForced, NetDfsRemoveFtRootForced function [Distributed File System], _win32_netdfsremoveftrootforced, dfs.netdfsremoveftrootforced, fs.netdfsremoveftrootforced, lmdfs/NetDfsRemoveFtRootForced, netmgmt.netdfsremoveftrootforced
lmdfs.h
LmDfs.h, Lm.h
Windows
Windows Vista
Windows Server 2008
Netapi32.lib
Netapi32.dll
Windows
19H1
NetDfsRemoveFtRootForced
lmdfs/NetDfsRemoveFtRootForced
c++
APIRef
kbSyntax
DllExport
Netapi32.dll
NetDfsRemoveFtRootForced

NetDfsRemoveFtRootForced function

-description

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.
 

-parameters

-param DomainName [in]

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.

-param ServerName [in]

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.

-param RootShare [in]

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

-param FtDfsName [in]

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.

-param Flags

Must be zero.

-returns

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.

-see-also

Distributed File System (DFS) Functions

NetDfsAddFtRoot

NetDfsRemoveFtRoot

Network Management Functions

Network Management Overview