GetAce

関数

ACLから指定インデックスのACEへのポインターを取得する。

DLLADVAPI32.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

// ADVAPI32.dll
#include <windows.h>

BOOL GetAce(
    ACL* pAcl,
    DWORD dwAceIndex,
    void** pAce
);

パラメーター

名前	型	方向	説明
pAcl	ACL*	in	取得する ACE を含む ACL へのポインター。
dwAceIndex	DWORD	in	取得する ACE のインデックス。値 0 は ACL 内の最初の ACE に、値 1 は 2 番目の ACE に、というように対応します。
pAce	void**	out	関数が ACE のアドレスを設定するポインターへのポインター。

戻り値の型: BOOL

公式ドキュメント

アクセス制御リスト (ACL) 内のアクセス制御エントリ (ACE) へのポインターを取得します。

戻り値

関数が成功した場合は、0 以外の値を返します。

関数が失敗した場合は、0 を返します。拡張エラー情報を取得するには、 GetLastError を呼び出します。

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

各言語での呼び出し定義

// ADVAPI32.dll
#include <windows.h>

BOOL GetAce(
    ACL* pAcl,
    DWORD dwAceIndex,
    void** pAce
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool GetAce(
    IntPtr pAcl,   // ACL*
    uint dwAceIndex,   // DWORD
    IntPtr pAce   // void** out
);

<DllImport("ADVAPI32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetAce(
    pAcl As IntPtr,   ' ACL*
    dwAceIndex As UInteger,   ' DWORD
    pAce As IntPtr   ' void** out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' pAcl : ACL*
' dwAceIndex : DWORD
' pAce : void** out
Declare PtrSafe Function GetAce Lib "advapi32" ( _
    ByVal pAcl As LongPtr, _
    ByVal dwAceIndex As Long, _
    ByVal pAce As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetAce = ctypes.windll.advapi32.GetAce
GetAce.restype = wintypes.BOOL
GetAce.argtypes = [
    ctypes.c_void_p,  # pAcl : ACL*
    wintypes.DWORD,  # dwAceIndex : DWORD
    ctypes.c_void_p,  # pAce : void** out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
GetAce = Fiddle::Function.new(
  lib['GetAce'],
  [
    Fiddle::TYPE_VOIDP,  # pAcl : ACL*
    -Fiddle::TYPE_INT,  # dwAceIndex : DWORD
    Fiddle::TYPE_VOIDP,  # pAce : void** out
  ],
  Fiddle::TYPE_INT)

#[link(name = "advapi32")]
extern "system" {
    fn GetAce(
        pAcl: *mut ACL,  // ACL*
        dwAceIndex: u32,  // DWORD
        pAce: *mut *mut ()  // void** out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", SetLastError = true)]
public static extern bool GetAce(IntPtr pAcl, uint dwAceIndex, IntPtr pAce);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_GetAce' -Namespace Win32 -PassThru
# $api::GetAce(pAcl, dwAceIndex, pAce)

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

出力引数:

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