NetDfsRemoveFtRoot function (lmdfs.h)

Removes the specified root target from a domain-based Distributed File System (DFS) namespace. 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.

Syntax

NET_API_STATUS NET_API_FUNCTION NetDfsRemoveFtRoot(
  [in] LPWSTR ServerName,
  [in] LPWSTR RootShare,
  [in] LPWSTR FtDfsName,
       DWORD  Flags
);

Parameters

[in] ServerName

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

[in] RootShare

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

[in] 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

This parameter is reserved and 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 root target server must be available and accessible; otherwise, the call to the NetDfsRemoveFtRoot function will fail.

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.

Requirements

Requirement Value
Minimum supported client Windows Vista
Minimum supported server 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

NetDfsRemove

NetDfsRemoveFtRootForced

Network Management Functions

Network Management Overview