ホーム › Security.Authorization › TreeResetNamedSecurityInfoA

TreeResetNamedSecurityInfoA

関数

オブジェクトツリーのセキュリティ情報を再設定する(ANSI版)。

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

シグネチャ

// ADVAPI32.dll  (ANSI / -A)
#include <windows.h>

WIN32_ERROR TreeResetNamedSecurityInfoA(
    LPSTR pObjectName,
    SE_OBJECT_TYPE ObjectType,
    OBJECT_SECURITY_INFORMATION SecurityInfo,
    PSID pOwner,   // optional
    PSID pGroup,   // optional
    ACL* pDacl,   // optional
    ACL* pSacl,   // optional
    BOOL KeepExplicit,
    FN_PROGRESS fnProgress,   // optional
    PROG_INVOKE_SETTING ProgressInvokeSetting,
    void* Args   // optional
);

パラメーター

名前	型	方向	説明
pObjectName	LPSTR	in	更新されたセキュリティ情報を受け取るオブジェクトのルートノードオブジェクト名を指定する、null で終わる文字列へのポインターです。サポートされるオブジェクトはレジストリキーとファイルオブジェクトです。各オブジェクト種別の文字列形式の説明については、 SE_OBJECT_TYPE を参照してください。
ObjectType	SE_OBJECT_TYPE	in	pObjectName パラメーターで指定されたオブジェクトの種類を示す、SE_OBJECT_TYPE 列挙体の値です。サポートされる値は、レジストリキーを表す SE_REGISTRY_KEY と、ファイルオブジェクトを表す SE_FILE_OBJECT です。
SecurityInfo	OBJECT_SECURITY_INFORMATION	in	リセットするセキュリティ情報の種類を示すビットフラグのセットです。このパラメーターには、 SECURITY_INFORMATION ビットフラグの組み合わせを指定できます。
pOwner	PSID	inoptional	オブジェクトの所有者を識別する SID 構造体へのポインターです。この SID は、セキュリティ記述子の所有者 SID として割り当て可能なものでなければなりません。SecurityInfo パラメーターには OWNER_SECURITY_INFORMATION フラグを含める必要があります。所有者を設定するには、呼び出し元はルートオブジェクトを含む各オブジェクトに対して WRITE_OWNER アクセス権を持っている必要があります。所有者 SID を設定しない場合、このパラメーターは NULL にできます。
pGroup	PSID	inoptional	オブジェクトのプライマリグループを識別する SID 構造体へのポインターです。SecurityInfo パラメーターには GROUP_SECURITY_INFORMATION フラグを含める必要があります。グループを設定するには、呼び出し元はルートオブジェクトを含む各オブジェクトに対して WRITE_OWNER アクセス権を持っている必要があります。プライマリグループ SID を設定しない場合、このパラメーターは NULL にできます。
pDacl	ACL*	inoptional	リセット対象のオブジェクトの新しい DACL を表すアクセス制御リスト (ACL) 構造体へのポインターです。SecurityInfo パラメーターには DACL_SECURITY_INFORMATION フラグを含める必要があります。呼び出し元はルートオブジェクトを含む各オブジェクトに対して READ_CONTROL および WRITE_DAC アクセス権を持っている必要があります。DACL を設定しない場合、このパラメーターは NULL にできます。
pSacl	ACL*	inoptional	リセット対象のオブジェクトの新しい SACL を表す ACL 構造体へのポインターです。SecurityInfo パラメーターには、SACL_SECURITY_INFORMATION、LABEL_SECURITY_INFORMATION、ATTRIBUTE_SECURITY_INFORMATION、SCOPE_SECURITY_INFORMATION、BACKUP_SECURITY_INFORMATION のいずれかのフラグを含める必要があります。SACL_SECURITY_INFORMATION または SCOPE_SECURITY_INFORMATION を設定する場合、呼び出し元は SE_SECURITY_NAME 特権を有効にしている必要があります。SACL を設定しない場合、このパラメーターは NULL にできます。
KeepExplicit	BOOL	in	サブツリーに対して明示的に定義された ACE を保持するか削除するかを定義するブール値です。KeepExplicit が TRUE の場合、各サブツリーの DACL と SACL について明示的に定義された ACE は保持され、継承された ACE は pDacl と pSacl からの継承 ACE で置き換えられます。KeepExplicit が FALSE の場合、各サブツリーの DACL と SACL について明示的に定義された ACE は削除されてから、継承された ACE が pDacl と pSacl からの継承 ACE で置き換えられます。
fnProgress	FN_PROGRESS	inoptional	TreeResetNamedSecurityInfo 関数の進行状況を追跡するために使用される関数へのポインターです。進行状況関数のプロトタイプは次のとおりです。 `#include <windows.h> #include <Aclapi.h> typedef VOID (FN_PROGRESS) ( IN LPWSTR pObjectName, // Name of object just processed IN DWORD Status, // Status of operation on object IN OUT PPROG_INVOKE_SETTING pInvokeSetting, // When to set IN PVOID Args, // Caller specific data IN BOOL SecuritySet // Whether security was set );` 進行状況関数は、ノードが処理される際に呼び出し元へ進行状況とエラー情報を提供します。呼び出し元は fnProgress* に進行状況関数を指定し、ツリー操作中に TreeResetNamedSecurityInfo は最後に処理されたオブジェクト名、その操作のエラー状態、および現在の PROG_INVOKE_SETTING 値を渡します。呼び出し元は pInvokeSetting を使用して PROG_INVOKE_SETTING 値を変更できます。進行状況関数を使用しない場合は、このパラメーターを NULL に設定します。
ProgressInvokeSetting	PROG_INVOKE_SETTING	in	進行状況関数の初期設定を指定する PROG_INVOKE_SETTING 列挙体の値です。
Args	void*	inoptional	呼び出し元が指定する進行状況関数の引数となる VOID へのポインターです。

戻り値の型: WIN32_ERROR

公式ドキュメント

指定したオブジェクトツリーのセキュリティ記述子内の、指定したセキュリティ情報をリセットします。(ANSI)

戻り値

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

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

解説(Remarks)

この関数では、所有者、グループ、DACL、SACL に NULL を設定することはサポートされていません。

呼び出し元が、要求された所有者、グループ、DACL、SACL の更新をサポートする適切な特権と権限を持っていない場合、いずれの更新も実行されません。

この関数は TreeSetNamedSecurityInfo 関数に似ています。

TreeResetNamedSecurityInfo の KeepExplicit パラメーターが TRUE に設定されている場合、この関数は dwAction パラメーターを TREE_SEC_INFO_RESET_KEEP_EXPLICIT に設定した TreeSetNamedSecurityInfo と同等です。
TreeResetNamedSecurityInfo の KeepExplicit パラメーターが FALSE に設定されている場合、この関数は dwAction パラメーターを TREE_SEC_INFO_RESET に設定した TreeSetNamedSecurityInfo と同等です。

メモ

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

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

各言語での呼び出し定義

// ADVAPI32.dll  (ANSI / -A)
#include <windows.h>

WIN32_ERROR TreeResetNamedSecurityInfoA(
    LPSTR pObjectName,
    SE_OBJECT_TYPE ObjectType,
    OBJECT_SECURITY_INFORMATION SecurityInfo,
    PSID pOwner,   // optional
    PSID pGroup,   // optional
    ACL* pDacl,   // optional
    ACL* pSacl,   // optional
    BOOL KeepExplicit,
    FN_PROGRESS fnProgress,   // optional
    PROG_INVOKE_SETTING ProgressInvokeSetting,
    void* Args   // optional
);

[DllImport("ADVAPI32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint TreeResetNamedSecurityInfoA(
    [MarshalAs(UnmanagedType.LPStr)] string pObjectName,   // LPSTR
    int ObjectType,   // SE_OBJECT_TYPE
    uint SecurityInfo,   // OBJECT_SECURITY_INFORMATION
    IntPtr pOwner,   // PSID optional
    IntPtr pGroup,   // PSID optional
    IntPtr pDacl,   // ACL* optional
    IntPtr pSacl,   // ACL* optional
    bool KeepExplicit,   // BOOL
    IntPtr fnProgress,   // FN_PROGRESS optional
    int ProgressInvokeSetting,   // PROG_INVOKE_SETTING
    IntPtr Args   // void* optional
);

<DllImport("ADVAPI32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function TreeResetNamedSecurityInfoA(
    <MarshalAs(UnmanagedType.LPStr)> pObjectName As String,   ' LPSTR
    ObjectType As Integer,   ' SE_OBJECT_TYPE
    SecurityInfo As UInteger,   ' OBJECT_SECURITY_INFORMATION
    pOwner As IntPtr,   ' PSID optional
    pGroup As IntPtr,   ' PSID optional
    pDacl As IntPtr,   ' ACL* optional
    pSacl As IntPtr,   ' ACL* optional
    KeepExplicit As Boolean,   ' BOOL
    fnProgress As IntPtr,   ' FN_PROGRESS optional
    ProgressInvokeSetting As Integer,   ' PROG_INVOKE_SETTING
    Args As IntPtr   ' void* optional
) As UInteger
End Function

' pObjectName : LPSTR
' ObjectType : SE_OBJECT_TYPE
' SecurityInfo : OBJECT_SECURITY_INFORMATION
' pOwner : PSID optional
' pGroup : PSID optional
' pDacl : ACL* optional
' pSacl : ACL* optional
' KeepExplicit : BOOL
' fnProgress : FN_PROGRESS optional
' ProgressInvokeSetting : PROG_INVOKE_SETTING
' Args : void* optional
Declare PtrSafe Function TreeResetNamedSecurityInfoA Lib "advapi32" ( _
    ByVal pObjectName As String, _
    ByVal ObjectType As Long, _
    ByVal SecurityInfo As Long, _
    ByVal pOwner As LongPtr, _
    ByVal pGroup As LongPtr, _
    ByVal pDacl As LongPtr, _
    ByVal pSacl As LongPtr, _
    ByVal KeepExplicit As Long, _
    ByVal fnProgress As LongPtr, _
    ByVal ProgressInvokeSetting As Long, _
    ByVal Args As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

TreeResetNamedSecurityInfoA = ctypes.windll.advapi32.TreeResetNamedSecurityInfoA
TreeResetNamedSecurityInfoA.restype = wintypes.DWORD
TreeResetNamedSecurityInfoA.argtypes = [
    wintypes.LPCSTR,  # pObjectName : LPSTR
    ctypes.c_int,  # ObjectType : SE_OBJECT_TYPE
    wintypes.DWORD,  # SecurityInfo : OBJECT_SECURITY_INFORMATION
    wintypes.HANDLE,  # pOwner : PSID optional
    wintypes.HANDLE,  # pGroup : PSID optional
    ctypes.c_void_p,  # pDacl : ACL* optional
    ctypes.c_void_p,  # pSacl : ACL* optional
    wintypes.BOOL,  # KeepExplicit : BOOL
    ctypes.c_void_p,  # fnProgress : FN_PROGRESS optional
    ctypes.c_int,  # ProgressInvokeSetting : PROG_INVOKE_SETTING
    ctypes.POINTER(None),  # Args : void* optional
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
TreeResetNamedSecurityInfoA = Fiddle::Function.new(
  lib['TreeResetNamedSecurityInfoA'],
  [
    Fiddle::TYPE_VOIDP,  # pObjectName : LPSTR
    Fiddle::TYPE_INT,  # ObjectType : SE_OBJECT_TYPE
    -Fiddle::TYPE_INT,  # SecurityInfo : OBJECT_SECURITY_INFORMATION
    Fiddle::TYPE_VOIDP,  # pOwner : PSID optional
    Fiddle::TYPE_VOIDP,  # pGroup : PSID optional
    Fiddle::TYPE_VOIDP,  # pDacl : ACL* optional
    Fiddle::TYPE_VOIDP,  # pSacl : ACL* optional
    Fiddle::TYPE_INT,  # KeepExplicit : BOOL
    Fiddle::TYPE_VOIDP,  # fnProgress : FN_PROGRESS optional
    Fiddle::TYPE_INT,  # ProgressInvokeSetting : PROG_INVOKE_SETTING
    Fiddle::TYPE_VOIDP,  # Args : void* optional
  ],
  -Fiddle::TYPE_INT)

#[link(name = "advapi32")]
extern "system" {
    fn TreeResetNamedSecurityInfoA(
        pObjectName: *mut u8,  // LPSTR
        ObjectType: i32,  // SE_OBJECT_TYPE
        SecurityInfo: u32,  // OBJECT_SECURITY_INFORMATION
        pOwner: *mut core::ffi::c_void,  // PSID optional
        pGroup: *mut core::ffi::c_void,  // PSID optional
        pDacl: *mut ACL,  // ACL* optional
        pSacl: *mut ACL,  // ACL* optional
        KeepExplicit: i32,  // BOOL
        fnProgress: *const core::ffi::c_void,  // FN_PROGRESS optional
        ProgressInvokeSetting: i32,  // PROG_INVOKE_SETTING
        Args: *mut ()  // void* optional
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("ADVAPI32.dll", CharSet = CharSet.Ansi)]
public static extern uint TreeResetNamedSecurityInfoA([MarshalAs(UnmanagedType.LPStr)] string pObjectName, int ObjectType, uint SecurityInfo, IntPtr pOwner, IntPtr pGroup, IntPtr pDacl, IntPtr pSacl, bool KeepExplicit, IntPtr fnProgress, int ProgressInvokeSetting, IntPtr Args);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_TreeResetNamedSecurityInfoA' -Namespace Win32 -PassThru
# $api::TreeResetNamedSecurityInfoA(pObjectName, ObjectType, SecurityInfo, pOwner, pGroup, pDacl, pSacl, KeepExplicit, fnProgress, ProgressInvokeSetting, Args)

#uselib "ADVAPI32.dll"
#func global TreeResetNamedSecurityInfoA "TreeResetNamedSecurityInfoA" sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr
; TreeResetNamedSecurityInfoA pObjectName, ObjectType, SecurityInfo, pOwner, pGroup, varptr(pDacl), varptr(pSacl), KeepExplicit, fnProgress, ProgressInvokeSetting, Args   ; 戻り値は stat
; pObjectName : LPSTR -> "sptr"
; ObjectType : SE_OBJECT_TYPE -> "sptr"
; SecurityInfo : OBJECT_SECURITY_INFORMATION -> "sptr"
; pOwner : PSID optional -> "sptr"
; pGroup : PSID optional -> "sptr"
; pDacl : ACL* optional -> "sptr"
; pSacl : ACL* optional -> "sptr"
; KeepExplicit : BOOL -> "sptr"
; fnProgress : FN_PROGRESS optional -> "sptr"
; ProgressInvokeSetting : PROG_INVOKE_SETTING -> "sptr"
; Args : void* optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "ADVAPI32.dll"
#cfunc global TreeResetNamedSecurityInfoA "TreeResetNamedSecurityInfoA" str, int, int, sptr, sptr, var, var, int, sptr, int, sptr
; res = TreeResetNamedSecurityInfoA(pObjectName, ObjectType, SecurityInfo, pOwner, pGroup, pDacl, pSacl, KeepExplicit, fnProgress, ProgressInvokeSetting, Args)
; pObjectName : LPSTR -> "str"
; ObjectType : SE_OBJECT_TYPE -> "int"
; SecurityInfo : OBJECT_SECURITY_INFORMATION -> "int"
; pOwner : PSID optional -> "sptr"
; pGroup : PSID optional -> "sptr"
; pDacl : ACL* optional -> "var"
; pSacl : ACL* optional -> "var"
; KeepExplicit : BOOL -> "int"
; fnProgress : FN_PROGRESS optional -> "sptr"
; ProgressInvokeSetting : PROG_INVOKE_SETTING -> "int"
; Args : void* optional -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "ADVAPI32.dll"
#cfunc global TreeResetNamedSecurityInfoA "TreeResetNamedSecurityInfoA" str, int, int, sptr, sptr, sptr, sptr, int, sptr, int, sptr
; res = TreeResetNamedSecurityInfoA(pObjectName, ObjectType, SecurityInfo, pOwner, pGroup, varptr(pDacl), varptr(pSacl), KeepExplicit, fnProgress, ProgressInvokeSetting, Args)
; pObjectName : LPSTR -> "str"
; ObjectType : SE_OBJECT_TYPE -> "int"
; SecurityInfo : OBJECT_SECURITY_INFORMATION -> "int"
; pOwner : PSID optional -> "sptr"
; pGroup : PSID optional -> "sptr"
; pDacl : ACL* optional -> "sptr"
; pSacl : ACL* optional -> "sptr"
; KeepExplicit : BOOL -> "int"
; fnProgress : FN_PROGRESS optional -> "sptr"
; ProgressInvokeSetting : PROG_INVOKE_SETTING -> "int"
; Args : void* optional -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。