ホーム › Security.Authorization › BuildExplicitAccessWithNameW

BuildExplicitAccessWithNameW

関数

トラスティ名から明示的アクセス構造体を初期化する(Unicode版)。

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

シグネチャ

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

void BuildExplicitAccessWithNameW(
    EXPLICIT_ACCESS_W* pExplicitAccess,
    LPWSTR pTrusteeName,   // optional
    DWORD AccessPermissions,
    ACCESS_MODE AccessMode,
    ACE_FLAGS Inheritance
);

パラメーター

名前

型

方向

説明

pExplicitAccess

EXPLICIT_ACCESS_W*

inout

初期化する EXPLICIT_ACCESS 構造体へのポインターです。BuildExplicitAccessWithName 関数はメモリを割り当てません。このパラメーターを NULL にすることはできません。

pTrusteeName

LPWSTR

inoptional

TRUSTEE 構造体の ptstrName メンバーに設定するトラスティの名前を含む null 終端文字列へのポインターです。BuildExplicitAccessWithName 関数は、TRUSTEE 構造体のその他のメンバーを次のように設定します。

値	意味
pMultipleTrustee	NULL
MultipleTrusteeOperation	NO_MULTIPLE_TRUSTEE
TrusteeForm	TRUSTEE_IS_NAME
TrusteeType	TRUSTEE_IS_UNKNOWN

AccessPermissions

DWORD

EXPLICIT_ACCESS 構造体の grfAccessPermissions メンバーに設定するアクセスマスクを指定します。このマスクは、 ACCESS_MASK 形式を使用するビットフラグの集合であり、 ACE がトラスティに対して許可、拒否、または監査するアクセス権を指定します。EXPLICIT_ACCESS 構造体を使用する関数は、このマスク内のビットを変換、解釈、または検証しません。

AccessMode

ACCESS_MODE

EXPLICIT_ACCESS 構造体の grfAccessMode メンバーに設定するアクセスモードを指定します。アクセスモードは、アクセス制御エントリ (ACE) が指定された権利を許可、拒否、または監査するかどうかを示します。随意アクセス制御リスト (DACL) の場合、このパラメーターには ACCESS_MODE 列挙体の値のいずれか 1 つを指定できます。システムアクセス制御リスト (SACL) の場合、このパラメーターには ACCESS_MODE 値の組み合わせを指定できます。

Inheritance

ACE_FLAGS

EXPLICIT_ACCESS 構造体の grfInheritance メンバーに設定する継承の種類を指定します。この値は、 ACL が関連付けられているプライマリオブジェクトから、他のコンテナーやオブジェクトが ACE を継承できるかどうかを決定するビットフラグの集合です。このメンバーの値は、 ACE_HEADER 構造体の AceFlags メンバーの継承部分 (下位バイト) に対応します。このパラメーターには、ACE が継承不可であることを示す NO_INHERITANCE を指定するか、次の値の組み合わせを指定できます。

値	意味
CONTAINER_INHERIT_ACE	プライマリオブジェクトに含まれる他のコンテナーが ACE を継承します。
INHERIT_ONLY_ACE	ACE は、ACL が関連付けられているプライマリオブジェクトには適用されませんが、プライマリオブジェクトに含まれるオブジェクトは ACE を継承します。
NO_PROPAGATE_INHERIT_ACE	OBJECT_INHERIT_ACE および CONTAINER_INHERIT_ACE フラグは、継承された ACE には伝播されません。
OBJECT_INHERIT_ACE	プライマリオブジェクトに含まれる非コンテナーオブジェクトが ACE を継承します。
SUB_CONTAINERS_AND_OBJECTS_INHERIT	プライマリオブジェクトに含まれるコンテナーと非コンテナーオブジェクトの両方が ACE を継承します。このフラグは、CONTAINER_INHERIT_ACE フラグと OBJECT_INHERIT_ACE フラグの組み合わせに対応します。
SUB_CONTAINERS_ONLY_INHERIT	プライマリオブジェクトに含まれる他のコンテナーが ACE を継承します。このフラグは、CONTAINER_INHERIT_ACE フラグと INHERIT_ONLY_ACE フラグの組み合わせに対応します。
SUB_OBJECTS_ONLY_INHERIT	プライマリオブジェクトに含まれる非コンテナーオブジェクトが ACE を継承します。このフラグは、OBJECT_INHERIT_ACE フラグと INHERIT_ONLY_ACE フラグの組み合わせに対応します。

戻り値の型: void

公式ドキュメント

呼び出し元が指定したデータで EXPLICIT_ACCESS 構造体を初期化します。トラスティは名前文字列によって識別されます。(Unicode)

解説(Remarks)

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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>

void BuildExplicitAccessWithNameW(
    EXPLICIT_ACCESS_W* pExplicitAccess,
    LPWSTR pTrusteeName,   // optional
    DWORD AccessPermissions,
    ACCESS_MODE AccessMode,
    ACE_FLAGS Inheritance
);

[DllImport("ADVAPI32.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern void BuildExplicitAccessWithNameW(
    IntPtr pExplicitAccess,   // EXPLICIT_ACCESS_W* in/out
    [MarshalAs(UnmanagedType.LPWStr)] string pTrusteeName,   // LPWSTR optional
    uint AccessPermissions,   // DWORD
    int AccessMode,   // ACCESS_MODE
    uint Inheritance   // ACE_FLAGS
);

<DllImport("ADVAPI32.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Sub BuildExplicitAccessWithNameW(
    pExplicitAccess As IntPtr,   ' EXPLICIT_ACCESS_W* in/out
    <MarshalAs(UnmanagedType.LPWStr)> pTrusteeName As String,   ' LPWSTR optional
    AccessPermissions As UInteger,   ' DWORD
    AccessMode As Integer,   ' ACCESS_MODE
    Inheritance As UInteger   ' ACE_FLAGS
)
End Sub

' pExplicitAccess : EXPLICIT_ACCESS_W* in/out
' pTrusteeName : LPWSTR optional
' AccessPermissions : DWORD
' AccessMode : ACCESS_MODE
' Inheritance : ACE_FLAGS
Declare PtrSafe Sub BuildExplicitAccessWithNameW Lib "advapi32" ( _
    ByVal pExplicitAccess As LongPtr, _
    ByVal pTrusteeName As LongPtr, _
    ByVal AccessPermissions As Long, _
    ByVal AccessMode As Long, _
    ByVal Inheritance 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

BuildExplicitAccessWithNameW = ctypes.windll.advapi32.BuildExplicitAccessWithNameW
BuildExplicitAccessWithNameW.restype = None
BuildExplicitAccessWithNameW.argtypes = [
    ctypes.c_void_p,  # pExplicitAccess : EXPLICIT_ACCESS_W* in/out
    wintypes.LPCWSTR,  # pTrusteeName : LPWSTR optional
    wintypes.DWORD,  # AccessPermissions : DWORD
    ctypes.c_int,  # AccessMode : ACCESS_MODE
    wintypes.DWORD,  # Inheritance : ACE_FLAGS
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
BuildExplicitAccessWithNameW = Fiddle::Function.new(
  lib['BuildExplicitAccessWithNameW'],
  [
    Fiddle::TYPE_VOIDP,  # pExplicitAccess : EXPLICIT_ACCESS_W* in/out
    Fiddle::TYPE_VOIDP,  # pTrusteeName : LPWSTR optional
    -Fiddle::TYPE_INT,  # AccessPermissions : DWORD
    Fiddle::TYPE_INT,  # AccessMode : ACCESS_MODE
    -Fiddle::TYPE_INT,  # Inheritance : ACE_FLAGS
  ],
  Fiddle::TYPE_VOID)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "advapi32")]
extern "system" {
    fn BuildExplicitAccessWithNameW(
        pExplicitAccess: *mut EXPLICIT_ACCESS_W,  // EXPLICIT_ACCESS_W* in/out
        pTrusteeName: *mut u16,  // LPWSTR optional
        AccessPermissions: u32,  // DWORD
        AccessMode: i32,  // ACCESS_MODE
        Inheritance: u32  // ACE_FLAGS
    );
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("ADVAPI32.dll", CharSet = CharSet.Unicode)]
public static extern void BuildExplicitAccessWithNameW(IntPtr pExplicitAccess, [MarshalAs(UnmanagedType.LPWStr)] string pTrusteeName, uint AccessPermissions, int AccessMode, uint Inheritance);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_BuildExplicitAccessWithNameW' -Namespace Win32 -PassThru
# $api::BuildExplicitAccessWithNameW(pExplicitAccess, pTrusteeName, AccessPermissions, AccessMode, Inheritance)

#uselib "ADVAPI32.dll"
#func global BuildExplicitAccessWithNameW "BuildExplicitAccessWithNameW" wptr, wptr, wptr, wptr, wptr
; BuildExplicitAccessWithNameW varptr(pExplicitAccess), pTrusteeName, AccessPermissions, AccessMode, Inheritance
; pExplicitAccess : EXPLICIT_ACCESS_W* in/out -> "wptr"
; pTrusteeName : LPWSTR optional -> "wptr"
; AccessPermissions : DWORD -> "wptr"
; AccessMode : ACCESS_MODE -> "wptr"
; Inheritance : ACE_FLAGS -> "wptr"

出力引数:

#uselib "ADVAPI32.dll"
#func global BuildExplicitAccessWithNameW "BuildExplicitAccessWithNameW" var, wstr, int, int, int
; BuildExplicitAccessWithNameW pExplicitAccess, pTrusteeName, AccessPermissions, AccessMode, Inheritance
; pExplicitAccess : EXPLICIT_ACCESS_W* in/out -> "var"
; pTrusteeName : LPWSTR optional -> "wstr"
; AccessPermissions : DWORD -> "int"
; AccessMode : ACCESS_MODE -> "int"
; Inheritance : ACE_FLAGS -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "ADVAPI32.dll"
#func global BuildExplicitAccessWithNameW "BuildExplicitAccessWithNameW" sptr, wstr, int, int, int
; BuildExplicitAccessWithNameW varptr(pExplicitAccess), pTrusteeName, AccessPermissions, AccessMode, Inheritance
; pExplicitAccess : EXPLICIT_ACCESS_W* in/out -> "sptr"
; pTrusteeName : LPWSTR optional -> "wstr"
; AccessPermissions : DWORD -> "int"
; AccessMode : ACCESS_MODE -> "int"
; Inheritance : ACE_FLAGS -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。