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

RegDeleteTreeA

関数
指定キー配下のサブキーと値を再帰的に削除する。
DLLADVAPI32.dll文字セットANSI (-A)呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

WIN32_ERROR RegDeleteTreeA(
    HKEY hKey,
    LPCSTR lpSubKey   // optional
);

パラメーター

名前方向説明
hKeyHKEYin

開いているレジストリキーへのハンドル。このキーは次のアクセス権で開かれている必要があります: DELETE、KEY_ENUMERATE_SUB_KEYSKEY_QUERY_VALUE。詳細については、 Registry Key Security and Access Rights を参照してください。

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

HKEY_CLASSES_ROOT
HKEY_CURRENT_CONFIG
HKEY_CURRENT_USER
HKEY_LOCAL_MACHINE
HKEY_USERS
lpSubKeyLPCSTRinoptionalキーの名前。このキーは hKey パラメーターで識別されるキーのサブキーである必要があります。このパラメーターが NULL の場合、hKey のサブキーと値が削除されます。

戻り値の型: WIN32_ERROR

公式ドキュメント

指定したキーのサブキーと値を再帰的に削除します。(ANSI)

戻り値

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

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

解説(Remarks)

キーに値がある場合、KEY_SET_VALUE で開かれている必要があります。そうでない場合、この関数は ERROR_ACCESS_DENIED で失敗します。

この関数を使用するアプリケーションをコンパイルするには、_WIN32_WINNT を 0x0600 以降として定義します。詳細については、 Using the Windows Headers を参照してください。

メモ

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

メモ

winreg.h ヘッダーは RegDeleteTree をエイリアスとして定義しており、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 RegDeleteTreeA(
    HKEY hKey,
    LPCSTR lpSubKey   // optional
);
[DllImport("ADVAPI32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint RegDeleteTreeA(
    IntPtr hKey,   // HKEY
    [MarshalAs(UnmanagedType.LPStr)] string lpSubKey   // LPCSTR optional
);
<DllImport("ADVAPI32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function RegDeleteTreeA(
    hKey As IntPtr,   ' HKEY
    <MarshalAs(UnmanagedType.LPStr)> lpSubKey As String   ' LPCSTR optional
) As UInteger
End Function
' hKey : HKEY
' lpSubKey : LPCSTR optional
Declare PtrSafe Function RegDeleteTreeA 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

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

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

var (
	advapi32 = windows.NewLazySystemDLL("ADVAPI32.dll")
	procRegDeleteTreeA = advapi32.NewProc("RegDeleteTreeA")
)

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

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

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

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

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

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

関連項目

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