从基于域的 DFS 命名空间中删除 DFS 根目标。 如果根目标是 DFS 命名空间中的最后一个根目标,则此函数将删除 DFS 命名空间。 此函数还可用于删除独立的 DFS 命名空间。
语法
NET_API_STATUS NET_API_FUNCTION NetDfsRemoveRootTarget(
[in] LPWSTR pDfsPath,
[in, optional] LPWSTR pTargetPath,
[in] ULONG Flags
);
参数
[in] pDfsPath
指向指定 DFS 命名空间的 UNC) 路径 (通用命名约定的字符串的指针。
对于独立的 DFS 命名空间,此字符串应采用以下形式:
\\ ServerName\DfsName
其中 ,ServerName 是承载 DFS 根目标的服务器的名称, DfsName 是 DFS 命名空间的名称。
对于基于域的 DFS 命名空间,此字符串应采用以下形式:
\\ DomainName\DomDfsName
其中 ,DomainName 是托管基于域的 DFS 命名空间的域的名称, 而 DomDfsName 是 DFS 命名空间的名称。
[in, optional] pTargetPath
指向以 null 结尾的 Unicode 字符串的指针,该字符串指定 pDfsPath 参数中指定的 DFS 命名空间的 DFS 根目标的 UNC 路径。
对于独立 DFS 命名空间,此参数必须为 NULL。 对于基于域的 DFS 命名空间,字符串应采用以下形式:
\\ ServerName\RootShare
其中 ,ServerName 是承载 DFS 根目标的服务器的名称, RootShare 是服务器上文件夹的名称。
[in] Flags
一个指定删除操作类型的标志。 对于独立的 DFS 命名空间,此参数必须为零。 对于基于域的 DFS 命名空间,它可以是零或以下值。 如果为零,则表示正常删除操作。
DFS_FORCE_REMOVE (0x80000000)
如果为基于域的 DFS 命名空间指定了此标志,则根目标将被删除,即使它不可访问也是如此。
返回值
如果函数成功,则返回值NERR_Success。
如果函数失败,则返回值为系统错误代码。 有关错误代码的列表,请参阅 系统错误代码。
注解
调用方必须在 DFS 服务器上具有管理员权限。
以下列表显示应根据所需结果指定哪些参数值。
| pDfsPath 参数 | pTargetPath 参数 | 结果 |
|---|---|---|
| \\DomainName\DomDfsName | \\ServerName\RootShare | 删除 Windows 2000 模式或 Windows Server 2008 模式基于域的 DFS 根目标。 如果目标是 DFS 命名空间的最后一个根目标,则 函数还会删除 DFS 命名空间。 |
| \\ServerName\DfsName | NULL | 删除独立的 DFS 命名空间。 |
要求
| 要求 | 值 |
|---|---|
| 最低受支持的客户端 | Windows Vista SP1 |
| 最低受支持的服务器 | Windows Server 2008 |
| 目标平台 | Windows |
| 标头 | lmdfs.h (包括 LmDfs.h、Lm.h) |
| Library | Netapi32.lib |
| DLL | Netapi32.dll |