Win32 API 日本語リファレンス
ホームUI.Shell › SHDeleteKeyA

SHDeleteKeyA

関数
レジストリキーとその全サブキーを再帰的に削除する。
DLLSHLWAPI.dll文字セットANSI (-A)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

WIN32_ERROR SHDeleteKeyA(
    HKEY hkey,
    LPCSTR pszSubKey   // optional
);

パラメーター

名前方向説明
hkeyHKEYin

開いているレジストリキーへのハンドル、または次の定義済みキーのいずれか:

HKEY_CLASSES_ROOT

HKEY_CURRENT_CONFIG

HKEY_CURRENT_USER

HKEY_LOCAL_MACHINE

HKEY_PERFORMANCE_DATA

HKEY_USERS

pszSubKeyLPCSTRinoptional削除するキーの名前を指定する、null で終わる文字列のアドレス。

戻り値の型: WIN32_ERROR

公式ドキュメント

サブキーとそのすべての子孫を削除します。この関数は、キーおよびそのキーのすべての値をレジストリから削除します。(ANSI)

戻り値

型: LSTATUS

成功した場合は ERROR_SUCCESS を返し、それ以外の場合は Winerror.h で定義された 0 以外のエラーコードを返します。FormatMessage 関数に FORMAT_MESSAGE_FROM_SYSTEM フラグを指定して使用すると、エラーの一般的な説明を取得できます。

解説(Remarks)

代わりに、RegDeleteKey 関数または RegDeleteTree 関数を使用することもできます。

メモ

shlwapi.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして SHDeleteKey を定義します。エンコーディング中立なエイリアスの使用と、エンコーディング中立でないコードを混在させると、不一致が生じてコンパイルエラーや実行時エラーの原因となることがあります。詳細については、関数プロトタイプの規約を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

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

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

SHDeleteKeyA = ctypes.windll.shlwapi.SHDeleteKeyA
SHDeleteKeyA.restype = wintypes.DWORD
SHDeleteKeyA.argtypes = [
    wintypes.HANDLE,  # hkey : HKEY
    wintypes.LPCSTR,  # pszSubKey : LPCSTR optional
]
require 'fiddle'
require 'fiddle/import'

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

var (
	shlwapi = windows.NewLazySystemDLL("SHLWAPI.dll")
	procSHDeleteKeyA = shlwapi.NewProc("SHDeleteKeyA")
)

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

extern "shlwapi" fn SHDeleteKeyA(
    hkey: ?*anyopaque, // HKEY
    pszSubKey: [*c]const u8 // LPCSTR optional
) callconv(std.os.windows.WINAPI) u32;
proc SHDeleteKeyA(
    hkey: pointer,  # HKEY
    pszSubKey: cstring  # LPCSTR optional
): uint32 {.importc: "SHDeleteKeyA", stdcall, dynlib: "SHLWAPI.dll".}
pragma(lib, "shlwapi");
extern(Windows)
uint SHDeleteKeyA(
    void* hkey,   // HKEY
    const(char)* pszSubKey   // LPCSTR optional
);
ccall((:SHDeleteKeyA, "SHLWAPI.dll"), stdcall, UInt32,
      (Ptr{Cvoid}, Cstring),
      hkey, pszSubKey)
# hkey : HKEY -> Ptr{Cvoid}
# pszSubKey : LPCSTR optional -> Cstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t SHDeleteKeyA(
    void* hkey,
    const char* pszSubKey);
]]
local shlwapi = ffi.load("shlwapi")
-- shlwapi.SHDeleteKeyA(hkey, pszSubKey)
-- hkey : HKEY
-- pszSubKey : LPCSTR optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('SHLWAPI.dll');
const SHDeleteKeyA = lib.func('__stdcall', 'SHDeleteKeyA', 'uint32_t', ['void *', 'str']);
// SHDeleteKeyA(hkey, pszSubKey)
// hkey : HKEY -> 'void *'
// pszSubKey : LPCSTR optional -> 'str'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("SHLWAPI.dll", {
  SHDeleteKeyA: { parameters: ["pointer", "buffer"], result: "u32" },
});
// lib.symbols.SHDeleteKeyA(hkey, pszSubKey)
// hkey : HKEY -> "pointer"
// pszSubKey : LPCSTR optional -> "buffer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t SHDeleteKeyA(
    void* hkey,
    const char* pszSubKey);
C, "SHLWAPI.dll");
// $ffi->SHDeleteKeyA(hkey, pszSubKey);
// hkey : HKEY
// pszSubKey : 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 Shlwapi extends StdCallLibrary {
    Shlwapi INSTANCE = Native.load("shlwapi", Shlwapi.class, W32APIOptions.ASCII_OPTIONS);
    int SHDeleteKeyA(
        Pointer hkey,   // HKEY
        String pszSubKey   // LPCSTR optional
    );
}
@[Link("shlwapi")]
lib LibSHLWAPI
  fun SHDeleteKeyA = SHDeleteKeyA(
    hkey : Void*,   # HKEY
    pszSubKey : 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 SHDeleteKeyANative = Uint32 Function(Pointer<Void>, Pointer<Utf8>);
typedef SHDeleteKeyADart = int Function(Pointer<Void>, Pointer<Utf8>);
final SHDeleteKeyA = DynamicLibrary.open('SHLWAPI.dll')
    .lookupFunction<SHDeleteKeyANative, SHDeleteKeyADart>('SHDeleteKeyA');
// hkey : HKEY -> Pointer<Void>
// pszSubKey : LPCSTR optional -> Pointer<Utf8>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SHDeleteKeyA(
  hkey: THandle;   // HKEY
  pszSubKey: PAnsiChar   // LPCSTR optional
): DWORD; stdcall;
  external 'SHLWAPI.dll' name 'SHDeleteKeyA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

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

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

関連項目

文字セット違い
使用する型