RegDeleteTreeW
関数シグネチャ
// ADVAPI32.dll (Unicode / -W)
#include <windows.h>
WIN32_ERROR RegDeleteTreeW(
HKEY hKey,
LPCWSTR lpSubKey // optional
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| hKey | HKEY | in | 開いているレジストリキーへのハンドルです。このキーは、次のアクセス権で開かれている必要があります: DELETE、KEY_ENUMERATE_SUB_KEYS、KEY_QUERY_VALUE。詳細については、 Registry Key Security and Access Rights を参照してください。 このハンドルは、 RegCreateKeyEx、 RegCreateKeyTransacted、 RegOpenKeyEx、または RegOpenKeyTransacted 関数によって返されます。 あるいは、次の Predefined Keys のいずれかを指定できます: |
| lpSubKey | LPCWSTR | inoptional | キーの名前です。このキーは、hKey パラメーターで指定されたキーのサブキーである必要があります。このパラメーターが NULL の場合、hKey のサブキーと値が削除されます。 |
戻り値の型: WIN32_ERROR
公式ドキュメント
指定したキーのサブキーと値を再帰的に削除します。(Unicode)
戻り値
関数が成功した場合、戻り値は 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 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// ADVAPI32.dll (Unicode / -W)
#include <windows.h>
WIN32_ERROR RegDeleteTreeW(
HKEY hKey,
LPCWSTR lpSubKey // optional
);[DllImport("ADVAPI32.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint RegDeleteTreeW(
IntPtr hKey, // HKEY
[MarshalAs(UnmanagedType.LPWStr)] string lpSubKey // LPCWSTR optional
);<DllImport("ADVAPI32.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function RegDeleteTreeW(
hKey As IntPtr, ' HKEY
<MarshalAs(UnmanagedType.LPWStr)> lpSubKey As String ' LPCWSTR optional
) As UInteger
End Function' hKey : HKEY
' lpSubKey : LPCWSTR optional
Declare PtrSafe Function RegDeleteTreeW Lib "advapi32" ( _
ByVal hKey As LongPtr, _
ByVal lpSubKey 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
RegDeleteTreeW = ctypes.windll.advapi32.RegDeleteTreeW
RegDeleteTreeW.restype = wintypes.DWORD
RegDeleteTreeW.argtypes = [
wintypes.HANDLE, # hKey : HKEY
wintypes.LPCWSTR, # lpSubKey : LPCWSTR optional
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('ADVAPI32.dll')
RegDeleteTreeW = Fiddle::Function.new(
lib['RegDeleteTreeW'],
[
Fiddle::TYPE_VOIDP, # hKey : HKEY
Fiddle::TYPE_VOIDP, # lpSubKey : LPCWSTR optional
],
-Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"#[link(name = "advapi32")]
extern "system" {
fn RegDeleteTreeW(
hKey: *mut core::ffi::c_void, // HKEY
lpSubKey: *const u16 // LPCWSTR optional
) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("ADVAPI32.dll", CharSet = CharSet.Unicode)]
public static extern uint RegDeleteTreeW(IntPtr hKey, [MarshalAs(UnmanagedType.LPWStr)] string lpSubKey);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_RegDeleteTreeW' -Namespace Win32 -PassThru
# $api::RegDeleteTreeW(hKey, lpSubKey)#uselib "ADVAPI32.dll"
#func global RegDeleteTreeW "RegDeleteTreeW" wptr, wptr
; RegDeleteTreeW hKey, lpSubKey ; 戻り値は stat
; hKey : HKEY -> "wptr"
; lpSubKey : LPCWSTR optional -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "ADVAPI32.dll"
#cfunc global RegDeleteTreeW "RegDeleteTreeW" sptr, wstr
; res = RegDeleteTreeW(hKey, lpSubKey)
; hKey : HKEY -> "sptr"
; lpSubKey : LPCWSTR optional -> "wstr"; WIN32_ERROR RegDeleteTreeW(HKEY hKey, LPCWSTR lpSubKey)
#uselib "ADVAPI32.dll"
#cfunc global RegDeleteTreeW "RegDeleteTreeW" intptr, wstr
; res = RegDeleteTreeW(hKey, lpSubKey)
; hKey : HKEY -> "intptr"
; lpSubKey : LPCWSTR optional -> "wstr"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
advapi32 = windows.NewLazySystemDLL("ADVAPI32.dll")
procRegDeleteTreeW = advapi32.NewProc("RegDeleteTreeW")
)
// hKey (HKEY), lpSubKey (LPCWSTR optional)
r1, _, err := procRegDeleteTreeW.Call(
uintptr(hKey),
uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpSubKey))),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // WIN32_ERRORfunction RegDeleteTreeW(
hKey: THandle; // HKEY
lpSubKey: PWideChar // LPCWSTR optional
): DWORD; stdcall;
external 'ADVAPI32.dll' name 'RegDeleteTreeW';result := DllCall("ADVAPI32\RegDeleteTreeW"
, "Ptr", hKey ; HKEY
, "WStr", lpSubKey ; LPCWSTR optional
, "UInt") ; return: WIN32_ERROR●RegDeleteTreeW(hKey, lpSubKey) = DLL("ADVAPI32.dll", "dword RegDeleteTreeW(void*, char*)")
# 呼び出し: RegDeleteTreeW(hKey, lpSubKey)
# hKey : HKEY -> "void*"
# lpSubKey : LPCWSTR optional -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。const std = @import("std");
extern "advapi32" fn RegDeleteTreeW(
hKey: ?*anyopaque, // HKEY
lpSubKey: [*c]const u16 // LPCWSTR optional
) callconv(std.os.windows.WINAPI) u32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。proc RegDeleteTreeW(
hKey: pointer, # HKEY
lpSubKey: WideCString # LPCWSTR optional
): uint32 {.importc: "RegDeleteTreeW", stdcall, dynlib: "ADVAPI32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。pragma(lib, "advapi32");
extern(Windows)
uint RegDeleteTreeW(
void* hKey, // HKEY
const(wchar)* lpSubKey // LPCWSTR optional
);ccall((:RegDeleteTreeW, "ADVAPI32.dll"), stdcall, UInt32,
(Ptr{Cvoid}, Cwstring),
hKey, lpSubKey)
# hKey : HKEY -> Ptr{Cvoid}
# lpSubKey : LPCWSTR optional -> Cwstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。local ffi = require("ffi")
ffi.cdef[[
uint32_t RegDeleteTreeW(
void* hKey,
const uint16_t* lpSubKey);
]]
local advapi32 = ffi.load("advapi32")
-- advapi32.RegDeleteTreeW(hKey, lpSubKey)
-- hKey : HKEY
-- lpSubKey : LPCWSTR optional
-- 構造体/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 RegDeleteTreeW = lib.func('__stdcall', 'RegDeleteTreeW', 'uint32_t', ['void *', 'str16']);
// RegDeleteTreeW(hKey, lpSubKey)
// hKey : HKEY -> 'void *'
// lpSubKey : LPCWSTR optional -> 'str16'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("ADVAPI32.dll", {
RegDeleteTreeW: { parameters: ["pointer", "buffer"], result: "u32" },
});
// lib.symbols.RegDeleteTreeW(hKey, lpSubKey)
// hKey : HKEY -> "pointer"
// lpSubKey : LPCWSTR optional -> "buffer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
uint32_t RegDeleteTreeW(
void* hKey,
const uint16_t* lpSubKey);
C, "ADVAPI32.dll");
// $ffi->RegDeleteTreeW(hKey, lpSubKey);
// hKey : HKEY
// lpSubKey : LPCWSTR 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.UNICODE_OPTIONS);
int RegDeleteTreeW(
Pointer hKey, // HKEY
WString lpSubKey // LPCWSTR optional
);
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。@[Link("advapi32")]
lib LibADVAPI32
fun RegDeleteTreeW = RegDeleteTreeW(
hKey : Void*, # HKEY
lpSubKey : UInt16* # LPCWSTR optional
) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef RegDeleteTreeWNative = Uint32 Function(Pointer<Void>, Pointer<Utf16>);
typedef RegDeleteTreeWDart = int Function(Pointer<Void>, Pointer<Utf16>);
final RegDeleteTreeW = DynamicLibrary.open('ADVAPI32.dll')
.lookupFunction<RegDeleteTreeWNative, RegDeleteTreeWDart>('RegDeleteTreeW');
// hKey : HKEY -> Pointer<Void>
// lpSubKey : LPCWSTR optional -> Pointer<Utf16>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function RegDeleteTreeW(
hKey: THandle; // HKEY
lpSubKey: PWideChar // LPCWSTR optional
): DWORD; stdcall;
external 'ADVAPI32.dll' name 'RegDeleteTreeW';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "RegDeleteTreeW"
c_RegDeleteTreeW :: Ptr () -> CWString -> IO Word32
-- hKey : HKEY -> Ptr ()
-- lpSubKey : LPCWSTR optional -> CWString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let regdeletetreew =
foreign "RegDeleteTreeW"
((ptr void) @-> (ptr uint16_t) @-> returning uint32_t)
(* hKey : HKEY -> (ptr void) *)
(* lpSubKey : LPCWSTR optional -> (ptr uint16_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library advapi32 (t "ADVAPI32.dll"))
(cffi:use-foreign-library advapi32)
(cffi:defcfun ("RegDeleteTreeW" reg-delete-tree-w :convention :stdcall) :uint32
(h-key :pointer) ; HKEY
(lp-sub-key (:string :encoding :utf-16le))) ; LPCWSTR optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $RegDeleteTreeW = Win32::API::More->new('ADVAPI32',
'DWORD RegDeleteTreeW(HANDLE hKey, LPCWSTR lpSubKey)');
# my $ret = $RegDeleteTreeW->Call($hKey, $lpSubKey);
# hKey : HKEY -> HANDLE
# lpSubKey : LPCWSTR optional -> LPCWSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。関連項目
- f RegDeleteTreeA (ANSI版) — 指定キー配下のサブキーと値を再帰的に削除する。
- f RegDeleteKeyW — 指定したサブキーをレジストリから削除する。
- f RegDeleteKeyExW — 32/64ビットビューを指定してサブキーを削除する。
- f RegDeleteKeyTransactedW — トランザクション処理でレジストリのサブキーを削除する。