Win32 API 日本語リファレンス
ホームNetworking.Clustering › ResUtilsDeleteKeyTree

ResUtilsDeleteKeyTree

関数
指定レジストリキーをサブキーごと再帰的に削除する。
DLLRESUTILS.dll呼出規約winapi

シグネチャ

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

DWORD ResUtilsDeleteKeyTree(
    HKEY key,
    LPCWSTR keyName,
    BOOL treatNoKeyAsError
);

パラメーター

名前方向説明
keyHKEYin削除対象のサブキーを含む親レジストリキーのハンドル。
keyNameLPCWSTRin再帰的に削除するサブキーの名前。
treatNoKeyAsErrorBOOLinTRUEならキー不在をエラーとして扱う。FALSEなら無視する。

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD ResUtilsDeleteKeyTree(
    HKEY key,
    LPCWSTR keyName,
    BOOL treatNoKeyAsError
);
[DllImport("RESUTILS.dll", ExactSpelling = true)]
static extern uint ResUtilsDeleteKeyTree(
    IntPtr key,   // HKEY
    [MarshalAs(UnmanagedType.LPWStr)] string keyName,   // LPCWSTR
    bool treatNoKeyAsError   // BOOL
);
<DllImport("RESUTILS.dll", ExactSpelling:=True)>
Public Shared Function ResUtilsDeleteKeyTree(
    key As IntPtr,   ' HKEY
    <MarshalAs(UnmanagedType.LPWStr)> keyName As String,   ' LPCWSTR
    treatNoKeyAsError As Boolean   ' BOOL
) As UInteger
End Function
' key : HKEY
' keyName : LPCWSTR
' treatNoKeyAsError : BOOL
Declare PtrSafe Function ResUtilsDeleteKeyTree Lib "resutils" ( _
    ByVal key As LongPtr, _
    ByVal keyName As LongPtr, _
    ByVal treatNoKeyAsError As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

ResUtilsDeleteKeyTree = ctypes.windll.resutils.ResUtilsDeleteKeyTree
ResUtilsDeleteKeyTree.restype = wintypes.DWORD
ResUtilsDeleteKeyTree.argtypes = [
    wintypes.HANDLE,  # key : HKEY
    wintypes.LPCWSTR,  # keyName : LPCWSTR
    wintypes.BOOL,  # treatNoKeyAsError : BOOL
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('RESUTILS.dll')
ResUtilsDeleteKeyTree = Fiddle::Function.new(
  lib['ResUtilsDeleteKeyTree'],
  [
    Fiddle::TYPE_VOIDP,  # key : HKEY
    Fiddle::TYPE_VOIDP,  # keyName : LPCWSTR
    Fiddle::TYPE_INT,  # treatNoKeyAsError : BOOL
  ],
  -Fiddle::TYPE_INT)
#[link(name = "resutils")]
extern "system" {
    fn ResUtilsDeleteKeyTree(
        key: *mut core::ffi::c_void,  // HKEY
        keyName: *const u16,  // LPCWSTR
        treatNoKeyAsError: i32  // BOOL
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("RESUTILS.dll")]
public static extern uint ResUtilsDeleteKeyTree(IntPtr key, [MarshalAs(UnmanagedType.LPWStr)] string keyName, bool treatNoKeyAsError);
"@
$api = Add-Type -MemberDefinition $sig -Name 'RESUTILS_ResUtilsDeleteKeyTree' -Namespace Win32 -PassThru
# $api::ResUtilsDeleteKeyTree(key, keyName, treatNoKeyAsError)
#uselib "RESUTILS.dll"
#func global ResUtilsDeleteKeyTree "ResUtilsDeleteKeyTree" sptr, sptr, sptr
; ResUtilsDeleteKeyTree key, keyName, treatNoKeyAsError   ; 戻り値は stat
; key : HKEY -> "sptr"
; keyName : LPCWSTR -> "sptr"
; treatNoKeyAsError : BOOL -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "RESUTILS.dll"
#cfunc global ResUtilsDeleteKeyTree "ResUtilsDeleteKeyTree" sptr, wstr, int
; res = ResUtilsDeleteKeyTree(key, keyName, treatNoKeyAsError)
; key : HKEY -> "sptr"
; keyName : LPCWSTR -> "wstr"
; treatNoKeyAsError : BOOL -> "int"
; DWORD ResUtilsDeleteKeyTree(HKEY key, LPCWSTR keyName, BOOL treatNoKeyAsError)
#uselib "RESUTILS.dll"
#cfunc global ResUtilsDeleteKeyTree "ResUtilsDeleteKeyTree" intptr, wstr, int
; res = ResUtilsDeleteKeyTree(key, keyName, treatNoKeyAsError)
; key : HKEY -> "intptr"
; keyName : LPCWSTR -> "wstr"
; treatNoKeyAsError : BOOL -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	resutils = windows.NewLazySystemDLL("RESUTILS.dll")
	procResUtilsDeleteKeyTree = resutils.NewProc("ResUtilsDeleteKeyTree")
)

// key (HKEY), keyName (LPCWSTR), treatNoKeyAsError (BOOL)
r1, _, err := procResUtilsDeleteKeyTree.Call(
	uintptr(key),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(keyName))),
	uintptr(treatNoKeyAsError),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function ResUtilsDeleteKeyTree(
  key: THandle;   // HKEY
  keyName: PWideChar;   // LPCWSTR
  treatNoKeyAsError: BOOL   // BOOL
): DWORD; stdcall;
  external 'RESUTILS.dll' name 'ResUtilsDeleteKeyTree';
result := DllCall("RESUTILS\ResUtilsDeleteKeyTree"
    , "Ptr", key   ; HKEY
    , "WStr", keyName   ; LPCWSTR
    , "Int", treatNoKeyAsError   ; BOOL
    , "UInt")   ; return: DWORD
●ResUtilsDeleteKeyTree(key, keyName, treatNoKeyAsError) = DLL("RESUTILS.dll", "dword ResUtilsDeleteKeyTree(void*, char*, bool)")
# 呼び出し: ResUtilsDeleteKeyTree(key, keyName, treatNoKeyAsError)
# key : HKEY -> "void*"
# keyName : LPCWSTR -> "char*"
# treatNoKeyAsError : BOOL -> "bool"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef ResUtilsDeleteKeyTreeNative = Uint32 Function(Pointer<Void>, Pointer<Utf16>, Int32);
typedef ResUtilsDeleteKeyTreeDart = int Function(Pointer<Void>, Pointer<Utf16>, int);
final ResUtilsDeleteKeyTree = DynamicLibrary.open('RESUTILS.dll')
    .lookupFunction<ResUtilsDeleteKeyTreeNative, ResUtilsDeleteKeyTreeDart>('ResUtilsDeleteKeyTree');
// key : HKEY -> Pointer<Void>
// keyName : LPCWSTR -> Pointer<Utf16>
// treatNoKeyAsError : BOOL -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function ResUtilsDeleteKeyTree(
  key: THandle;   // HKEY
  keyName: PWideChar;   // LPCWSTR
  treatNoKeyAsError: BOOL   // BOOL
): DWORD; stdcall;
  external 'RESUTILS.dll' name 'ResUtilsDeleteKeyTree';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "ResUtilsDeleteKeyTree"
  c_ResUtilsDeleteKeyTree :: Ptr () -> CWString -> CInt -> IO Word32
-- key : HKEY -> Ptr ()
-- keyName : LPCWSTR -> CWString
-- treatNoKeyAsError : BOOL -> CInt
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let resutilsdeletekeytree =
  foreign "ResUtilsDeleteKeyTree"
    ((ptr void) @-> (ptr uint16_t) @-> int32_t @-> returning uint32_t)
(* key : HKEY -> (ptr void) *)
(* keyName : LPCWSTR -> (ptr uint16_t) *)
(* treatNoKeyAsError : BOOL -> int32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library resutils (t "RESUTILS.dll"))
(cffi:use-foreign-library resutils)

(cffi:defcfun ("ResUtilsDeleteKeyTree" res-utils-delete-key-tree :convention :stdcall) :uint32
  (key :pointer)   ; HKEY
  (key-name (:string :encoding :utf-16le))   ; LPCWSTR
  (treat-no-key-as-error :int32))   ; BOOL
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $ResUtilsDeleteKeyTree = Win32::API::More->new('RESUTILS',
    'DWORD ResUtilsDeleteKeyTree(HANDLE key, LPCWSTR keyName, BOOL treatNoKeyAsError)');
# my $ret = $ResUtilsDeleteKeyTree->Call($key, $keyName, $treatNoKeyAsError);
# key : HKEY -> HANDLE
# keyName : LPCWSTR -> LPCWSTR
# treatNoKeyAsError : BOOL -> BOOL
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。