ホーム › Security.Authorization › SetEntriesInAclW

SetEntriesInAclW

関数

明示的アクセスエントリのリストから新しいACLを作成する(Unicode版)。

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

シグネチャ

// ADVAPI32.dll  (Unicode / -W)
#include <windows.h>

WIN32_ERROR SetEntriesInAclW(
    DWORD cCountOfExplicitEntries,
    EXPLICIT_ACCESS_W* pListOfExplicitEntries,   // optional
    ACL* OldAcl,   // optional
    ACL** NewAcl
);

パラメーター

名前	型	方向	説明
cCountOfExplicitEntries	DWORD	in	pListOfExplicitEntries 配列内の EXPLICIT_ACCESS 構造体の数。
pListOfExplicitEntries	EXPLICIT_ACCESS_W*	inoptional	既存の ACL にマージするアクセス制御情報を記述した EXPLICIT_ACCESS 構造体の配列へのポインター。
OldAcl	ACL*	inoptional	既存の ACL へのポインター。このパラメーターには NULL を指定できます。その場合、関数は EXPLICIT_ACCESS エントリに基づいて新しい ACL を作成します。
NewAcl	ACL**	out	新しい ACL へのポインターを受け取る変数へのポインター。関数が成功した場合、返されたバッファーを解放するために LocalFree 関数を呼び出す必要があります。

戻り値の型: WIN32_ERROR

公式ドキュメント

新しいアクセス制御情報または監査制御情報を既存の ACL 構造体にマージして、新しいアクセス制御リスト (ACL) を作成します。(Unicode)

戻り値

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

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

解説(Remarks)

EXPLICIT_ACCESS 構造体の配列の各エントリは、指定された受託者 (trustee) に対するアクセス制御情報または監査制御情報を指定します。受託者には、ユーザー、グループ、またはその他のセキュリティ識別子 (SID) 値 (ログオン識別子やログオンの種類 (たとえば Windows サービスやバッチジョブ) など) を指定できます。受託者の識別には、名前または SID を使用できます。

SetEntriesInAcl 関数を使用すると、随意アクセス制御リスト (DACL) またはシステムアクセス制御リスト (SACL) 内のアクセス制御エントリ (ACE) の一覧を変更できます。SetEntriesInAcl は、アクセス制御情報と監査制御情報を同一の ACL 内に混在させることを妨げません。ただし、その結果生成される ACL には意味をなさないエントリが含まれることになります。

DACL の場合、 EXPLICIT_ACCESS 構造体の grfAccessMode メンバーは、受託者に対してアクセス権を許可するか、拒否するか、取り消すかを指定します。このメンバーには、次のいずれかの値を指定できます。

これらの値については、ACCESS_MODE を参照してください。

SetEntriesInAcl 関数は、新しい ACL の ACE 一覧において、新しいアクセス拒否 ACE をすべて先頭に配置します。また、新しいアクセス許可 ACE は、既存のアクセス許可 ACE の直前に配置します。

SACL の場合、 EXPLICIT_ACCESS 構造体の grfAccessMode メンバーには、次の値を指定できます。

SET_AUDIT_FAILURE と SET_AUDIT_SUCCESS は組み合わせて指定できます。これらの値については、ACCESS_MODE を参照してください。

SetEntriesInAcl 関数は、新しい ACL の ACE 一覧において、新しいシステム監査 ACE をすべて先頭に配置します。

例

この関数を使用する例については、オブジェクトの ACL の変更、新しいオブジェクトのセキュリティ記述子の作成、またはオブジェクトの所有権の取得を参照してください。

メモ

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

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

各言語での呼び出し定義

// ADVAPI32.dll  (Unicode / -W)
#include <windows.h>

WIN32_ERROR SetEntriesInAclW(
    DWORD cCountOfExplicitEntries,
    EXPLICIT_ACCESS_W* pListOfExplicitEntries,   // optional
    ACL* OldAcl,   // optional
    ACL** NewAcl
);

[DllImport("ADVAPI32.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint SetEntriesInAclW(
    uint cCountOfExplicitEntries,   // DWORD
    IntPtr pListOfExplicitEntries,   // EXPLICIT_ACCESS_W* optional
    IntPtr OldAcl,   // ACL* optional
    IntPtr NewAcl   // ACL** out
);

<DllImport("ADVAPI32.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function SetEntriesInAclW(
    cCountOfExplicitEntries As UInteger,   ' DWORD
    pListOfExplicitEntries As IntPtr,   ' EXPLICIT_ACCESS_W* optional
    OldAcl As IntPtr,   ' ACL* optional
    NewAcl As IntPtr   ' ACL** out
) As UInteger
End Function

' cCountOfExplicitEntries : DWORD
' pListOfExplicitEntries : EXPLICIT_ACCESS_W* optional
' OldAcl : ACL* optional
' NewAcl : ACL** out
Declare PtrSafe Function SetEntriesInAclW Lib "advapi32" ( _
    ByVal cCountOfExplicitEntries As Long, _
    ByVal pListOfExplicitEntries As LongPtr, _
    ByVal OldAcl As LongPtr, _
    ByVal NewAcl As LongPtr) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

SetEntriesInAclW = ctypes.windll.advapi32.SetEntriesInAclW
SetEntriesInAclW.restype = wintypes.DWORD
SetEntriesInAclW.argtypes = [
    wintypes.DWORD,  # cCountOfExplicitEntries : DWORD
    ctypes.c_void_p,  # pListOfExplicitEntries : EXPLICIT_ACCESS_W* optional
    ctypes.c_void_p,  # OldAcl : ACL* optional
    ctypes.c_void_p,  # NewAcl : ACL** out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
SetEntriesInAclW = Fiddle::Function.new(
  lib['SetEntriesInAclW'],
  [
    -Fiddle::TYPE_INT,  # cCountOfExplicitEntries : DWORD
    Fiddle::TYPE_VOIDP,  # pListOfExplicitEntries : EXPLICIT_ACCESS_W* optional
    Fiddle::TYPE_VOIDP,  # OldAcl : ACL* optional
    Fiddle::TYPE_VOIDP,  # NewAcl : ACL** out
  ],
  -Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "advapi32")]
extern "system" {
    fn SetEntriesInAclW(
        cCountOfExplicitEntries: u32,  // DWORD
        pListOfExplicitEntries: *mut EXPLICIT_ACCESS_W,  // EXPLICIT_ACCESS_W* optional
        OldAcl: *mut ACL,  // ACL* optional
        NewAcl: *mut *mut ACL  // ACL** out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("ADVAPI32.dll", CharSet = CharSet.Unicode)]
public static extern uint SetEntriesInAclW(uint cCountOfExplicitEntries, IntPtr pListOfExplicitEntries, IntPtr OldAcl, IntPtr NewAcl);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_SetEntriesInAclW' -Namespace Win32 -PassThru
# $api::SetEntriesInAclW(cCountOfExplicitEntries, pListOfExplicitEntries, OldAcl, NewAcl)

#uselib "ADVAPI32.dll"
#func global SetEntriesInAclW "SetEntriesInAclW" wptr, wptr, wptr, wptr
; SetEntriesInAclW cCountOfExplicitEntries, varptr(pListOfExplicitEntries), varptr(OldAcl), varptr(NewAcl)   ; 戻り値は stat
; cCountOfExplicitEntries : DWORD -> "wptr"
; pListOfExplicitEntries : EXPLICIT_ACCESS_W* optional -> "wptr"
; OldAcl : ACL* optional -> "wptr"
; NewAcl : ACL** out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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