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

RegDeleteKeyValueA

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

シグネチャ

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

WIN32_ERROR RegDeleteKeyValueA(
    HKEY hKey,
    LPCSTR lpSubKey,   // optional
    LPCSTR lpValueName   // optional
);

パラメーター

名前方向説明
hKeyHKEYin

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

このハンドルは RegCreateKeyEx 関数または RegOpenKeyEx 関数によって返されます。あるいは、次の 事前定義済みキー のいずれかを指定することもできます。


   HKEY_CLASSES_ROOT
   HKEY_CURRENT_CONFIG
   HKEY_CURRENT_USER
   HKEY_LOCAL_MACHINE
   HKEY_USERS
lpSubKeyLPCSTRinoptionalレジストリ キーの名前。このキーは、hKey パラメーターで識別されるキーのサブキーである必要があります。
lpValueNameLPCSTRinoptionalキーから削除するレジストリ値。

戻り値の型: WIN32_ERROR

公式ドキュメント

指定したレジストリ キーおよびサブキーから、指定した値を削除します。(ANSI)

戻り値

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

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

解説(Remarks)

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

メモ

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

メモ

winreg.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして RegDeleteKeyValue を定義します。エンコード ニュートラルなエイリアスの使用を、エンコード ニュートラルでないコードと混在させると、不一致が発生し、コンパイル エラーまたは実行時エラーの原因となることがあります。詳細については、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 RegDeleteKeyValueA(
    HKEY hKey,
    LPCSTR lpSubKey,   // optional
    LPCSTR lpValueName   // optional
);
[DllImport("ADVAPI32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint RegDeleteKeyValueA(
    IntPtr hKey,   // HKEY
    [MarshalAs(UnmanagedType.LPStr)] string lpSubKey,   // LPCSTR optional
    [MarshalAs(UnmanagedType.LPStr)] string lpValueName   // LPCSTR optional
);
<DllImport("ADVAPI32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function RegDeleteKeyValueA(
    hKey As IntPtr,   ' HKEY
    <MarshalAs(UnmanagedType.LPStr)> lpSubKey As String,   ' LPCSTR optional
    <MarshalAs(UnmanagedType.LPStr)> lpValueName As String   ' LPCSTR optional
) As UInteger
End Function
' hKey : HKEY
' lpSubKey : LPCSTR optional
' lpValueName : LPCSTR optional
Declare PtrSafe Function RegDeleteKeyValueA Lib "advapi32" ( _
    ByVal hKey As LongPtr, _
    ByVal lpSubKey As String, _
    ByVal lpValueName As String) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

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

lib = Fiddle.dlopen('ADVAPI32.dll')
RegDeleteKeyValueA = Fiddle::Function.new(
  lib['RegDeleteKeyValueA'],
  [
    Fiddle::TYPE_VOIDP,  # hKey : HKEY
    Fiddle::TYPE_VOIDP,  # lpSubKey : LPCSTR optional
    Fiddle::TYPE_VOIDP,  # lpValueName : LPCSTR optional
  ],
  -Fiddle::TYPE_INT)
#[link(name = "advapi32")]
extern "system" {
    fn RegDeleteKeyValueA(
        hKey: *mut core::ffi::c_void,  // HKEY
        lpSubKey: *const u8,  // LPCSTR optional
        lpValueName: *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 RegDeleteKeyValueA(IntPtr hKey, [MarshalAs(UnmanagedType.LPStr)] string lpSubKey, [MarshalAs(UnmanagedType.LPStr)] string lpValueName);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_RegDeleteKeyValueA' -Namespace Win32 -PassThru
# $api::RegDeleteKeyValueA(hKey, lpSubKey, lpValueName)
#uselib "ADVAPI32.dll"
#func global RegDeleteKeyValueA "RegDeleteKeyValueA" sptr, sptr, sptr
; RegDeleteKeyValueA hKey, lpSubKey, lpValueName   ; 戻り値は stat
; hKey : HKEY -> "sptr"
; lpSubKey : LPCSTR optional -> "sptr"
; lpValueName : LPCSTR optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "ADVAPI32.dll"
#cfunc global RegDeleteKeyValueA "RegDeleteKeyValueA" sptr, str, str
; res = RegDeleteKeyValueA(hKey, lpSubKey, lpValueName)
; hKey : HKEY -> "sptr"
; lpSubKey : LPCSTR optional -> "str"
; lpValueName : LPCSTR optional -> "str"
; WIN32_ERROR RegDeleteKeyValueA(HKEY hKey, LPCSTR lpSubKey, LPCSTR lpValueName)
#uselib "ADVAPI32.dll"
#cfunc global RegDeleteKeyValueA "RegDeleteKeyValueA" intptr, str, str
; res = RegDeleteKeyValueA(hKey, lpSubKey, lpValueName)
; hKey : HKEY -> "intptr"
; lpSubKey : LPCSTR optional -> "str"
; lpValueName : LPCSTR optional -> "str"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	advapi32 = windows.NewLazySystemDLL("ADVAPI32.dll")
	procRegDeleteKeyValueA = advapi32.NewProc("RegDeleteKeyValueA")
)

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

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

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

let regdeletekeyvaluea =
  foreign "RegDeleteKeyValueA"
    ((ptr void) @-> string @-> string @-> returning uint32_t)
(* hKey : HKEY -> (ptr void) *)
(* lpSubKey : LPCSTR optional -> string *)
(* lpValueName : 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 ("RegDeleteKeyValueA" reg-delete-key-value-a :convention :stdcall) :uint32
  (h-key :pointer)   ; HKEY
  (lp-sub-key :string)   ; LPCSTR optional
  (lp-value-name :string))   ; LPCSTR optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $RegDeleteKeyValueA = Win32::API::More->new('ADVAPI32',
    'DWORD RegDeleteKeyValueA(HANDLE hKey, LPCSTR lpSubKey, LPCSTR lpValueName)');
# my $ret = $RegDeleteKeyValueA->Call($hKey, $lpSubKey, $lpValueName);
# hKey : HKEY -> HANDLE
# lpSubKey : LPCSTR optional -> LPCSTR
# lpValueName : LPCSTR optional -> LPCSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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