GetAclInformation function (securitybaseapi.h)

The GetAclInformation function retrieves information about an access control list (ACL).

Syntax

BOOL GetAclInformation(
  [in]  PACL                  pAcl,
  [out] LPVOID                pAclInformation,
  [in]  DWORD                 nAclInformationLength,
  [in]  ACL_INFORMATION_CLASS dwAclInformationClass
);

Parameters

[in] pAcl

A pointer to an ACL. The function retrieves information about this ACL. If a null value is passed, the function causes an access violation.

[out] pAclInformation

A pointer to a buffer to receive the requested information. The structure that is placed into the buffer depends on the information class requested in the dwAclInformationClass parameter.

[in] nAclInformationLength

The size, in bytes, of the buffer pointed to by the pAclInformation parameter.

[in] dwAclInformationClass

A value of the ACL_INFORMATION_CLASS enumeration that indicates the class of information requested. This parameter can be one of two values from this enumeration:

• If the value is AclRevisionInformation, the function fills the buffer pointed to by the pAclInformation parameter with an ACL_REVISION_INFORMATION structure.
• If the value is AclSizeInformation, the function fills the buffer pointed to by the pAclInformation parameter with an ACL_SIZE_INFORMATION structure.

Return value

If the function succeeds, the function returns nonzero.

If the function fails, it returns zero. To get extended error information, call GetLastError.

Requirements

See also

ACL_INFORMATION_CLASS

ACL_REVISION_INFORMATION

ACL_SIZE_INFORMATION

GetAce

InitializeAcl

IsValidAcl

Low-level Access Control

Low-level Access Control Functions

SetAclInformation