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

SHDeleteKeyW

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

シグネチャ

// SHLWAPI.dll  (Unicode / -W)
#include <windows.h>

WIN32_ERROR SHDeleteKeyW(
    HKEY hkey,
    LPCWSTR pszSubKey   // optional
);

パラメーター

名前方向説明
hkeyHKEYin

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

HKEY_CLASSES_ROOT

HKEY_CURRENT_CONFIG

HKEY_CURRENT_USER

HKEY_LOCAL_MACHINE

HKEY_PERFORMANCE_DATA

HKEY_USERS

pszSubKeyLPCWSTRinoptional

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

- hkey.HKEY_CLASSES_ROOT

- hkey.HKEY_CURRENT_CONFIG

- hkey.HKEY_CURRENT_USER

- hkey.HKEY_LOCAL_MACHINE

- hkey.HKEY_PERFORMANCE_DATA

- hkey.HKEY_USERS

戻り値の型: WIN32_ERROR

公式ドキュメント

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

戻り値

型: LSTATUS

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

解説(Remarks)

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

メモ

shlwapi.h ヘッダーは、SHDeleteKey を、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)

各言語での呼び出し定義

// SHLWAPI.dll  (Unicode / -W)
#include <windows.h>

WIN32_ERROR SHDeleteKeyW(
    HKEY hkey,
    LPCWSTR pszSubKey   // optional
);
[DllImport("SHLWAPI.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint SHDeleteKeyW(
    IntPtr hkey,   // HKEY
    [MarshalAs(UnmanagedType.LPWStr)] string pszSubKey   // LPCWSTR optional
);
<DllImport("SHLWAPI.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function SHDeleteKeyW(
    hkey As IntPtr,   ' HKEY
    <MarshalAs(UnmanagedType.LPWStr)> pszSubKey As String   ' LPCWSTR optional
) As UInteger
End Function
' hkey : HKEY
' pszSubKey : LPCWSTR optional
Declare PtrSafe Function SHDeleteKeyW Lib "shlwapi" ( _
    ByVal hkey As LongPtr, _
    ByVal pszSubKey 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

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

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

var (
	shlwapi = windows.NewLazySystemDLL("SHLWAPI.dll")
	procSHDeleteKeyW = shlwapi.NewProc("SHDeleteKeyW")
)

// hkey (HKEY), pszSubKey (LPCWSTR optional)
r1, _, err := procSHDeleteKeyW.Call(
	uintptr(hkey),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(pszSubKey))),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // WIN32_ERROR
function SHDeleteKeyW(
  hkey: THandle;   // HKEY
  pszSubKey: PWideChar   // LPCWSTR optional
): DWORD; stdcall;
  external 'SHLWAPI.dll' name 'SHDeleteKeyW';
result := DllCall("SHLWAPI\SHDeleteKeyW"
    , "Ptr", hkey   ; HKEY
    , "WStr", pszSubKey   ; LPCWSTR optional
    , "UInt")   ; return: WIN32_ERROR
●SHDeleteKeyW(hkey, pszSubKey) = DLL("SHLWAPI.dll", "dword SHDeleteKeyW(void*, char*)")
# 呼び出し: SHDeleteKeyW(hkey, pszSubKey)
# hkey : HKEY -> "void*"
# pszSubKey : LPCWSTR optional -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "shlwapi" fn SHDeleteKeyW(
    hkey: ?*anyopaque, // HKEY
    pszSubKey: [*c]const u16 // LPCWSTR optional
) callconv(std.os.windows.WINAPI) u32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc SHDeleteKeyW(
    hkey: pointer,  # HKEY
    pszSubKey: WideCString  # LPCWSTR optional
): uint32 {.importc: "SHDeleteKeyW", stdcall, dynlib: "SHLWAPI.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "shlwapi");
extern(Windows)
uint SHDeleteKeyW(
    void* hkey,   // HKEY
    const(wchar)* pszSubKey   // LPCWSTR optional
);
ccall((:SHDeleteKeyW, "SHLWAPI.dll"), stdcall, UInt32,
      (Ptr{Cvoid}, Cwstring),
      hkey, pszSubKey)
# hkey : HKEY -> Ptr{Cvoid}
# pszSubKey : LPCWSTR optional -> Cwstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
uint32_t SHDeleteKeyW(
    void* hkey,
    const uint16_t* pszSubKey);
]]
local shlwapi = ffi.load("shlwapi")
-- shlwapi.SHDeleteKeyW(hkey, pszSubKey)
-- hkey : HKEY
-- pszSubKey : 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('SHLWAPI.dll');
const SHDeleteKeyW = lib.func('__stdcall', 'SHDeleteKeyW', 'uint32_t', ['void *', 'str16']);
// SHDeleteKeyW(hkey, pszSubKey)
// hkey : HKEY -> 'void *'
// pszSubKey : LPCWSTR optional -> 'str16'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("SHLWAPI.dll", {
  SHDeleteKeyW: { parameters: ["pointer", "buffer"], result: "u32" },
});
// lib.symbols.SHDeleteKeyW(hkey, pszSubKey)
// hkey : HKEY -> "pointer"
// pszSubKey : LPCWSTR optional -> "buffer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t SHDeleteKeyW(
    void* hkey,
    const uint16_t* pszSubKey);
C, "SHLWAPI.dll");
// $ffi->SHDeleteKeyW(hkey, pszSubKey);
// hkey : HKEY
// pszSubKey : 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 Shlwapi extends StdCallLibrary {
    Shlwapi INSTANCE = Native.load("shlwapi", Shlwapi.class, W32APIOptions.UNICODE_OPTIONS);
    int SHDeleteKeyW(
        Pointer hkey,   // HKEY
        WString pszSubKey   // LPCWSTR optional
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("shlwapi")]
lib LibSHLWAPI
  fun SHDeleteKeyW = SHDeleteKeyW(
    hkey : Void*,   # HKEY
    pszSubKey : 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 SHDeleteKeyWNative = Uint32 Function(Pointer<Void>, Pointer<Utf16>);
typedef SHDeleteKeyWDart = int Function(Pointer<Void>, Pointer<Utf16>);
final SHDeleteKeyW = DynamicLibrary.open('SHLWAPI.dll')
    .lookupFunction<SHDeleteKeyWNative, SHDeleteKeyWDart>('SHDeleteKeyW');
// hkey : HKEY -> Pointer<Void>
// pszSubKey : LPCWSTR optional -> Pointer<Utf16>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SHDeleteKeyW(
  hkey: THandle;   // HKEY
  pszSubKey: PWideChar   // LPCWSTR optional
): DWORD; stdcall;
  external 'SHLWAPI.dll' name 'SHDeleteKeyW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

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

(cffi:defcfun ("SHDeleteKeyW" shdelete-key-w :convention :stdcall) :uint32
  (hkey :pointer)   ; HKEY
  (psz-sub-key (:string :encoding :utf-16le)))   ; LPCWSTR optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SHDeleteKeyW = Win32::API::More->new('SHLWAPI',
    'DWORD SHDeleteKeyW(HANDLE hkey, LPCWSTR pszSubKey)');
# my $ret = $SHDeleteKeyW->Call($hkey, $pszSubKey);
# hkey : HKEY -> HANDLE
# pszSubKey : LPCWSTR optional -> LPCWSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

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