NetDfsGetSecurity function (lmdfs.h)
Retrieves the security descriptor for the root object of the specified DFS namespace.
Syntax
NET_API_STATUS NET_API_FUNCTION NetDfsGetSecurity(
[in] LPWSTR DfsEntryPath,
[in] SECURITY_INFORMATION SecurityInformation,
[out] PSECURITY_DESCRIPTOR *ppSecurityDescriptor,
[out] LPDWORD lpcbSecurityDescriptor
);
Parameters
[in] 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\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.
[in] SecurityInformation
SECURITY_INFORMATION structure that contains bit flags that indicate the type of security information to retrieve from the root object.
[out] ppSecurityDescriptor
Pointer to a list of SECURITY_DESCRIPTOR structures that contain the security items requested in the SecurityInformation parameter.
[out] lpcbSecurityDescriptor
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
| Requirement | Value |
|---|---|
| Minimum supported client | Windows Vista |
| Minimum supported server | Windows Server 2008, Windows Server 2008 |
| Target Platform | Windows |
| Header | lmdfs.h (include LmDfs.h, Lm.h) |
| Library | Netapi32.lib |
| DLL | Netapi32.dll |