NetDfsGetSecurity function

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

Syntax

NET_API_STATUS NetDfsGetSecurity(
  _In_  LPWSTR               DfsEntryPath,
  _In_  SECURITY_INFORMATION SecurityInformation,
  _Out_ PSECURITY_DESCRIPTOR *ppSecurityDescriptor,
  _Out_ LPDWORD              lpcbSecurityDescriptor
);

Parameters

DfsEntryPath [in]

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\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\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 [in]

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

ppSecurityDescriptor [out]

Pointer to a list of SECURITY_DESCRIPTOR structures that contain the security items requested in the SecurityInformation parameter.

Note  This buffer must be freed by calling the NetApiBufferFree function.

 

lpcbSecurityDescriptor [out]

The size of the buffer that ppSecurityDescriptor points to, in bytes.

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 retrieved from the "CN=DomDfsName,CN=DFS-Configuration,CN=System,DC=domain" object in Active Directory from 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 retrieved from the object specified by the HKLM\Software\Microsoft\Dfs\Standalone\<root-name> registry entry.

Requirements

See also

Network Management Overview

Network Management Functions

Distributed File System (DFS) Functions

NetDfsSetSecurity