NetDfsRemoveFtRoot

The NetDfsRemoveFtRoot function removes the specified server and share from a domain-based Distributed File System (Dfs) root. If the share is the last associated with the Dfs root, the function also deletes the root.

Note  This function is currently being evaluated and may or may not be supported in future versions.

Security Requirements

Users having permission to update the Dfs container in the directory service can successfully execute the NetDfsRemoveFtRoot function.

NET_API_STATUS NetDfsRemoveFtRoot(
  LPWSTR ServerName, 
  LPWSTR RootShare,  
  LPWSTR FtDfsName,  
  DWORD Flags        
);
 

Parameters

ServerName

[in] Pointer to a null-terminated Unicode character string that specifies the name of the storage server to remove. The string must begin with \\. The server must host the root of a domain-based Dfs implementation. This parameter is required.

RootShare

[in] Pointer to a null-terminated Unicode character string that specifies the name of the share to remove. This parameter is required.

FtDfsName

[in] Pointer to a null-terminated Unicode character string that specifies the name of the domain-based Dfs root from which to remove the server and share. This parameter is required.

Flags

[in] Must be zero.

Return Values

If the function succeeds, the return value is NERR_Success.

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

Requirements

  Windows NT/2000: Requires Windows 2000.
  Windows 95/98: Unsupported.
  Header: Declared in Lmdfs.h; include Lm.h.
  Library: Use Netapi32.lib.

See Also

Network Management Overview, Network Management Functions, Distributed File System (Dfs) Functions, NetDfsAddFtRoot, NetDfsRemoveFtRootForced, NetDfsRemove