AddAce

関数

ACLの指定位置に1つ以上のACEを追加する。

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

シグネチャ

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

BOOL AddAce(
    ACL* pAcl,
    ACE_REVISION dwAceRevision,
    DWORD dwStartingAceIndex,
    void* pAceList,
    DWORD nAceListLength
);

パラメーター

名前	型	方向	説明
pAcl	ACL*	inout	ACL へのポインターです。この関数はこの ACL に ACE を追加します。
dwAceRevision	ACE_REVISION	in	変更対象の ACL のリビジョンレベルを指定します。この値には ACL_REVISION または ACL_REVISION_DS を指定できます。ACL にオブジェクト固有の ACE が含まれる場合は ACL_REVISION_DS を使用してください。この値は pAceList 内のすべての ACE の AceType フィールドと互換性がある必要があります。そうでない場合、関数は失敗し、最終エラーが ERROR_INVALID_PARAMETER に設定されます。
dwStartingAceIndex	DWORD	in	ACL の ACE リスト内で新しい ACE を追加する位置を指定します。値が 0 の場合、リストの先頭に ACE を挿入します。値が MAXDWORD の場合、リストの末尾に ACE を追加します。
pAceList	void*	in	指定した ACL に追加する 1 つ以上の ACE のリストへのポインターです。リスト内の ACE は連続して格納されている必要があります。
nAceListLength	DWORD	in	pAceList パラメーターが指す入力バッファーのサイズをバイト単位で指定します。

戻り値の型: BOOL

公式ドキュメント

指定したアクセス制御リスト (ACL) に 1 つ以上のアクセス制御エントリ (ACE) を追加します。

戻り値

関数が成功した場合、戻り値は 0 以外になります。

関数が失敗した場合、戻り値は 0 になります。拡張エラー情報を取得するには、 GetLastError を呼び出します。次のエラー値が返される可能性があります。

戻り値	説明
ERROR_INSUFFICIENT_BUFFER	新しい ACE が ACL に収まりません。より大きな ACL バッファーが必要です。
ERROR_INVALID_PARAMETER	指定された ACL の形式が正しくありません。
ERROR_SUCCESS	ACE が正常に追加されました。

解説(Remarks)

アプリケーションでは、AddAce 関数を使用して ACL を操作する際に、 FindFirstFreeAce 関数や GetAce 関数をよく使用します。さらに、 GetAclInformation 関数によって取得される ACL_SIZE_INFORMATION 構造体には、ACL のサイズと、それに含まれる ACE の数が格納されます。

例

この関数を使用する例については、対話型クライアントプロセスの開始を参照してください。

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

各言語での呼び出し定義

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

BOOL AddAce(
    ACL* pAcl,
    ACE_REVISION dwAceRevision,
    DWORD dwStartingAceIndex,
    void* pAceList,
    DWORD nAceListLength
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool AddAce(
    IntPtr pAcl,   // ACL* in/out
    uint dwAceRevision,   // ACE_REVISION
    uint dwStartingAceIndex,   // DWORD
    IntPtr pAceList,   // void*
    uint nAceListLength   // DWORD
);

<DllImport("ADVAPI32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function AddAce(
    pAcl As IntPtr,   ' ACL* in/out
    dwAceRevision As UInteger,   ' ACE_REVISION
    dwStartingAceIndex As UInteger,   ' DWORD
    pAceList As IntPtr,   ' void*
    nAceListLength As UInteger   ' DWORD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' pAcl : ACL* in/out
' dwAceRevision : ACE_REVISION
' dwStartingAceIndex : DWORD
' pAceList : void*
' nAceListLength : DWORD
Declare PtrSafe Function AddAce Lib "advapi32" ( _
    ByVal pAcl As LongPtr, _
    ByVal dwAceRevision As Long, _
    ByVal dwStartingAceIndex As Long, _
    ByVal pAceList As LongPtr, _
    ByVal nAceListLength As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

AddAce = ctypes.windll.advapi32.AddAce
AddAce.restype = wintypes.BOOL
AddAce.argtypes = [
    ctypes.c_void_p,  # pAcl : ACL* in/out
    wintypes.DWORD,  # dwAceRevision : ACE_REVISION
    wintypes.DWORD,  # dwStartingAceIndex : DWORD
    ctypes.POINTER(None),  # pAceList : void*
    wintypes.DWORD,  # nAceListLength : DWORD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
AddAce = Fiddle::Function.new(
  lib['AddAce'],
  [
    Fiddle::TYPE_VOIDP,  # pAcl : ACL* in/out
    -Fiddle::TYPE_INT,  # dwAceRevision : ACE_REVISION
    -Fiddle::TYPE_INT,  # dwStartingAceIndex : DWORD
    Fiddle::TYPE_VOIDP,  # pAceList : void*
    -Fiddle::TYPE_INT,  # nAceListLength : DWORD
  ],
  Fiddle::TYPE_INT)

#[link(name = "advapi32")]
extern "system" {
    fn AddAce(
        pAcl: *mut ACL,  // ACL* in/out
        dwAceRevision: u32,  // ACE_REVISION
        dwStartingAceIndex: u32,  // DWORD
        pAceList: *mut (),  // void*
        nAceListLength: u32  // DWORD
    ) -> 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 AddAce(IntPtr pAcl, uint dwAceRevision, uint dwStartingAceIndex, IntPtr pAceList, uint nAceListLength);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_AddAce' -Namespace Win32 -PassThru
# $api::AddAce(pAcl, dwAceRevision, dwStartingAceIndex, pAceList, nAceListLength)

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

出力引数:

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