NetDfsAdd

The NetDfsAdd function creates a new junction point or adds shares to an existing junction point in a Distributed File System (Dfs) tree structure.

NET_API_STATUS NET_API_FUNCTION NetDfsAdd(
  LPWSTR DfsEntryPath,   // Dfs entry path for the added junction 
                         // point
  LPWSTR ServerName,     // name of server exporting the storage
  LPWSTR ShareName,      // existing share name for the storage
  LPWSTR Comment,        // optional comment for the junction point
  DWORD Flags            // zero for no flags
);
 

Parameters

DfsEntryPath

[in] Pointer to a null-terminated Unicode character string that specifies the Universal Naming Convention path of a junction point in a Dfs tree structure. The string must be of the form:

\\Dfsname\sharename\path-to-junction-point

where Dfsname is the name of a Windows NT server that hosts the Dfs root volume; sharename is the name of a share that is published on the Dfs host server; and path-to-junction-point specifies the path on the physical share.

ServerName

[in] Pointer to a null-terminated Unicode character string that specifies the name of the storage server that the junction point references.

ShareName

[in] Pointer to a null-terminated Unicode character string that specifies the name of the share on the storage server that the junction point references.

Comment

[in] Pointer to a null-terminated Unicode character string that contains an optional comment associated with the junction point.

Flags

[in] Specifies a flag value. If you set this parameter to the value DFS_ADD_VOLUME, the NetDfsAdd function will fail if the junction point already exists. If you set this parameter to zero, the function either creates a new junction point if one does not exist, or it adds a new share to an existing junction point.

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.

QuickInfo

  Windows NT: Requires version 4.0 or later.
  Windows: Unsupported.
  Windows CE: Unsupported.
  Header: Declared in lmdfs.h.
  Import Library: Use netapi32.lib.

See Also

Networking (Net) Overview, Net Functions, NetDfsEnum, NetDfsRemove