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

RegDeleteKeyExA

関数
32/64ビットビューを指定してサブキーを削除する。
DLLADVAPI32.dll文字セットANSI (-A)呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

WIN32_ERROR RegDeleteKeyExA(
    HKEY hKey,
    LPCSTR lpSubKey,
    DWORD samDesired,
    DWORD Reserved   // optional
);

パラメーター

名前方向説明
hKeyHKEYin

開いているレジストリキーへのハンドル。このキーのアクセス権は削除操作に影響しません。アクセス権の詳細については、 Registry Key Security and Access Rights を参照してください。

このハンドルは RegCreateKeyEx または RegOpenKeyEx 関数によって返されます。または、次の 定義済みキー のいずれかを指定できます。

HKEY_CLASSES_ROOT
HKEY_CURRENT_CONFIG
HKEY_CURRENT_USER
HKEY_LOCAL_MACHINE
HKEY_USERS
lpSubKeyLPCSTRin

削除するキーの名前。このキーは、hKey パラメーターの値で指定されたキーのサブキーである必要があります。

この関数は、DELETE アクセス権を使用してサブキーを開きます。

キー名は大文字と小文字を区別しません。

このパラメーターの値を NULL にすることはできません。

samDesiredDWORDin

レジストリのプラットフォーム固有のビューを指定するアクセスマスク。

意味
KEY_WOW64_32KEY
0x0200
32 ビットのレジストリビューからキーを削除します。
KEY_WOW64_64KEY
0x0100
64 ビットのレジストリビューからキーを削除します。
ReservedDWORDoptionalこのパラメーターは予約されており、ゼロである必要があります。

戻り値の型: WIN32_ERROR

公式ドキュメント

レジストリの指定されたプラットフォーム固有のビューから、サブキーとその値を削除します。(ANSI)

戻り値

関数が成功した場合、戻り値は ERROR_SUCCESS です。

関数が失敗した場合、戻り値は Winerror.h で定義されている 0 以外のエラーコードです。エラーの一般的な説明を取得するには、FormatMessage 関数を FORMAT_MESSAGE_FROM_SYSTEM フラグとともに使用できます。

解説(Remarks)

削除されたキーは、それに対する最後のハンドルが閉じられるまで削除されません。

WOW64 では、32 ビットアプリケーションは、64 ビットアプリケーションが参照するレジストリツリーとは別のレジストリツリーを参照します。この関数を使用すると、アプリケーションは代替レジストリビュー内のエントリを削除できます。

削除するサブキーにはサブキーが存在してはなりません。キーとそのすべてのサブキーを削除するには、サブキーを列挙して個別に削除する必要があります。キーを再帰的に削除するには、 RegDeleteTree または SHDeleteKey 関数を使用します。

関数が成功すると、RegDeleteKeyEx は指定されたキーをレジストリから削除します。すべての値を含むキー全体が削除されます。

メモ

以前のバージョンの Windows では、この API は kernel32.dll からも公開されています。

メモ

winreg.h ヘッダーは、RegDeleteKeyEx を、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  (ANSI / -A)
#include <windows.h>

WIN32_ERROR RegDeleteKeyExA(
    HKEY hKey,
    LPCSTR lpSubKey,
    DWORD samDesired,
    DWORD Reserved   // optional
);
[DllImport("ADVAPI32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint RegDeleteKeyExA(
    IntPtr hKey,   // HKEY
    [MarshalAs(UnmanagedType.LPStr)] string lpSubKey,   // LPCSTR
    uint samDesired,   // DWORD
    uint Reserved   // DWORD optional
);
<DllImport("ADVAPI32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function RegDeleteKeyExA(
    hKey As IntPtr,   ' HKEY
    <MarshalAs(UnmanagedType.LPStr)> lpSubKey As String,   ' LPCSTR
    samDesired As UInteger,   ' DWORD
    Reserved As UInteger   ' DWORD optional
) As UInteger
End Function
' hKey : HKEY
' lpSubKey : LPCSTR
' samDesired : DWORD
' Reserved : DWORD optional
Declare PtrSafe Function RegDeleteKeyExA Lib "advapi32" ( _
    ByVal hKey As LongPtr, _
    ByVal lpSubKey As String, _
    ByVal samDesired As Long, _
    ByVal Reserved As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

RegDeleteKeyExA = ctypes.windll.advapi32.RegDeleteKeyExA
RegDeleteKeyExA.restype = wintypes.DWORD
RegDeleteKeyExA.argtypes = [
    wintypes.HANDLE,  # hKey : HKEY
    wintypes.LPCSTR,  # lpSubKey : LPCSTR
    wintypes.DWORD,  # samDesired : DWORD
    wintypes.DWORD,  # Reserved : DWORD optional
]
require 'fiddle'
require 'fiddle/import'

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

var (
	advapi32 = windows.NewLazySystemDLL("ADVAPI32.dll")
	procRegDeleteKeyExA = advapi32.NewProc("RegDeleteKeyExA")
)

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

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

typedef RegDeleteKeyExANative = Uint32 Function(Pointer<Void>, Pointer<Utf8>, Uint32, Uint32);
typedef RegDeleteKeyExADart = int Function(Pointer<Void>, Pointer<Utf8>, int, int);
final RegDeleteKeyExA = DynamicLibrary.open('ADVAPI32.dll')
    .lookupFunction<RegDeleteKeyExANative, RegDeleteKeyExADart>('RegDeleteKeyExA');
// hKey : HKEY -> Pointer<Void>
// lpSubKey : LPCSTR -> Pointer<Utf8>
// samDesired : DWORD -> Uint32
// Reserved : DWORD optional -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function RegDeleteKeyExA(
  hKey: THandle;   // HKEY
  lpSubKey: PAnsiChar;   // LPCSTR
  samDesired: DWORD;   // DWORD
  Reserved: DWORD   // DWORD optional
): DWORD; stdcall;
  external 'ADVAPI32.dll' name 'RegDeleteKeyExA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "RegDeleteKeyExA"
  c_RegDeleteKeyExA :: Ptr () -> CString -> Word32 -> Word32 -> IO Word32
-- hKey : HKEY -> Ptr ()
-- lpSubKey : LPCSTR -> CString
-- samDesired : DWORD -> Word32
-- Reserved : DWORD optional -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let regdeletekeyexa =
  foreign "RegDeleteKeyExA"
    ((ptr void) @-> string @-> uint32_t @-> uint32_t @-> returning uint32_t)
(* hKey : HKEY -> (ptr void) *)
(* lpSubKey : LPCSTR -> string *)
(* samDesired : DWORD -> uint32_t *)
(* Reserved : DWORD optional -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library advapi32 (t "ADVAPI32.dll"))
(cffi:use-foreign-library advapi32)

(cffi:defcfun ("RegDeleteKeyExA" reg-delete-key-ex-a :convention :stdcall) :uint32
  (h-key :pointer)   ; HKEY
  (lp-sub-key :string)   ; LPCSTR
  (sam-desired :uint32)   ; DWORD
  (reserved :uint32))   ; DWORD optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $RegDeleteKeyExA = Win32::API::More->new('ADVAPI32',
    'DWORD RegDeleteKeyExA(HANDLE hKey, LPCSTR lpSubKey, DWORD samDesired, DWORD Reserved)');
# my $ret = $RegDeleteKeyExA->Call($hKey, $lpSubKey, $samDesired, $Reserved);
# hKey : HKEY -> HANDLE
# lpSubKey : LPCSTR -> LPCSTR
# samDesired : DWORD -> DWORD
# Reserved : DWORD optional -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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