ホーム › Security.Authorization › GetInheritanceSourceW

GetInheritanceSourceW

関数

ACL内の各ACEの継承元を特定して取得する(Unicode版)。

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

シグネチャ

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

WIN32_ERROR GetInheritanceSourceW(
    LPWSTR pObjectName,
    SE_OBJECT_TYPE ObjectType,
    OBJECT_SECURITY_INFORMATION SecurityInfo,
    BOOL Container,
    GUID** pObjectClassGuids,   // optional
    DWORD GuidCount,
    ACL* pAcl,
    FN_OBJECT_MGR_FUNCTS* pfnArray,   // optional
    GENERIC_MAPPING* pGenericMapping,
    INHERITED_FROMW* pInheritArray
);

パラメーター

名前	型	方向	説明
pObjectName	LPWSTR	in	検査対象の ACL を使用するオブジェクトの名前へのポインターです。
ObjectType	SE_OBJECT_TYPE	in	pObjectName で示されるオブジェクトの種類です。指定可能な値は SE_FILE_OBJECT、SE_REGISTRY_KEY、SE_DS_OBJECT、SE_DS_OBJECT_ALL です。
SecurityInfo	OBJECT_SECURITY_INFORMATION	in	オブジェクトで使用される ACL の種類です。指定可能な値は DACL_SECURITY_INFORMATION または SACL_SECURITY_INFORMATION です。
Container	BOOL	in	オブジェクトがコンテナーオブジェクトの場合は TRUE、リーフオブジェクトの場合は FALSE を指定します。なお、唯一のリーフオブジェクトは SE_FILE_OBJECT です。
pObjectClassGuids	GUID**	inoptional	pObjectName に関連付けられたオブジェクトの種類または名前を識別する GUID の省略可能なリストです。オブジェクトマネージャーが 1 つのオブジェクトクラスのみをサポートする場合、またはオブジェクトクラスに関連付けられた GUID が存在しない場合は、NULL にできます。
GuidCount	DWORD	in	pObjectClassGuids が指す GUID の数です。
pAcl	ACL*	in	オブジェクトの ACL です。
pfnArray	FN_OBJECT_MGR_FUNCTS*	inoptional	予約されています。このパラメーターには NULL を設定してください。
pGenericMapping	GENERIC_MAPPING*	in	オブジェクトに対する汎用的な権利から特定の権利へのマッピングです。
pInheritArray	INHERITED_FROMW*	out	GetInheritanceSource 関数が継承情報を格納する INHERITED_FROM 構造体の配列へのポインターです。呼び出し元は、ACL 内の各 ACE に対応するエントリを格納できる十分なメモリを割り当てる必要があります。

戻り値の型: WIN32_ERROR

公式ドキュメント

アクセス制御リスト (ACL) において継承されたアクセス制御エントリ (ACE) のソースに関する情報を返します。(Unicode)

戻り値

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

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

解説(Remarks)

GetInheritanceSource 関数は、INHERITED_FROM 構造体で返される名前のためにメモリを割り当てます。このメモリの使用が終了したら、呼び出し元のプログラムは FreeInheritedFromArray を呼び出してメモリを解放する必要があります。なお、配列そのもののメモリは呼び出し元が用意する必要があります。呼び出し元がそのメモリを割り当てた場合は、FreeInheritedFromArray の呼び出し後に呼び出し元がそのメモリを解放する必要があります。

この関数は競合状態を処理しません。あるスレッドがこの関数を呼び出すのとほぼ同時に別のスレッドがオブジェクトのセキュリティ記述子を変更した場合、この関数は失敗する可能性があります。

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 GetInheritanceSourceW(
    LPWSTR pObjectName,
    SE_OBJECT_TYPE ObjectType,
    OBJECT_SECURITY_INFORMATION SecurityInfo,
    BOOL Container,
    GUID** pObjectClassGuids,   // optional
    DWORD GuidCount,
    ACL* pAcl,
    FN_OBJECT_MGR_FUNCTS* pfnArray,   // optional
    GENERIC_MAPPING* pGenericMapping,
    INHERITED_FROMW* pInheritArray
);

[DllImport("ADVAPI32.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint GetInheritanceSourceW(
    [MarshalAs(UnmanagedType.LPWStr)] string pObjectName,   // LPWSTR
    int ObjectType,   // SE_OBJECT_TYPE
    uint SecurityInfo,   // OBJECT_SECURITY_INFORMATION
    bool Container,   // BOOL
    IntPtr pObjectClassGuids,   // GUID** optional
    uint GuidCount,   // DWORD
    IntPtr pAcl,   // ACL*
    IntPtr pfnArray,   // FN_OBJECT_MGR_FUNCTS* optional
    IntPtr pGenericMapping,   // GENERIC_MAPPING*
    IntPtr pInheritArray   // INHERITED_FROMW* out
);

<DllImport("ADVAPI32.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function GetInheritanceSourceW(
    <MarshalAs(UnmanagedType.LPWStr)> pObjectName As String,   ' LPWSTR
    ObjectType As Integer,   ' SE_OBJECT_TYPE
    SecurityInfo As UInteger,   ' OBJECT_SECURITY_INFORMATION
    Container As Boolean,   ' BOOL
    pObjectClassGuids As IntPtr,   ' GUID** optional
    GuidCount As UInteger,   ' DWORD
    pAcl As IntPtr,   ' ACL*
    pfnArray As IntPtr,   ' FN_OBJECT_MGR_FUNCTS* optional
    pGenericMapping As IntPtr,   ' GENERIC_MAPPING*
    pInheritArray As IntPtr   ' INHERITED_FROMW* out
) As UInteger
End Function

' pObjectName : LPWSTR
' ObjectType : SE_OBJECT_TYPE
' SecurityInfo : OBJECT_SECURITY_INFORMATION
' Container : BOOL
' pObjectClassGuids : GUID** optional
' GuidCount : DWORD
' pAcl : ACL*
' pfnArray : FN_OBJECT_MGR_FUNCTS* optional
' pGenericMapping : GENERIC_MAPPING*
' pInheritArray : INHERITED_FROMW* out
Declare PtrSafe Function GetInheritanceSourceW Lib "advapi32" ( _
    ByVal pObjectName As LongPtr, _
    ByVal ObjectType As Long, _
    ByVal SecurityInfo As Long, _
    ByVal Container As Long, _
    ByVal pObjectClassGuids As LongPtr, _
    ByVal GuidCount As Long, _
    ByVal pAcl As LongPtr, _
    ByVal pfnArray As LongPtr, _
    ByVal pGenericMapping As LongPtr, _
    ByVal pInheritArray 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

GetInheritanceSourceW = ctypes.windll.advapi32.GetInheritanceSourceW
GetInheritanceSourceW.restype = wintypes.DWORD
GetInheritanceSourceW.argtypes = [
    wintypes.LPCWSTR,  # pObjectName : LPWSTR
    ctypes.c_int,  # ObjectType : SE_OBJECT_TYPE
    wintypes.DWORD,  # SecurityInfo : OBJECT_SECURITY_INFORMATION
    wintypes.BOOL,  # Container : BOOL
    ctypes.c_void_p,  # pObjectClassGuids : GUID** optional
    wintypes.DWORD,  # GuidCount : DWORD
    ctypes.c_void_p,  # pAcl : ACL*
    ctypes.c_void_p,  # pfnArray : FN_OBJECT_MGR_FUNCTS* optional
    ctypes.c_void_p,  # pGenericMapping : GENERIC_MAPPING*
    ctypes.c_void_p,  # pInheritArray : INHERITED_FROMW* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
GetInheritanceSourceW = Fiddle::Function.new(
  lib['GetInheritanceSourceW'],
  [
    Fiddle::TYPE_VOIDP,  # pObjectName : LPWSTR
    Fiddle::TYPE_INT,  # ObjectType : SE_OBJECT_TYPE
    -Fiddle::TYPE_INT,  # SecurityInfo : OBJECT_SECURITY_INFORMATION
    Fiddle::TYPE_INT,  # Container : BOOL
    Fiddle::TYPE_VOIDP,  # pObjectClassGuids : GUID** optional
    -Fiddle::TYPE_INT,  # GuidCount : DWORD
    Fiddle::TYPE_VOIDP,  # pAcl : ACL*
    Fiddle::TYPE_VOIDP,  # pfnArray : FN_OBJECT_MGR_FUNCTS* optional
    Fiddle::TYPE_VOIDP,  # pGenericMapping : GENERIC_MAPPING*
    Fiddle::TYPE_VOIDP,  # pInheritArray : INHERITED_FROMW* out
  ],
  -Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "advapi32")]
extern "system" {
    fn GetInheritanceSourceW(
        pObjectName: *mut u16,  // LPWSTR
        ObjectType: i32,  // SE_OBJECT_TYPE
        SecurityInfo: u32,  // OBJECT_SECURITY_INFORMATION
        Container: i32,  // BOOL
        pObjectClassGuids: *mut *mut GUID,  // GUID** optional
        GuidCount: u32,  // DWORD
        pAcl: *mut ACL,  // ACL*
        pfnArray: *mut FN_OBJECT_MGR_FUNCTS,  // FN_OBJECT_MGR_FUNCTS* optional
        pGenericMapping: *mut GENERIC_MAPPING,  // GENERIC_MAPPING*
        pInheritArray: *mut INHERITED_FROMW  // INHERITED_FROMW* out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("ADVAPI32.dll", CharSet = CharSet.Unicode)]
public static extern uint GetInheritanceSourceW([MarshalAs(UnmanagedType.LPWStr)] string pObjectName, int ObjectType, uint SecurityInfo, bool Container, IntPtr pObjectClassGuids, uint GuidCount, IntPtr pAcl, IntPtr pfnArray, IntPtr pGenericMapping, IntPtr pInheritArray);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_GetInheritanceSourceW' -Namespace Win32 -PassThru
# $api::GetInheritanceSourceW(pObjectName, ObjectType, SecurityInfo, Container, pObjectClassGuids, GuidCount, pAcl, pfnArray, pGenericMapping, pInheritArray)

#uselib "ADVAPI32.dll"
#func global GetInheritanceSourceW "GetInheritanceSourceW" wptr, wptr, wptr, wptr, wptr, wptr, wptr, wptr, wptr, wptr
; GetInheritanceSourceW pObjectName, ObjectType, SecurityInfo, Container, varptr(pObjectClassGuids), GuidCount, varptr(pAcl), varptr(pfnArray), varptr(pGenericMapping), varptr(pInheritArray)   ; 戻り値は stat
; pObjectName : LPWSTR -> "wptr"
; ObjectType : SE_OBJECT_TYPE -> "wptr"
; SecurityInfo : OBJECT_SECURITY_INFORMATION -> "wptr"
; Container : BOOL -> "wptr"
; pObjectClassGuids : GUID** optional -> "wptr"
; GuidCount : DWORD -> "wptr"
; pAcl : ACL* -> "wptr"
; pfnArray : FN_OBJECT_MGR_FUNCTS* optional -> "wptr"
; pGenericMapping : GENERIC_MAPPING* -> "wptr"
; pInheritArray : INHERITED_FROMW* out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "ADVAPI32.dll"
#cfunc global GetInheritanceSourceW "GetInheritanceSourceW" wstr, int, int, int, var, int, var, var, var, var
; res = GetInheritanceSourceW(pObjectName, ObjectType, SecurityInfo, Container, pObjectClassGuids, GuidCount, pAcl, pfnArray, pGenericMapping, pInheritArray)
; pObjectName : LPWSTR -> "wstr"
; ObjectType : SE_OBJECT_TYPE -> "int"
; SecurityInfo : OBJECT_SECURITY_INFORMATION -> "int"
; Container : BOOL -> "int"
; pObjectClassGuids : GUID** optional -> "var"
; GuidCount : DWORD -> "int"
; pAcl : ACL* -> "var"
; pfnArray : FN_OBJECT_MGR_FUNCTS* optional -> "var"
; pGenericMapping : GENERIC_MAPPING* -> "var"
; pInheritArray : INHERITED_FROMW* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "ADVAPI32.dll"
#cfunc global GetInheritanceSourceW "GetInheritanceSourceW" wstr, int, int, int, sptr, int, sptr, sptr, sptr, sptr
; res = GetInheritanceSourceW(pObjectName, ObjectType, SecurityInfo, Container, varptr(pObjectClassGuids), GuidCount, varptr(pAcl), varptr(pfnArray), varptr(pGenericMapping), varptr(pInheritArray))
; pObjectName : LPWSTR -> "wstr"
; ObjectType : SE_OBJECT_TYPE -> "int"
; SecurityInfo : OBJECT_SECURITY_INFORMATION -> "int"
; Container : BOOL -> "int"
; pObjectClassGuids : GUID** optional -> "sptr"
; GuidCount : DWORD -> "int"
; pAcl : ACL* -> "sptr"
; pfnArray : FN_OBJECT_MGR_FUNCTS* optional -> "sptr"
; pGenericMapping : GENERIC_MAPPING* -> "sptr"
; pInheritArray : INHERITED_FROMW* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。