ホーム › Security.Authorization › GetExplicitEntriesFromAclA

GetExplicitEntriesFromAclA

関数

ACLから明示的アクセスエントリの一覧を取得する(ANSI版)。

DLLADVAPI32.dll文字セットANSI (-A)呼出規約winapi対応OSWindows XP 以降

シグネチャ

// ADVAPI32.dll  (ANSI / -A)
#include <windows.h>

WIN32_ERROR GetExplicitEntriesFromAclA(
    ACL* pacl,
    DWORD* pcCountOfExplicitEntries,
    EXPLICIT_ACCESS_A** pListOfExplicitEntries
);

パラメーター

名前	型	方向	説明
pacl	ACL*	in	ACE 情報を取得する対象の ACL 構造体へのポインター。
pcCountOfExplicitEntries	DWORD*	out	pListOfExplicitEntries 配列に返される EXPLICIT_ACCESS 構造体の数を受け取る変数へのポインター。
pListOfExplicitEntries	EXPLICIT_ACCESS_A**	out	ACL 内の ACE を記述する EXPLICIT_ACCESS 構造体の配列へのポインターを受け取る変数へのポインター。関数が成功した場合は、 LocalFree 関数を呼び出して、返されたバッファーを解放する必要があります。

戻り値の型: WIN32_ERROR

公式ドキュメント

アクセス制御リスト (ACL) 内のアクセス制御エントリ (ACE) を記述する構造体の配列を取得します。(ANSI)

戻り値

関数が成功した場合は、ERROR_SUCCESS を返します。

関数が失敗した場合は、WinError.h に定義されている 0 以外のエラーコードを返します。

解説(Remarks)

EXPLICIT_ACCESS 構造体の配列の各エントリは、トラスティに対する ACE のアクセス制御情報を記述します。トラスティには、ユーザー、グループ、またはプログラム (Windows サービスなど) を指定できます。

各 EXPLICIT_ACCESS 構造体は、アクセス権のセットと、その ACE が指定された権利を許可するか、拒否するか、または監査するかを示すアクセスモードフラグを指定します。

任意アクセス制御リスト (DACL) の場合、アクセスモードフラグには GRANT_ACCESS または DENY_ACCESS のいずれかを指定できます。これらの値について詳しくは、ACCESS_MODE を参照してください。

システムアクセス制御リスト (SACL) の場合、アクセスモードフラグには SET_AUDIT_ACCESS、SET_AUDIT_FAILURE、またはその両方を指定できます。これらの値について詳しくは、ACCESS_MODE を参照してください。

メモ

aclapi.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして GetExplicitEntriesFromAcl を定義します。エンコーディング非依存のエイリアスを、エンコーディング非依存ではないコードと混在させて使用すると、不一致が生じてコンパイルエラーまたは実行時エラーを引き起こすおそれがあります。詳しくは、関数プロトタイプの規約を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// ADVAPI32.dll  (ANSI / -A)
#include <windows.h>

WIN32_ERROR GetExplicitEntriesFromAclA(
    ACL* pacl,
    DWORD* pcCountOfExplicitEntries,
    EXPLICIT_ACCESS_A** pListOfExplicitEntries
);

[DllImport("ADVAPI32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint GetExplicitEntriesFromAclA(
    IntPtr pacl,   // ACL*
    out uint pcCountOfExplicitEntries,   // DWORD* out
    IntPtr pListOfExplicitEntries   // EXPLICIT_ACCESS_A** out
);

<DllImport("ADVAPI32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function GetExplicitEntriesFromAclA(
    pacl As IntPtr,   ' ACL*
    <Out> ByRef pcCountOfExplicitEntries As UInteger,   ' DWORD* out
    pListOfExplicitEntries As IntPtr   ' EXPLICIT_ACCESS_A** out
) As UInteger
End Function

' pacl : ACL*
' pcCountOfExplicitEntries : DWORD* out
' pListOfExplicitEntries : EXPLICIT_ACCESS_A** out
Declare PtrSafe Function GetExplicitEntriesFromAclA Lib "advapi32" ( _
    ByVal pacl As LongPtr, _
    ByRef pcCountOfExplicitEntries As Long, _
    ByVal pListOfExplicitEntries As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetExplicitEntriesFromAclA = ctypes.windll.advapi32.GetExplicitEntriesFromAclA
GetExplicitEntriesFromAclA.restype = wintypes.DWORD
GetExplicitEntriesFromAclA.argtypes = [
    ctypes.c_void_p,  # pacl : ACL*
    ctypes.POINTER(wintypes.DWORD),  # pcCountOfExplicitEntries : DWORD* out
    ctypes.c_void_p,  # pListOfExplicitEntries : EXPLICIT_ACCESS_A** out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
GetExplicitEntriesFromAclA = Fiddle::Function.new(
  lib['GetExplicitEntriesFromAclA'],
  [
    Fiddle::TYPE_VOIDP,  # pacl : ACL*
    Fiddle::TYPE_VOIDP,  # pcCountOfExplicitEntries : DWORD* out
    Fiddle::TYPE_VOIDP,  # pListOfExplicitEntries : EXPLICIT_ACCESS_A** out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "advapi32")]
extern "system" {
    fn GetExplicitEntriesFromAclA(
        pacl: *mut ACL,  // ACL*
        pcCountOfExplicitEntries: *mut u32,  // DWORD* out
        pListOfExplicitEntries: *mut *mut EXPLICIT_ACCESS_A  // EXPLICIT_ACCESS_A** out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("ADVAPI32.dll", CharSet = CharSet.Ansi)]
public static extern uint GetExplicitEntriesFromAclA(IntPtr pacl, out uint pcCountOfExplicitEntries, IntPtr pListOfExplicitEntries);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_GetExplicitEntriesFromAclA' -Namespace Win32 -PassThru
# $api::GetExplicitEntriesFromAclA(pacl, pcCountOfExplicitEntries, pListOfExplicitEntries)

#uselib "ADVAPI32.dll"
#func global GetExplicitEntriesFromAclA "GetExplicitEntriesFromAclA" sptr, sptr, sptr
; GetExplicitEntriesFromAclA varptr(pacl), varptr(pcCountOfExplicitEntries), varptr(pListOfExplicitEntries)   ; 戻り値は stat
; pacl : ACL* -> "sptr"
; pcCountOfExplicitEntries : DWORD* out -> "sptr"
; pListOfExplicitEntries : EXPLICIT_ACCESS_A** out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "ADVAPI32.dll"
#cfunc global GetExplicitEntriesFromAclA "GetExplicitEntriesFromAclA" var, var, var
; res = GetExplicitEntriesFromAclA(pacl, pcCountOfExplicitEntries, pListOfExplicitEntries)
; pacl : ACL* -> "var"
; pcCountOfExplicitEntries : DWORD* out -> "var"
; pListOfExplicitEntries : EXPLICIT_ACCESS_A** out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "ADVAPI32.dll"
#cfunc global GetExplicitEntriesFromAclA "GetExplicitEntriesFromAclA" sptr, sptr, sptr
; res = GetExplicitEntriesFromAclA(varptr(pacl), varptr(pcCountOfExplicitEntries), varptr(pListOfExplicitEntries))
; pacl : ACL* -> "sptr"
; pcCountOfExplicitEntries : DWORD* out -> "sptr"
; pListOfExplicitEntries : EXPLICIT_ACCESS_A** out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。