Platform SDK: Network Management

NetDfsRemoveFtRootForced

The NetDfsRemoveFtRootForced function removes the specified server and share from a domain-based Distributed File System (Dfs) root, even if the server is offline. 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 NetDfsRemoveFtRootForced function.

Note The NetDfsRemoveFtRootForced function does not update the registry on the domain-based Dfs host server. This function should be used only when the domain-based Dfs root is unavailable. For more information, see the following Remarks section.

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

Parameters

DomainName: [in] Pointer to a null-terminated Unicode character string that specifies the name of the domain that contains the domain-based Dfs root to remove. This parameter is required.
ServerName: [in] Pointer to a null-terminated Unicode character string that specifies the name of the storage server that hosts the root of the domain-based Dfs implementation. The string must begin with \\. This parameter is required.
RootShare: [in] Pointer to a null-terminated Unicode character string that specifies the name of the share on the storage server that hosts the root of the domain-based Dfs implementation. 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.

Remarks

It is recommended that you call the NetDfsRemoveFtRootForced function only if you are thoroughly familiar with the concepts and architecture of domain-based Dfs. The function does not update the server with the new Dfs root.

Because NetDfsRemoveFtRootForced does not update the registry, the function should be used only when the domain-based Dfs root is unavailable. Under normal circumstances, you can remove the server and share from a domain-based Dfs by calling the NetDfsRemoveFtRoot function.

Requirements