NetDfsAddFtRoot function

Creates a new domain-based Distributed File System (DFS) namespace. If the namespace already exists, the function adds the specified root target to it.

Syntax

NET_API_STATUS NetDfsAddFtRoot(
  _In_     LPWSTR ServerName,
  _In_     LPWSTR RootShare,
  _In_     LPWSTR FtDfsName,
  _In_opt_ LPWSTR Comment,
  _In_     DWORD  Flags
);

Parameters

ServerName [in]

Pointer to a string that specifies the name of the server that will host the new DFS root target. This value cannot be an IP address. This parameter is required.

RootShare [in]

Pointer to a string that specifies the name of the shared folder on the server that will host the new DFS root target. This parameter is required.

FtDfsName [in]

Pointer to a string that specifies the name of the new or existing domain-based DFS namespace. This parameter is required. For compatibility reasons, it should specify the same string as the RootShare parameter.

Comment [in, optional]

Pointer to a string that contains an optional comment associated with the DFS namespace.

Flags [in]

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 share specified by the RootShare parameter must already exist on the server that will host the new DFS root target. This function does not create a new share.

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

See also

Network Management Overview

Network Management Functions

Distributed File System (DFS) Functions

NetDfsAddRootTarget

NetDfsAddStdRoot

NetDfsRemoveFtRoot

NetDfsAdd