RegDeleteKeyTransactedA
関数シグネチャ
// ADVAPI32.dll (ANSI / -A)
#include <windows.h>
WIN32_ERROR RegDeleteKeyTransactedA(
HKEY hKey,
LPCSTR lpSubKey,
DWORD samDesired,
DWORD Reserved, // optional
HANDLE hTransaction,
void* pExtendedParameter // optional
);パラメーター
| 名前 | 型 | 方向 | 説明 | ||||||
|---|---|---|---|---|---|---|---|---|---|
| hKey | HKEY | in | 開いているレジストリキーへのハンドル。このキーのアクセス権は削除操作に影響しません。アクセス権の詳細については、 レジストリキーのセキュリティとアクセス権を参照してください。 このハンドルは、 RegCreateKeyEx、RegCreateKeyTransacted、RegOpenKeyEx、または RegOpenKeyTransacted 関数によって返されます。次の 定義済みキーのいずれかを指定することもできます: | ||||||
| lpSubKey | LPCSTR | in | 削除するキーの名前。このキーは、hKey パラメーターの値で指定されたキーのサブキーである必要があります。 この関数は、サブキーを DELETE アクセス権で開きます。 キー名は大文字と小文字を区別しません。 このパラメーターの値を NULL にすることはできません。 | ||||||
| samDesired | DWORD | in | プラットフォーム固有のレジストリビューを指定するアクセスマスク。
| ||||||
| Reserved | DWORD | optional | このパラメーターは予約されており、ゼロである必要があります。 | ||||||
| hTransaction | HANDLE | in | アクティブなトランザクションへのハンドル。このハンドルは、CreateTransaction 関数によって返されます。 | ||||||
| pExtendedParameter | void* | optional | このパラメーターは予約されており、NULL である必要があります。 |
戻り値の型: WIN32_ERROR
公式ドキュメント
指定したプラットフォーム固有のレジストリビューから、サブキーとその値をトランザクション操作として削除します。(ANSI)
戻り値
関数が成功した場合、戻り値は ERROR_SUCCESS です。
関数が失敗した場合、戻り値は Winerror.h で定義されている 0 以外のエラーコードです。FormatMessage 関数を FORMAT_MESSAGE_FROM_SYSTEM フラグとともに使用すると、エラーの一般的な説明を取得できます。
解説(Remarks)
削除されたキーは、それに対する最後のハンドルが閉じられるまで除去されません。
WOW64 では、32 ビットアプリケーションは 64 ビットアプリケーションが参照するレジストリツリーとは別のレジストリツリーを参照します。この関数を使用すると、アプリケーションは代替のレジストリビュー内のエントリを削除できます。
削除するサブキーにサブキーが存在してはなりません。キーとそのすべてのサブキーを削除するには、サブキーを列挙して個別に削除する必要があります。キーを再帰的に削除するには、 RegDeleteTree 関数または SHDeleteKey 関数を使用してください。
関数が成功すると、RegDeleteKeyTransacted は指定したキーをレジストリから除去します。すべての値を含むキー全体が除去されます。ツリー全体をトランザクション操作として除去するには、RegCreateKeyTransacted または RegOpenKeyTransacted から返されたハンドルを RegDeleteTree 関数とともに使用します。
winreg.h ヘッダーは RegDeleteKeyTransacted をエイリアスとして定義し、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択します。エンコーディング中立のエイリアスの使用を、エンコーディング中立でないコードと混在させると、不一致が生じてコンパイルエラーまたは実行時エラーを引き起こす可能性があります。詳細については、関数プロトタイプの規則を参照してください。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// ADVAPI32.dll (ANSI / -A)
#include <windows.h>
WIN32_ERROR RegDeleteKeyTransactedA(
HKEY hKey,
LPCSTR lpSubKey,
DWORD samDesired,
DWORD Reserved, // optional
HANDLE hTransaction,
void* pExtendedParameter // optional
);[DllImport("ADVAPI32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint RegDeleteKeyTransactedA(
IntPtr hKey, // HKEY
[MarshalAs(UnmanagedType.LPStr)] string lpSubKey, // LPCSTR
uint samDesired, // DWORD
uint Reserved, // DWORD optional
IntPtr hTransaction, // HANDLE
IntPtr pExtendedParameter // void* optional
);<DllImport("ADVAPI32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function RegDeleteKeyTransactedA(
hKey As IntPtr, ' HKEY
<MarshalAs(UnmanagedType.LPStr)> lpSubKey As String, ' LPCSTR
samDesired As UInteger, ' DWORD
Reserved As UInteger, ' DWORD optional
hTransaction As IntPtr, ' HANDLE
pExtendedParameter As IntPtr ' void* optional
) As UInteger
End Function' hKey : HKEY
' lpSubKey : LPCSTR
' samDesired : DWORD
' Reserved : DWORD optional
' hTransaction : HANDLE
' pExtendedParameter : void* optional
Declare PtrSafe Function RegDeleteKeyTransactedA Lib "advapi32" ( _
ByVal hKey As LongPtr, _
ByVal lpSubKey As String, _
ByVal samDesired As Long, _
ByVal Reserved As Long, _
ByVal hTransaction As LongPtr, _
ByVal pExtendedParameter As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
RegDeleteKeyTransactedA = ctypes.windll.advapi32.RegDeleteKeyTransactedA
RegDeleteKeyTransactedA.restype = wintypes.DWORD
RegDeleteKeyTransactedA.argtypes = [
wintypes.HANDLE, # hKey : HKEY
wintypes.LPCSTR, # lpSubKey : LPCSTR
wintypes.DWORD, # samDesired : DWORD
wintypes.DWORD, # Reserved : DWORD optional
wintypes.HANDLE, # hTransaction : HANDLE
ctypes.POINTER(None), # pExtendedParameter : void* optional
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('ADVAPI32.dll')
RegDeleteKeyTransactedA = Fiddle::Function.new(
lib['RegDeleteKeyTransactedA'],
[
Fiddle::TYPE_VOIDP, # hKey : HKEY
Fiddle::TYPE_VOIDP, # lpSubKey : LPCSTR
-Fiddle::TYPE_INT, # samDesired : DWORD
-Fiddle::TYPE_INT, # Reserved : DWORD optional
Fiddle::TYPE_VOIDP, # hTransaction : HANDLE
Fiddle::TYPE_VOIDP, # pExtendedParameter : void* optional
],
-Fiddle::TYPE_INT)#[link(name = "advapi32")]
extern "system" {
fn RegDeleteKeyTransactedA(
hKey: *mut core::ffi::c_void, // HKEY
lpSubKey: *const u8, // LPCSTR
samDesired: u32, // DWORD
Reserved: u32, // DWORD optional
hTransaction: *mut core::ffi::c_void, // HANDLE
pExtendedParameter: *mut () // void* optional
) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("ADVAPI32.dll", CharSet = CharSet.Ansi)]
public static extern uint RegDeleteKeyTransactedA(IntPtr hKey, [MarshalAs(UnmanagedType.LPStr)] string lpSubKey, uint samDesired, uint Reserved, IntPtr hTransaction, IntPtr pExtendedParameter);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_RegDeleteKeyTransactedA' -Namespace Win32 -PassThru
# $api::RegDeleteKeyTransactedA(hKey, lpSubKey, samDesired, Reserved, hTransaction, pExtendedParameter)#uselib "ADVAPI32.dll"
#func global RegDeleteKeyTransactedA "RegDeleteKeyTransactedA" sptr, sptr, sptr, sptr, sptr, sptr
; RegDeleteKeyTransactedA hKey, lpSubKey, samDesired, Reserved, hTransaction, pExtendedParameter ; 戻り値は stat
; hKey : HKEY -> "sptr"
; lpSubKey : LPCSTR -> "sptr"
; samDesired : DWORD -> "sptr"
; Reserved : DWORD optional -> "sptr"
; hTransaction : HANDLE -> "sptr"
; pExtendedParameter : void* optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "ADVAPI32.dll"
#cfunc global RegDeleteKeyTransactedA "RegDeleteKeyTransactedA" sptr, str, int, int, sptr, sptr
; res = RegDeleteKeyTransactedA(hKey, lpSubKey, samDesired, Reserved, hTransaction, pExtendedParameter)
; hKey : HKEY -> "sptr"
; lpSubKey : LPCSTR -> "str"
; samDesired : DWORD -> "int"
; Reserved : DWORD optional -> "int"
; hTransaction : HANDLE -> "sptr"
; pExtendedParameter : void* optional -> "sptr"; WIN32_ERROR RegDeleteKeyTransactedA(HKEY hKey, LPCSTR lpSubKey, DWORD samDesired, DWORD Reserved, HANDLE hTransaction, void* pExtendedParameter)
#uselib "ADVAPI32.dll"
#cfunc global RegDeleteKeyTransactedA "RegDeleteKeyTransactedA" intptr, str, int, int, intptr, intptr
; res = RegDeleteKeyTransactedA(hKey, lpSubKey, samDesired, Reserved, hTransaction, pExtendedParameter)
; hKey : HKEY -> "intptr"
; lpSubKey : LPCSTR -> "str"
; samDesired : DWORD -> "int"
; Reserved : DWORD optional -> "int"
; hTransaction : HANDLE -> "intptr"
; pExtendedParameter : void* optional -> "intptr"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
advapi32 = windows.NewLazySystemDLL("ADVAPI32.dll")
procRegDeleteKeyTransactedA = advapi32.NewProc("RegDeleteKeyTransactedA")
)
// hKey (HKEY), lpSubKey (LPCSTR), samDesired (DWORD), Reserved (DWORD optional), hTransaction (HANDLE), pExtendedParameter (void* optional)
r1, _, err := procRegDeleteKeyTransactedA.Call(
uintptr(hKey),
uintptr(unsafe.Pointer(windows.BytePtrFromString(lpSubKey))),
uintptr(samDesired),
uintptr(Reserved),
uintptr(hTransaction),
uintptr(pExtendedParameter),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // WIN32_ERRORfunction RegDeleteKeyTransactedA(
hKey: THandle; // HKEY
lpSubKey: PAnsiChar; // LPCSTR
samDesired: DWORD; // DWORD
Reserved: DWORD; // DWORD optional
hTransaction: THandle; // HANDLE
pExtendedParameter: Pointer // void* optional
): DWORD; stdcall;
external 'ADVAPI32.dll' name 'RegDeleteKeyTransactedA';result := DllCall("ADVAPI32\RegDeleteKeyTransactedA"
, "Ptr", hKey ; HKEY
, "AStr", lpSubKey ; LPCSTR
, "UInt", samDesired ; DWORD
, "UInt", Reserved ; DWORD optional
, "Ptr", hTransaction ; HANDLE
, "Ptr", pExtendedParameter ; void* optional
, "UInt") ; return: WIN32_ERROR●RegDeleteKeyTransactedA(hKey, lpSubKey, samDesired, Reserved, hTransaction, pExtendedParameter) = DLL("ADVAPI32.dll", "dword RegDeleteKeyTransactedA(void*, char*, dword, dword, void*, void*)")
# 呼び出し: RegDeleteKeyTransactedA(hKey, lpSubKey, samDesired, Reserved, hTransaction, pExtendedParameter)
# hKey : HKEY -> "void*"
# lpSubKey : LPCSTR -> "char*"
# samDesired : DWORD -> "dword"
# Reserved : DWORD optional -> "dword"
# hTransaction : HANDLE -> "void*"
# pExtendedParameter : void* optional -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "advapi32" fn RegDeleteKeyTransactedA(
hKey: ?*anyopaque, // HKEY
lpSubKey: [*c]const u8, // LPCSTR
samDesired: u32, // DWORD
Reserved: u32, // DWORD optional
hTransaction: ?*anyopaque, // HANDLE
pExtendedParameter: ?*anyopaque // void* optional
) callconv(std.os.windows.WINAPI) u32;proc RegDeleteKeyTransactedA(
hKey: pointer, # HKEY
lpSubKey: cstring, # LPCSTR
samDesired: uint32, # DWORD
Reserved: uint32, # DWORD optional
hTransaction: pointer, # HANDLE
pExtendedParameter: pointer # void* optional
): uint32 {.importc: "RegDeleteKeyTransactedA", stdcall, dynlib: "ADVAPI32.dll".}pragma(lib, "advapi32");
extern(Windows)
uint RegDeleteKeyTransactedA(
void* hKey, // HKEY
const(char)* lpSubKey, // LPCSTR
uint samDesired, // DWORD
uint Reserved, // DWORD optional
void* hTransaction, // HANDLE
void* pExtendedParameter // void* optional
);ccall((:RegDeleteKeyTransactedA, "ADVAPI32.dll"), stdcall, UInt32,
(Ptr{Cvoid}, Cstring, UInt32, UInt32, Ptr{Cvoid}, Ptr{Cvoid}),
hKey, lpSubKey, samDesired, Reserved, hTransaction, pExtendedParameter)
# hKey : HKEY -> Ptr{Cvoid}
# lpSubKey : LPCSTR -> Cstring
# samDesired : DWORD -> UInt32
# Reserved : DWORD optional -> UInt32
# hTransaction : HANDLE -> Ptr{Cvoid}
# pExtendedParameter : void* optional -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
uint32_t RegDeleteKeyTransactedA(
void* hKey,
const char* lpSubKey,
uint32_t samDesired,
uint32_t Reserved,
void* hTransaction,
void* pExtendedParameter);
]]
local advapi32 = ffi.load("advapi32")
-- advapi32.RegDeleteKeyTransactedA(hKey, lpSubKey, samDesired, Reserved, hTransaction, pExtendedParameter)
-- hKey : HKEY
-- lpSubKey : LPCSTR
-- samDesired : DWORD
-- Reserved : DWORD optional
-- hTransaction : HANDLE
-- pExtendedParameter : void* optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('ADVAPI32.dll');
const RegDeleteKeyTransactedA = lib.func('__stdcall', 'RegDeleteKeyTransactedA', 'uint32_t', ['void *', 'str', 'uint32_t', 'uint32_t', 'void *', 'void *']);
// RegDeleteKeyTransactedA(hKey, lpSubKey, samDesired, Reserved, hTransaction, pExtendedParameter)
// hKey : HKEY -> 'void *'
// lpSubKey : LPCSTR -> 'str'
// samDesired : DWORD -> 'uint32_t'
// Reserved : DWORD optional -> 'uint32_t'
// hTransaction : HANDLE -> 'void *'
// pExtendedParameter : void* optional -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("ADVAPI32.dll", {
RegDeleteKeyTransactedA: { parameters: ["pointer", "buffer", "u32", "u32", "pointer", "pointer"], result: "u32" },
});
// lib.symbols.RegDeleteKeyTransactedA(hKey, lpSubKey, samDesired, Reserved, hTransaction, pExtendedParameter)
// hKey : HKEY -> "pointer"
// lpSubKey : LPCSTR -> "buffer"
// samDesired : DWORD -> "u32"
// Reserved : DWORD optional -> "u32"
// hTransaction : HANDLE -> "pointer"
// pExtendedParameter : void* optional -> "pointer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
uint32_t RegDeleteKeyTransactedA(
void* hKey,
const char* lpSubKey,
uint32_t samDesired,
uint32_t Reserved,
void* hTransaction,
void* pExtendedParameter);
C, "ADVAPI32.dll");
// $ffi->RegDeleteKeyTransactedA(hKey, lpSubKey, samDesired, Reserved, hTransaction, pExtendedParameter);
// hKey : HKEY
// lpSubKey : LPCSTR
// samDesired : DWORD
// Reserved : DWORD optional
// hTransaction : HANDLE
// pExtendedParameter : void* 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 RegDeleteKeyTransactedA(
Pointer hKey, // HKEY
String lpSubKey, // LPCSTR
int samDesired, // DWORD
int Reserved, // DWORD optional
Pointer hTransaction, // HANDLE
Pointer pExtendedParameter // void* optional
);
}@[Link("advapi32")]
lib LibADVAPI32
fun RegDeleteKeyTransactedA = RegDeleteKeyTransactedA(
hKey : Void*, # HKEY
lpSubKey : UInt8*, # LPCSTR
samDesired : UInt32, # DWORD
Reserved : UInt32, # DWORD optional
hTransaction : Void*, # HANDLE
pExtendedParameter : Void* # void* optional
) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef RegDeleteKeyTransactedANative = Uint32 Function(Pointer<Void>, Pointer<Utf8>, Uint32, Uint32, Pointer<Void>, Pointer<Void>);
typedef RegDeleteKeyTransactedADart = int Function(Pointer<Void>, Pointer<Utf8>, int, int, Pointer<Void>, Pointer<Void>);
final RegDeleteKeyTransactedA = DynamicLibrary.open('ADVAPI32.dll')
.lookupFunction<RegDeleteKeyTransactedANative, RegDeleteKeyTransactedADart>('RegDeleteKeyTransactedA');
// hKey : HKEY -> Pointer<Void>
// lpSubKey : LPCSTR -> Pointer<Utf8>
// samDesired : DWORD -> Uint32
// Reserved : DWORD optional -> Uint32
// hTransaction : HANDLE -> Pointer<Void>
// pExtendedParameter : void* optional -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function RegDeleteKeyTransactedA(
hKey: THandle; // HKEY
lpSubKey: PAnsiChar; // LPCSTR
samDesired: DWORD; // DWORD
Reserved: DWORD; // DWORD optional
hTransaction: THandle; // HANDLE
pExtendedParameter: Pointer // void* optional
): DWORD; stdcall;
external 'ADVAPI32.dll' name 'RegDeleteKeyTransactedA';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "RegDeleteKeyTransactedA"
c_RegDeleteKeyTransactedA :: Ptr () -> CString -> Word32 -> Word32 -> Ptr () -> Ptr () -> IO Word32
-- hKey : HKEY -> Ptr ()
-- lpSubKey : LPCSTR -> CString
-- samDesired : DWORD -> Word32
-- Reserved : DWORD optional -> Word32
-- hTransaction : HANDLE -> Ptr ()
-- pExtendedParameter : void* optional -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let regdeletekeytransacteda =
foreign "RegDeleteKeyTransactedA"
((ptr void) @-> string @-> uint32_t @-> uint32_t @-> (ptr void) @-> (ptr void) @-> returning uint32_t)
(* hKey : HKEY -> (ptr void) *)
(* lpSubKey : LPCSTR -> string *)
(* samDesired : DWORD -> uint32_t *)
(* Reserved : DWORD optional -> uint32_t *)
(* hTransaction : HANDLE -> (ptr void) *)
(* pExtendedParameter : void* optional -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library advapi32 (t "ADVAPI32.dll"))
(cffi:use-foreign-library advapi32)
(cffi:defcfun ("RegDeleteKeyTransactedA" reg-delete-key-transacted-a :convention :stdcall) :uint32
(h-key :pointer) ; HKEY
(lp-sub-key :string) ; LPCSTR
(sam-desired :uint32) ; DWORD
(reserved :uint32) ; DWORD optional
(h-transaction :pointer) ; HANDLE
(p-extended-parameter :pointer)) ; void* optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $RegDeleteKeyTransactedA = Win32::API::More->new('ADVAPI32',
'DWORD RegDeleteKeyTransactedA(HANDLE hKey, LPCSTR lpSubKey, DWORD samDesired, DWORD Reserved, HANDLE hTransaction, LPVOID pExtendedParameter)');
# my $ret = $RegDeleteKeyTransactedA->Call($hKey, $lpSubKey, $samDesired, $Reserved, $hTransaction, $pExtendedParameter);
# hKey : HKEY -> HANDLE
# lpSubKey : LPCSTR -> LPCSTR
# samDesired : DWORD -> DWORD
# Reserved : DWORD optional -> DWORD
# hTransaction : HANDLE -> HANDLE
# pExtendedParameter : void* optional -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
- f RegDeleteKeyTransactedW (Unicode版) — トランザクション処理でレジストリのサブキーを削除する。
- f RegCreateKeyTransactedA — トランザクション処理でレジストリキーを作成または開く。
- f RegOpenKeyTransactedA — トランザクション処理でレジストリキーを開く。