GetAclInformation function

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

Syntax

BOOL WINAPI GetAclInformation(
  _In_  PACL                  pAcl,
  _Out_ LPVOID                pAclInformation,
  _In_  DWORD                 nAclInformationLength,
  _In_  ACL_INFORMATION_CLASS dwAclInformationClass
);

Parameters

pAcl [in]

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

pAclInformation [out]

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.

nAclInformationLength [in]

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

dwAclInformationClass [in]

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.

Examples

For an example that uses this function, see Starting an Interactive Client Process.

Requirements

See also

Low-level Access Control

Low-level Access Control Functions

ACL_INFORMATION_CLASS

ACL_REVISION_INFORMATION

ACL_SIZE_INFORMATION

GetAce

InitializeAcl

IsValidAcl

SetAclInformation