Win32 API 日本語リファレンス
ホームSystem.Registry › RegSetKeySecurity

RegSetKeySecurity

関数
指定したレジストリキーのセキュリティ記述子を設定する。
DLLADVAPI32.dll呼出規約winapi対応OSWindows XP 以降

シグネチャ

// ADVAPI32.dll
#include <windows.h>

WIN32_ERROR RegSetKeySecurity(
    HKEY hKey,
    OBJECT_SECURITY_INFORMATION SecurityInformation,
    PSECURITY_DESCRIPTOR pSecurityDescriptor
);

パラメーター

名前方向説明
hKeyHKEYinセキュリティ記述子を設定する対象の、開いているキーへのハンドル。
SecurityInformationOBJECT_SECURITY_INFORMATIONin設定するセキュリティ情報の種類を示すビットフラグのセット。このパラメーターには、SECURITY_INFORMATION ビットフラグの組み合わせを指定できます。
pSecurityDescriptorPSECURITY_DESCRIPTORin指定したキーに設定するセキュリティ属性を指定する SECURITY_DESCRIPTOR 構造体へのポインター。

戻り値の型: WIN32_ERROR

公式ドキュメント

開いているレジストリキーのセキュリティを設定します。

戻り値

関数が成功すると、ERROR_SUCCESS を返します。

関数が失敗すると、WinError.h で定義されているゼロ以外のエラーコードを返します。FormatMessage 関数を FORMAT_MESSAGE_FROM_SYSTEM フラグとともに使用すると、エラーの一般的な説明を取得できます。

解説(Remarks)

hKey が定義済みキーのいずれかである場合は、RegCloseKey 関数を使用して定義済みキーを閉じ、次回その定義済みキーが参照されるときに新しいセキュリティ情報が有効になるようにしてください。

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

各言語での呼び出し定義

// ADVAPI32.dll
#include <windows.h>

WIN32_ERROR RegSetKeySecurity(
    HKEY hKey,
    OBJECT_SECURITY_INFORMATION SecurityInformation,
    PSECURITY_DESCRIPTOR pSecurityDescriptor
);
[DllImport("ADVAPI32.dll", ExactSpelling = true)]
static extern uint RegSetKeySecurity(
    IntPtr hKey,   // HKEY
    uint SecurityInformation,   // OBJECT_SECURITY_INFORMATION
    IntPtr pSecurityDescriptor   // PSECURITY_DESCRIPTOR
);
<DllImport("ADVAPI32.dll", ExactSpelling:=True)>
Public Shared Function RegSetKeySecurity(
    hKey As IntPtr,   ' HKEY
    SecurityInformation As UInteger,   ' OBJECT_SECURITY_INFORMATION
    pSecurityDescriptor As IntPtr   ' PSECURITY_DESCRIPTOR
) As UInteger
End Function
' hKey : HKEY
' SecurityInformation : OBJECT_SECURITY_INFORMATION
' pSecurityDescriptor : PSECURITY_DESCRIPTOR
Declare PtrSafe Function RegSetKeySecurity Lib "advapi32" ( _
    ByVal hKey As LongPtr, _
    ByVal SecurityInformation As Long, _
    ByVal pSecurityDescriptor As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

RegSetKeySecurity = ctypes.windll.advapi32.RegSetKeySecurity
RegSetKeySecurity.restype = wintypes.DWORD
RegSetKeySecurity.argtypes = [
    wintypes.HANDLE,  # hKey : HKEY
    wintypes.DWORD,  # SecurityInformation : OBJECT_SECURITY_INFORMATION
    wintypes.HANDLE,  # pSecurityDescriptor : PSECURITY_DESCRIPTOR
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
RegSetKeySecurity = Fiddle::Function.new(
  lib['RegSetKeySecurity'],
  [
    Fiddle::TYPE_VOIDP,  # hKey : HKEY
    -Fiddle::TYPE_INT,  # SecurityInformation : OBJECT_SECURITY_INFORMATION
    Fiddle::TYPE_VOIDP,  # pSecurityDescriptor : PSECURITY_DESCRIPTOR
  ],
  -Fiddle::TYPE_INT)
#[link(name = "advapi32")]
extern "system" {
    fn RegSetKeySecurity(
        hKey: *mut core::ffi::c_void,  // HKEY
        SecurityInformation: u32,  // OBJECT_SECURITY_INFORMATION
        pSecurityDescriptor: *mut core::ffi::c_void  // PSECURITY_DESCRIPTOR
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("ADVAPI32.dll")]
public static extern uint RegSetKeySecurity(IntPtr hKey, uint SecurityInformation, IntPtr pSecurityDescriptor);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_RegSetKeySecurity' -Namespace Win32 -PassThru
# $api::RegSetKeySecurity(hKey, SecurityInformation, pSecurityDescriptor)
#uselib "ADVAPI32.dll"
#func global RegSetKeySecurity "RegSetKeySecurity" sptr, sptr, sptr
; RegSetKeySecurity hKey, SecurityInformation, pSecurityDescriptor   ; 戻り値は stat
; hKey : HKEY -> "sptr"
; SecurityInformation : OBJECT_SECURITY_INFORMATION -> "sptr"
; pSecurityDescriptor : PSECURITY_DESCRIPTOR -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "ADVAPI32.dll"
#cfunc global RegSetKeySecurity "RegSetKeySecurity" sptr, int, sptr
; res = RegSetKeySecurity(hKey, SecurityInformation, pSecurityDescriptor)
; hKey : HKEY -> "sptr"
; SecurityInformation : OBJECT_SECURITY_INFORMATION -> "int"
; pSecurityDescriptor : PSECURITY_DESCRIPTOR -> "sptr"
; WIN32_ERROR RegSetKeySecurity(HKEY hKey, OBJECT_SECURITY_INFORMATION SecurityInformation, PSECURITY_DESCRIPTOR pSecurityDescriptor)
#uselib "ADVAPI32.dll"
#cfunc global RegSetKeySecurity "RegSetKeySecurity" intptr, int, intptr
; res = RegSetKeySecurity(hKey, SecurityInformation, pSecurityDescriptor)
; hKey : HKEY -> "intptr"
; SecurityInformation : OBJECT_SECURITY_INFORMATION -> "int"
; pSecurityDescriptor : PSECURITY_DESCRIPTOR -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	advapi32 = windows.NewLazySystemDLL("ADVAPI32.dll")
	procRegSetKeySecurity = advapi32.NewProc("RegSetKeySecurity")
)

// hKey (HKEY), SecurityInformation (OBJECT_SECURITY_INFORMATION), pSecurityDescriptor (PSECURITY_DESCRIPTOR)
r1, _, err := procRegSetKeySecurity.Call(
	uintptr(hKey),
	uintptr(SecurityInformation),
	uintptr(pSecurityDescriptor),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // WIN32_ERROR
function RegSetKeySecurity(
  hKey: THandle;   // HKEY
  SecurityInformation: DWORD;   // OBJECT_SECURITY_INFORMATION
  pSecurityDescriptor: THandle   // PSECURITY_DESCRIPTOR
): DWORD; stdcall;
  external 'ADVAPI32.dll' name 'RegSetKeySecurity';
result := DllCall("ADVAPI32\RegSetKeySecurity"
    , "Ptr", hKey   ; HKEY
    , "UInt", SecurityInformation   ; OBJECT_SECURITY_INFORMATION
    , "Ptr", pSecurityDescriptor   ; PSECURITY_DESCRIPTOR
    , "UInt")   ; return: WIN32_ERROR
●RegSetKeySecurity(hKey, SecurityInformation, pSecurityDescriptor) = DLL("ADVAPI32.dll", "dword RegSetKeySecurity(void*, dword, void*)")
# 呼び出し: RegSetKeySecurity(hKey, SecurityInformation, pSecurityDescriptor)
# hKey : HKEY -> "void*"
# SecurityInformation : OBJECT_SECURITY_INFORMATION -> "dword"
# pSecurityDescriptor : PSECURITY_DESCRIPTOR -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "advapi32" fn RegSetKeySecurity(
    hKey: ?*anyopaque, // HKEY
    SecurityInformation: u32, // OBJECT_SECURITY_INFORMATION
    pSecurityDescriptor: ?*anyopaque // PSECURITY_DESCRIPTOR
) callconv(std.os.windows.WINAPI) u32;
proc RegSetKeySecurity(
    hKey: pointer,  # HKEY
    SecurityInformation: uint32,  # OBJECT_SECURITY_INFORMATION
    pSecurityDescriptor: pointer  # PSECURITY_DESCRIPTOR
): uint32 {.importc: "RegSetKeySecurity", stdcall, dynlib: "ADVAPI32.dll".}
pragma(lib, "advapi32");
extern(Windows)
uint RegSetKeySecurity(
    void* hKey,   // HKEY
    uint SecurityInformation,   // OBJECT_SECURITY_INFORMATION
    void* pSecurityDescriptor   // PSECURITY_DESCRIPTOR
);
ccall((:RegSetKeySecurity, "ADVAPI32.dll"), stdcall, UInt32,
      (Ptr{Cvoid}, UInt32, Ptr{Cvoid}),
      hKey, SecurityInformation, pSecurityDescriptor)
# hKey : HKEY -> Ptr{Cvoid}
# SecurityInformation : OBJECT_SECURITY_INFORMATION -> UInt32
# pSecurityDescriptor : PSECURITY_DESCRIPTOR -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t RegSetKeySecurity(
    void* hKey,
    uint32_t SecurityInformation,
    void* pSecurityDescriptor);
]]
local advapi32 = ffi.load("advapi32")
-- advapi32.RegSetKeySecurity(hKey, SecurityInformation, pSecurityDescriptor)
-- hKey : HKEY
-- SecurityInformation : OBJECT_SECURITY_INFORMATION
-- pSecurityDescriptor : PSECURITY_DESCRIPTOR
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('ADVAPI32.dll');
const RegSetKeySecurity = lib.func('__stdcall', 'RegSetKeySecurity', 'uint32_t', ['void *', 'uint32_t', 'void *']);
// RegSetKeySecurity(hKey, SecurityInformation, pSecurityDescriptor)
// hKey : HKEY -> 'void *'
// SecurityInformation : OBJECT_SECURITY_INFORMATION -> 'uint32_t'
// pSecurityDescriptor : PSECURITY_DESCRIPTOR -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("ADVAPI32.dll", {
  RegSetKeySecurity: { parameters: ["pointer", "u32", "pointer"], result: "u32" },
});
// lib.symbols.RegSetKeySecurity(hKey, SecurityInformation, pSecurityDescriptor)
// hKey : HKEY -> "pointer"
// SecurityInformation : OBJECT_SECURITY_INFORMATION -> "u32"
// pSecurityDescriptor : PSECURITY_DESCRIPTOR -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t RegSetKeySecurity(
    void* hKey,
    uint32_t SecurityInformation,
    void* pSecurityDescriptor);
C, "ADVAPI32.dll");
// $ffi->RegSetKeySecurity(hKey, SecurityInformation, pSecurityDescriptor);
// hKey : HKEY
// 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);
    int RegSetKeySecurity(
        Pointer hKey,   // HKEY
        int SecurityInformation,   // OBJECT_SECURITY_INFORMATION
        Pointer pSecurityDescriptor   // PSECURITY_DESCRIPTOR
    );
}
@[Link("advapi32")]
lib LibADVAPI32
  fun RegSetKeySecurity = RegSetKeySecurity(
    hKey : Void*,   # HKEY
    SecurityInformation : UInt32,   # OBJECT_SECURITY_INFORMATION
    pSecurityDescriptor : Void*   # PSECURITY_DESCRIPTOR
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

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

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

let regsetkeysecurity =
  foreign "RegSetKeySecurity"
    ((ptr void) @-> uint32_t @-> (ptr void) @-> returning uint32_t)
(* hKey : HKEY -> (ptr void) *)
(* 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 ("RegSetKeySecurity" reg-set-key-security :convention :stdcall) :uint32
  (h-key :pointer)   ; HKEY
  (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 $RegSetKeySecurity = Win32::API::More->new('ADVAPI32',
    'DWORD RegSetKeySecurity(HANDLE hKey, DWORD SecurityInformation, HANDLE pSecurityDescriptor)');
# my $ret = $RegSetKeySecurity->Call($hKey, $SecurityInformation, $pSecurityDescriptor);
# hKey : HKEY -> HANDLE
# SecurityInformation : OBJECT_SECURITY_INFORMATION -> DWORD
# pSecurityDescriptor : PSECURITY_DESCRIPTOR -> HANDLE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目
使用する型