Export (0) Print
Expand All
Expand Minimize

GetExplicitEntriesFromAcl function

The GetExplicitEntriesFromAcl function retrieves an array of structures that describe the access control entries (ACEs) in an access control list (ACL).

Syntax


DWORD WINAPI GetExplicitEntriesFromAcl(
  _In_   PACL pacl,
  _Out_  PULONG pcCountOfExplicitEntries,
  _Out_  PEXPLICIT_ACCESS *pListOfExplicitEntries
);

Parameters

pacl [in]

A pointer to an ACL structure from which to get ACE information.

pcCountOfExplicitEntries [out]

A pointer to a variable that receives the number of EXPLICIT_ACCESS structures returned in the pListOfExplicitEntries array.

pListOfExplicitEntries [out]

A pointer to a variable that receives a pointer to an array of EXPLICIT_ACCESS structures that describe the ACEs in the ACL. If the function succeeds, you must call the LocalFree function to free the returned buffer.

Return value

If the function succeeds, the function returns ERROR_SUCCESS.

If the function fails, it returns a nonzero error code defined in WinError.h.

Remarks

Each entry in the array of EXPLICIT_ACCESS structures describes access control information from an ACE for a trustee. A trustee can be a user, group, or program (such as a Windows service).

Each EXPLICIT_ACCESS structure specifies a set of access rights and an access mode flag that indicates whether the ACE allows, denies, or audits the specified rights.

For a discretionary access control list (DACL), the access mode flag can be either GRANT_ACCESS or DENY_ACCESS. For information about these values, see ACCESS_MODE.

For a system access control list (SACL), the access mode flag can be SET_AUDIT_ACCESS, SET_AUDIT_FAILURE, or both. For information about these values, see ACCESS_MODE.

Requirements

Minimum supported client

Windows XP [desktop apps only]

Minimum supported server

Windows Server 2003 [desktop apps only]

Header

Aclapi.h

Library

Advapi32.lib

DLL

Advapi32.dll

Unicode and ANSI names

GetExplicitEntriesFromAclW (Unicode) and GetExplicitEntriesFromAclA (ANSI)

See also

Access Control
Basic Access Control Functions
ACCESS_ALLOWED_ACE
ACCESS_DENIED_ACE
ACCESS_MODE
ACE
ACL
EXPLICIT_ACCESS
LocalFree
SYSTEM_AUDIT_ACE

 

 

Community Additions

ADD
Show:
© 2014 Microsoft