Platform SDK: Network Management

NetDfsAddStdRootForced

The NetDfsAddStdRootForced function creates the root for a new stand-alone Distributed File System (Dfs) implementation in a cluster technology environment, allowing an offline share to host the Dfs root.

Note This function is currently being evaluated and may or may not be supported in future versions.

Security Requirements

Administrator privileges are required to successfully execute the NetDfsAddStdRootForced function.

NET_API_STATUS NetDfsAddStdRootForced(
  LPWSTR ServerName,       
  LPWSTR RootShare,        
  LPWSTR Comment OPTIONAL, 
  LPWSTR Store             
);

Parameters

ServerName

[in] Pointer to a null-terminated Unicode character string that specifies the name of the storage server that will host the root of the new stand-alone 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 will host the new Dfs root. This parameter is required.

Comment

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

Store

[in] Pointer to a null-terminated Unicode character string that specifies the path to the share that will host the new Dfs root. This parameter is required and must be of the form:

drive:\directory

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

The NetDfsAddStdRootForced function exists only for clustering technology. It is recommended that you use the function only if you are thoroughly familiar with the concepts and architecture of Dfs.

Under normal circumstances, you can create the root for a new stand-alone Dfs implementation by calling the NetDfsAddStdRoot function.

Requirements