NetDfsAddRootTarget 函数 (lmdfs.h)

项目
08/24/2023

创建基于域或独立的 DFS 命名空间，或将新的根目标添加到现有的基于域的命名空间。

语法

NET_API_STATUS NET_API_FUNCTION NetDfsAddRootTarget(
  [in]           LPWSTR pDfsPath,
  [in, optional] LPWSTR pTargetPath,
  [in]           ULONG  MajorVersion,
  [in, optional] LPWSTR pComment,
  [in]           ULONG  Flags
);

参数

[in] pDfsPath

指向指定 DFS 命名空间的 UNC) 路径 (通用命名约定的字符串的指针。

对于独立 DFS 命名空间，此字符串应采用以下格式：

\\ServerName\DfsName

其中 ，ServerName 是将托管新 DFS 根目标的服务器的名称， DfsName 是 DFS 命名空间的名称。

对于基于域的 DFS 命名空间，此字符串应采用以下格式：

\\DomainName\DomDfsName

其中 ，DomainName 是托管基于域的 DFS 命名空间的域的名称， 而 DomDfsName 是新的或现有的基于域的 DFS 命名空间的名称。出于兼容性原因， DomDfsName 应与将托管新 DFS 根目标的服务器上的共享文件夹的名称相同。

[in, optional] pTargetPath

指向以 null 结尾的 Unicode 字符串的指针，该字符串指定 pDfsPath 参数中指定的 DFS 命名空间的 DFS 根目标的 UNC 路径。

对于独立 DFS 命名空间，此参数必须为 NULL。对于基于域的 DFS 命名空间，字符串应采用以下格式：

\\ServerName\RootShare

其中 ，ServerName 是将托管新 DFS 根目标的服务器的名称， RootShare 是服务器上共享文件夹的名称。 RootShare 指定的共享必须已存在于将托管新 DFS 根目标的服务器上。此函数不会创建新共享。

[in] MajorVersion

指定命名空间的 DFS 元数据版本。

注意此参数仅在创建新命名空间时使用。

如果要创建独立的 DFS 命名空间，则必须将此参数设置为 1。

如果正在创建基于域的命名空间，则应按如下所示设置此参数：

将其设置为 1 以指定 Windows 2000 模式。
将其设置为 2 或更高以指定 Windows Server 2008 模式。

如果要将新的根目标添加到基于域的现有 DFS 命名空间，则必须将此参数设置为零。

[in, optional] pComment

指向以 null 结尾的 Unicode 字符串的指针，该字符串包含与 DFS 根关联的注释。

[in] Flags

此参数是保留的，必须为零。

返回值

如果函数成功，则返回值 NERR_Success。

如果域不在指定 MajorVersion 所需的功能级别，则返回值 ERROR_DS_INCOMPATIBLE。此返回值仅适用于域根和 MajorVersion 2。

如果函数失败，则返回值为系统错误代码。有关错误代码的列表，请参阅系统错误代码。

注解

调用方必须在 DFS 服务器上具有管理员权限。

若要确定可在 MajorVersion 参数中指定的 DFS 元数据版本，请使用 NetDfsGetSupportedNamespaceVersion 函数。

下表显示应根据所需结果指定哪些参数值。

pDfsPath 参数	pTargetPath 参数	MajorVersion 参数	结果
\\DomainName\DomDfsName	\\ServerName\RootShare	1	创建基于域的 Windows 2000 模式 DFS 命名空间或向现有根目标添加新的根目标。
\\DomainName\DomDfsName	\\ServerName\RootShare	2	创建基于域的 Windows Server 2008 模式 DFS 命名空间或向现有目标添加新的根目标。
\\DomainName\DomDfsName	\\ServerName\RootShare	0	将新的根目标添加到现有的 Windows 2000 模式或 Windows Server 2008 模式基于域的 DFS 命名空间。
\\ServerName\DfsName	NULL	必须为 1。	创建独立的 DFS 命名空间。

要求

要求	值
最低受支持的客户端	Windows Vista SP1
最低受支持的服务器	Windows Server 2008
目标平台	Windows
标头	lmdfs.h (包括 LmDfs.h、Lm.h)
Library	Netapi32.lib
DLL	Netapi32.dll