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

RegDeleteKeyA

関数
指定したサブキーをレジストリから削除する。
DLLADVAPI32.dll文字セットANSI (-A)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

WIN32_ERROR RegDeleteKeyA(
    HKEY hKey,
    LPCSTR lpSubKey
);

パラメーター

名前方向説明
hKeyHKEYin

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

このハンドルは RegCreateKeyEx または RegOpenKeyEx 関数によって返されます。あるいは、次の Predefined Keys のいずれかを指定できます:

HKEY_CLASSES_ROOT
HKEY_CURRENT_CONFIG
HKEY_CURRENT_USER
HKEY_LOCAL_MACHINE
HKEY_USERS
lpSubKeyLPCSTRin

削除するキーの名前。hKey が示すキーのサブキーである必要がありますが、それ自身がサブキーを持つことはできません。このパラメーターを NULL にすることはできません。

この関数はサブキーを DELETE アクセス権で開きます。

キー名では大文字と小文字は区別されません。

詳細については、 Registry Element Size Limits を参照してください。

戻り値の型: WIN32_ERROR

公式ドキュメント

サブキーとその値を削除します。(ANSI)

戻り値

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

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

解説(Remarks)

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

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

Examples

この関数を使用する例については、Deleting a Key with Subkeys を参照してください。

メモ

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

メモ

winreg.h ヘッダーは RegDeleteKey を、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 RegDeleteKeyA(
    HKEY hKey,
    LPCSTR lpSubKey
);
[DllImport("ADVAPI32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint RegDeleteKeyA(
    IntPtr hKey,   // HKEY
    [MarshalAs(UnmanagedType.LPStr)] string lpSubKey   // LPCSTR
);
<DllImport("ADVAPI32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function RegDeleteKeyA(
    hKey As IntPtr,   ' HKEY
    <MarshalAs(UnmanagedType.LPStr)> lpSubKey As String   ' LPCSTR
) As UInteger
End Function
' hKey : HKEY
' lpSubKey : LPCSTR
Declare PtrSafe Function RegDeleteKeyA Lib "advapi32" ( _
    ByVal hKey As LongPtr, _
    ByVal lpSubKey As String) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

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

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

var (
	advapi32 = windows.NewLazySystemDLL("ADVAPI32.dll")
	procRegDeleteKeyA = advapi32.NewProc("RegDeleteKeyA")
)

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

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

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

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

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

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

関連項目

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