Win32 API 日本語リファレンス
ホームSecurity › SetFileSecurityW

SetFileSecurityW

関数
ファイルまたはディレクトリにセキュリティ記述子を設定する。
DLLADVAPI32.dll文字セットUnicode (-W)呼出規約winapi

シグネチャ

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

BOOL SetFileSecurityW(
    LPCWSTR lpFileName,
    OBJECT_SECURITY_INFORMATION SecurityInformation,
    PSECURITY_DESCRIPTOR pSecurityDescriptor
);

パラメーター

名前方向説明
lpFileNameLPCWSTRinセキュリティを設定するファイルまたはディレクトリを指定する、null で終わる文字列へのポインターです。ディレクトリに適用されたセキュリティは、その子オブジェクトには継承されない点に注意してください。
SecurityInformationOBJECT_SECURITY_INFORMATIONinpSecurityDescriptor パラメーターが指すセキュリティ記述子の内容を識別する SECURITY_INFORMATION 構造体を指定します。
pSecurityDescriptorPSECURITY_DESCRIPTORinSECURITY_DESCRIPTOR 構造体へのポインターです。

戻り値の型: BOOL

公式ドキュメント

SetFileSecurityW (Unicode) 関数 (securitybaseapi.h) は、ファイルまたはディレクトリ オブジェクトのセキュリティを設定します。

戻り値

関数が成功した場合は、0 以外の値を返します。

関数が失敗した場合は、0 を返します。拡張エラー情報を取得するには、GetLastError を呼び出します。

解説(Remarks)

SetFileSecurity 関数は、次の条件をすべて満たす場合にのみ成功します。

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

BOOL SetFileSecurityW(
    LPCWSTR lpFileName,
    OBJECT_SECURITY_INFORMATION SecurityInformation,
    PSECURITY_DESCRIPTOR pSecurityDescriptor
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern bool SetFileSecurityW(
    [MarshalAs(UnmanagedType.LPWStr)] string lpFileName,   // LPCWSTR
    uint SecurityInformation,   // OBJECT_SECURITY_INFORMATION
    IntPtr pSecurityDescriptor   // PSECURITY_DESCRIPTOR
);
<DllImport("ADVAPI32.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function SetFileSecurityW(
    <MarshalAs(UnmanagedType.LPWStr)> lpFileName As String,   ' LPCWSTR
    SecurityInformation As UInteger,   ' OBJECT_SECURITY_INFORMATION
    pSecurityDescriptor As IntPtr   ' PSECURITY_DESCRIPTOR
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' lpFileName : LPCWSTR
' SecurityInformation : OBJECT_SECURITY_INFORMATION
' pSecurityDescriptor : PSECURITY_DESCRIPTOR
Declare PtrSafe Function SetFileSecurityW Lib "advapi32" ( _
    ByVal lpFileName As LongPtr, _
    ByVal SecurityInformation As Long, _
    ByVal pSecurityDescriptor 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

SetFileSecurityW = ctypes.windll.advapi32.SetFileSecurityW
SetFileSecurityW.restype = wintypes.BOOL
SetFileSecurityW.argtypes = [
    wintypes.LPCWSTR,  # lpFileName : LPCWSTR
    wintypes.DWORD,  # SecurityInformation : OBJECT_SECURITY_INFORMATION
    wintypes.HANDLE,  # pSecurityDescriptor : PSECURITY_DESCRIPTOR
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
SetFileSecurityW = Fiddle::Function.new(
  lib['SetFileSecurityW'],
  [
    Fiddle::TYPE_VOIDP,  # lpFileName : LPCWSTR
    -Fiddle::TYPE_INT,  # SecurityInformation : OBJECT_SECURITY_INFORMATION
    Fiddle::TYPE_VOIDP,  # pSecurityDescriptor : PSECURITY_DESCRIPTOR
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "advapi32")]
extern "system" {
    fn SetFileSecurityW(
        lpFileName: *const u16,  // LPCWSTR
        SecurityInformation: u32,  // OBJECT_SECURITY_INFORMATION
        pSecurityDescriptor: *mut core::ffi::c_void  // PSECURITY_DESCRIPTOR
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", CharSet = CharSet.Unicode)]
public static extern bool SetFileSecurityW([MarshalAs(UnmanagedType.LPWStr)] string lpFileName, uint SecurityInformation, IntPtr pSecurityDescriptor);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_SetFileSecurityW' -Namespace Win32 -PassThru
# $api::SetFileSecurityW(lpFileName, SecurityInformation, pSecurityDescriptor)
#uselib "ADVAPI32.dll"
#func global SetFileSecurityW "SetFileSecurityW" wptr, wptr, wptr
; SetFileSecurityW lpFileName, SecurityInformation, pSecurityDescriptor   ; 戻り値は stat
; lpFileName : LPCWSTR -> "wptr"
; SecurityInformation : OBJECT_SECURITY_INFORMATION -> "wptr"
; pSecurityDescriptor : PSECURITY_DESCRIPTOR -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "ADVAPI32.dll"
#cfunc global SetFileSecurityW "SetFileSecurityW" wstr, int, sptr
; res = SetFileSecurityW(lpFileName, SecurityInformation, pSecurityDescriptor)
; lpFileName : LPCWSTR -> "wstr"
; SecurityInformation : OBJECT_SECURITY_INFORMATION -> "int"
; pSecurityDescriptor : PSECURITY_DESCRIPTOR -> "sptr"
; BOOL SetFileSecurityW(LPCWSTR lpFileName, OBJECT_SECURITY_INFORMATION SecurityInformation, PSECURITY_DESCRIPTOR pSecurityDescriptor)
#uselib "ADVAPI32.dll"
#cfunc global SetFileSecurityW "SetFileSecurityW" wstr, int, intptr
; res = SetFileSecurityW(lpFileName, SecurityInformation, pSecurityDescriptor)
; lpFileName : LPCWSTR -> "wstr"
; SecurityInformation : OBJECT_SECURITY_INFORMATION -> "int"
; pSecurityDescriptor : PSECURITY_DESCRIPTOR -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	advapi32 = windows.NewLazySystemDLL("ADVAPI32.dll")
	procSetFileSecurityW = advapi32.NewProc("SetFileSecurityW")
)

// lpFileName (LPCWSTR), SecurityInformation (OBJECT_SECURITY_INFORMATION), pSecurityDescriptor (PSECURITY_DESCRIPTOR)
r1, _, err := procSetFileSecurityW.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpFileName))),
	uintptr(SecurityInformation),
	uintptr(pSecurityDescriptor),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function SetFileSecurityW(
  lpFileName: PWideChar;   // LPCWSTR
  SecurityInformation: DWORD;   // OBJECT_SECURITY_INFORMATION
  pSecurityDescriptor: THandle   // PSECURITY_DESCRIPTOR
): BOOL; stdcall;
  external 'ADVAPI32.dll' name 'SetFileSecurityW';
result := DllCall("ADVAPI32\SetFileSecurityW"
    , "WStr", lpFileName   ; LPCWSTR
    , "UInt", SecurityInformation   ; OBJECT_SECURITY_INFORMATION
    , "Ptr", pSecurityDescriptor   ; PSECURITY_DESCRIPTOR
    , "Int")   ; return: BOOL
●SetFileSecurityW(lpFileName, SecurityInformation, pSecurityDescriptor) = DLL("ADVAPI32.dll", "bool SetFileSecurityW(char*, dword, void*)")
# 呼び出し: SetFileSecurityW(lpFileName, SecurityInformation, pSecurityDescriptor)
# lpFileName : LPCWSTR -> "char*"
# SecurityInformation : OBJECT_SECURITY_INFORMATION -> "dword"
# pSecurityDescriptor : PSECURITY_DESCRIPTOR -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "advapi32" fn SetFileSecurityW(
    lpFileName: [*c]const u16, // LPCWSTR
    SecurityInformation: u32, // OBJECT_SECURITY_INFORMATION
    pSecurityDescriptor: ?*anyopaque // PSECURITY_DESCRIPTOR
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc SetFileSecurityW(
    lpFileName: WideCString,  # LPCWSTR
    SecurityInformation: uint32,  # OBJECT_SECURITY_INFORMATION
    pSecurityDescriptor: pointer  # PSECURITY_DESCRIPTOR
): int32 {.importc: "SetFileSecurityW", stdcall, dynlib: "ADVAPI32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "advapi32");
extern(Windows)
int SetFileSecurityW(
    const(wchar)* lpFileName,   // LPCWSTR
    uint SecurityInformation,   // OBJECT_SECURITY_INFORMATION
    void* pSecurityDescriptor   // PSECURITY_DESCRIPTOR
);
ccall((:SetFileSecurityW, "ADVAPI32.dll"), stdcall, Int32,
      (Cwstring, UInt32, Ptr{Cvoid}),
      lpFileName, SecurityInformation, pSecurityDescriptor)
# lpFileName : LPCWSTR -> Cwstring
# SecurityInformation : OBJECT_SECURITY_INFORMATION -> UInt32
# pSecurityDescriptor : PSECURITY_DESCRIPTOR -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t SetFileSecurityW(
    const uint16_t* lpFileName,
    uint32_t SecurityInformation,
    void* pSecurityDescriptor);
]]
local advapi32 = ffi.load("advapi32")
-- advapi32.SetFileSecurityW(lpFileName, SecurityInformation, pSecurityDescriptor)
-- lpFileName : LPCWSTR
-- SecurityInformation : OBJECT_SECURITY_INFORMATION
-- pSecurityDescriptor : PSECURITY_DESCRIPTOR
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('ADVAPI32.dll');
const SetFileSecurityW = lib.func('__stdcall', 'SetFileSecurityW', 'int32_t', ['str16', 'uint32_t', 'void *']);
// SetFileSecurityW(lpFileName, SecurityInformation, pSecurityDescriptor)
// lpFileName : LPCWSTR -> 'str16'
// SecurityInformation : OBJECT_SECURITY_INFORMATION -> 'uint32_t'
// pSecurityDescriptor : PSECURITY_DESCRIPTOR -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("ADVAPI32.dll", {
  SetFileSecurityW: { parameters: ["buffer", "u32", "pointer"], result: "i32" },
});
// lib.symbols.SetFileSecurityW(lpFileName, SecurityInformation, pSecurityDescriptor)
// lpFileName : LPCWSTR -> "buffer"
// SecurityInformation : OBJECT_SECURITY_INFORMATION -> "u32"
// pSecurityDescriptor : PSECURITY_DESCRIPTOR -> "pointer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t SetFileSecurityW(
    const uint16_t* lpFileName,
    uint32_t SecurityInformation,
    void* pSecurityDescriptor);
C, "ADVAPI32.dll");
// $ffi->SetFileSecurityW(lpFileName, SecurityInformation, pSecurityDescriptor);
// lpFileName : LPCWSTR
// SecurityInformation : OBJECT_SECURITY_INFORMATION
// pSecurityDescriptor : PSECURITY_DESCRIPTOR
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Advapi32 extends StdCallLibrary {
    Advapi32 INSTANCE = Native.load("advapi32", Advapi32.class, W32APIOptions.UNICODE_OPTIONS);
    boolean SetFileSecurityW(
        WString lpFileName,   // LPCWSTR
        int SecurityInformation,   // OBJECT_SECURITY_INFORMATION
        Pointer pSecurityDescriptor   // PSECURITY_DESCRIPTOR
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("advapi32")]
lib LibADVAPI32
  fun SetFileSecurityW = SetFileSecurityW(
    lpFileName : UInt16*,   # LPCWSTR
    SecurityInformation : UInt32,   # OBJECT_SECURITY_INFORMATION
    pSecurityDescriptor : Void*   # PSECURITY_DESCRIPTOR
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef SetFileSecurityWNative = Int32 Function(Pointer<Utf16>, Uint32, Pointer<Void>);
typedef SetFileSecurityWDart = int Function(Pointer<Utf16>, int, Pointer<Void>);
final SetFileSecurityW = DynamicLibrary.open('ADVAPI32.dll')
    .lookupFunction<SetFileSecurityWNative, SetFileSecurityWDart>('SetFileSecurityW');
// lpFileName : LPCWSTR -> Pointer<Utf16>
// SecurityInformation : OBJECT_SECURITY_INFORMATION -> Uint32
// pSecurityDescriptor : PSECURITY_DESCRIPTOR -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SetFileSecurityW(
  lpFileName: PWideChar;   // LPCWSTR
  SecurityInformation: DWORD;   // OBJECT_SECURITY_INFORMATION
  pSecurityDescriptor: THandle   // PSECURITY_DESCRIPTOR
): BOOL; stdcall;
  external 'ADVAPI32.dll' name 'SetFileSecurityW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SetFileSecurityW"
  c_SetFileSecurityW :: CWString -> Word32 -> Ptr () -> IO CInt
-- lpFileName : LPCWSTR -> CWString
-- SecurityInformation : OBJECT_SECURITY_INFORMATION -> Word32
-- pSecurityDescriptor : PSECURITY_DESCRIPTOR -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let setfilesecurityw =
  foreign "SetFileSecurityW"
    ((ptr uint16_t) @-> uint32_t @-> (ptr void) @-> returning int32_t)
(* lpFileName : LPCWSTR -> (ptr uint16_t) *)
(* SecurityInformation : OBJECT_SECURITY_INFORMATION -> uint32_t *)
(* pSecurityDescriptor : PSECURITY_DESCRIPTOR -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library advapi32 (t "ADVAPI32.dll"))
(cffi:use-foreign-library advapi32)

(cffi:defcfun ("SetFileSecurityW" set-file-security-w :convention :stdcall) :int32
  (lp-file-name (:string :encoding :utf-16le))   ; LPCWSTR
  (security-information :uint32)   ; OBJECT_SECURITY_INFORMATION
  (p-security-descriptor :pointer))   ; PSECURITY_DESCRIPTOR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SetFileSecurityW = Win32::API::More->new('ADVAPI32',
    'BOOL SetFileSecurityW(LPCWSTR lpFileName, DWORD SecurityInformation, HANDLE pSecurityDescriptor)');
# my $ret = $SetFileSecurityW->Call($lpFileName, $SecurityInformation, $pSecurityDescriptor);
# lpFileName : LPCWSTR -> LPCWSTR
# SecurityInformation : OBJECT_SECURITY_INFORMATION -> DWORD
# pSecurityDescriptor : PSECURITY_DESCRIPTOR -> HANDLE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い
公式の関連項目
使用する型