NetDfsSetSecurity function

Sets the security descriptor for the root object of the specified DFS namespace.

Syntax

NET_API_STATUS NET_API_FUNCTION NetDfsSetSecurity(
  LPWSTR               DfsEntryPath,
  SECURITY_INFORMATION SecurityInformation,
  PSECURITY_DESCRIPTOR pSecurityDescriptor
);

Parameters

DfsEntryPath

Pointer to a string that specifies the Universal Naming Convention (UNC) path of a DFS namespace root.

The string can be in one of two forms. The first form is as follows:

\ServerName<i>DfsName

where ServerName is the name of the root target server that hosts the stand-alone DFS namespace and Dfsname is the name of the DFS namespace.

The second form is as follows:

\DomainName<i>DomDfsName

where DomainName is the name of the domain that hosts the domain-based DFS namespace and DomDfsName is the name of the DFS namespace.

SecurityInformation

SECURITY_INFORMATION structure that contains bit flags that indicate the type of security information to set on the root object.

pSecurityDescriptor

SECURITY_DESCRIPTOR structure that contains the security descriptor to set as specified in the SecurityInformation parameter.

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

For domain-based DFS namespaces, the security descriptor is set on the "CN=DomDfsName,CN=DFS-Configuration,CN=System,DC=domain" object in Active Directory at the primary domain controller (PDC) of the domain that hosts the DFS namespace, where <DomDfsName> is the name of the domain-based DFS namespace and <domain> is the distinguished name of the Active Directory domain that hosts the namespace.

For stand-alone roots, the security descriptor is set on the object specified by the HKLM<b>Software<b>Microsoft<b>Dfs<b>Standalone<b><root-name> registry entry.

Requirements

   
Windows version Windows Vista Windows Server 2008, Windows Server 2008
Target Platform Windows
Header lmdfs.h (include LmDfs.h, Lm.h)
Library Netapi32.lib
DLL Netapi32.dll

See Also

Distributed File System (DFS) Functions

NetDfsGetSecurity

Network Management Functions

Network Management Overview