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

SHRegDeleteEmptyUSKeyA

関数
空のユーザー単位レジストリサブキーを削除する。
DLLSHLWAPI.dll文字セットANSI (-A)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

WIN32_ERROR SHRegDeleteEmptyUSKeyA(
    INT_PTR hUSKey,
    LPCSTR pszSubKey,
    SHREGDEL_FLAGS delRegFlags
);

パラメーター

名前方向説明
hUSKeyINT_PTRin

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

このハンドルは SHRegOpenUSKey 関数を通じて取得できます。

pszSubKeyLPCSTRin削除する空のユーザー定義レジストリサブキーを指定する、null で終わる文字列へのポインター。
delRegFlagsSHREGDEL_FLAGSinどのベースキーからサブキーを削除するかを指定する SHREGDEL_FLAGS のいずれか。

戻り値の型: WIN32_ERROR

公式ドキュメント

ユーザー固有のサブツリー(HKEY_CURRENT_USER または HKEY_LOCAL_MACHINE)内の空のレジストリサブキーを削除します。(ANSI)

戻り値

型: LSTATUS

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

解説(Remarks)

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 SHRegDeleteEmptyUSKeyA(
    INT_PTR hUSKey,
    LPCSTR pszSubKey,
    SHREGDEL_FLAGS delRegFlags
);
[DllImport("SHLWAPI.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint SHRegDeleteEmptyUSKeyA(
    IntPtr hUSKey,   // INT_PTR
    [MarshalAs(UnmanagedType.LPStr)] string pszSubKey,   // LPCSTR
    int delRegFlags   // SHREGDEL_FLAGS
);
<DllImport("SHLWAPI.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function SHRegDeleteEmptyUSKeyA(
    hUSKey As IntPtr,   ' INT_PTR
    <MarshalAs(UnmanagedType.LPStr)> pszSubKey As String,   ' LPCSTR
    delRegFlags As Integer   ' SHREGDEL_FLAGS
) As UInteger
End Function
' hUSKey : INT_PTR
' pszSubKey : LPCSTR
' delRegFlags : SHREGDEL_FLAGS
Declare PtrSafe Function SHRegDeleteEmptyUSKeyA Lib "shlwapi" ( _
    ByVal hUSKey As LongPtr, _
    ByVal pszSubKey As String, _
    ByVal delRegFlags As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SHRegDeleteEmptyUSKeyA = ctypes.windll.shlwapi.SHRegDeleteEmptyUSKeyA
SHRegDeleteEmptyUSKeyA.restype = wintypes.DWORD
SHRegDeleteEmptyUSKeyA.argtypes = [
    ctypes.c_ssize_t,  # hUSKey : INT_PTR
    wintypes.LPCSTR,  # pszSubKey : LPCSTR
    ctypes.c_int,  # delRegFlags : SHREGDEL_FLAGS
]
require 'fiddle'
require 'fiddle/import'

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

var (
	shlwapi = windows.NewLazySystemDLL("SHLWAPI.dll")
	procSHRegDeleteEmptyUSKeyA = shlwapi.NewProc("SHRegDeleteEmptyUSKeyA")
)

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

extern "shlwapi" fn SHRegDeleteEmptyUSKeyA(
    hUSKey: isize, // INT_PTR
    pszSubKey: [*c]const u8, // LPCSTR
    delRegFlags: i32 // SHREGDEL_FLAGS
) callconv(std.os.windows.WINAPI) u32;
proc SHRegDeleteEmptyUSKeyA(
    hUSKey: int,  # INT_PTR
    pszSubKey: cstring,  # LPCSTR
    delRegFlags: int32  # SHREGDEL_FLAGS
): uint32 {.importc: "SHRegDeleteEmptyUSKeyA", stdcall, dynlib: "SHLWAPI.dll".}
pragma(lib, "shlwapi");
extern(Windows)
uint SHRegDeleteEmptyUSKeyA(
    ptrdiff_t hUSKey,   // INT_PTR
    const(char)* pszSubKey,   // LPCSTR
    int delRegFlags   // SHREGDEL_FLAGS
);
ccall((:SHRegDeleteEmptyUSKeyA, "SHLWAPI.dll"), stdcall, UInt32,
      (Int, Cstring, Int32),
      hUSKey, pszSubKey, delRegFlags)
# hUSKey : INT_PTR -> Int
# pszSubKey : LPCSTR -> Cstring
# delRegFlags : SHREGDEL_FLAGS -> Int32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t SHRegDeleteEmptyUSKeyA(
    intptr_t hUSKey,
    const char* pszSubKey,
    int32_t delRegFlags);
]]
local shlwapi = ffi.load("shlwapi")
-- shlwapi.SHRegDeleteEmptyUSKeyA(hUSKey, pszSubKey, delRegFlags)
-- hUSKey : INT_PTR
-- pszSubKey : LPCSTR
-- delRegFlags : SHREGDEL_FLAGS
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('SHLWAPI.dll');
const SHRegDeleteEmptyUSKeyA = lib.func('__stdcall', 'SHRegDeleteEmptyUSKeyA', 'uint32_t', ['intptr_t', 'str', 'int32_t']);
// SHRegDeleteEmptyUSKeyA(hUSKey, pszSubKey, delRegFlags)
// hUSKey : INT_PTR -> 'intptr_t'
// pszSubKey : LPCSTR -> 'str'
// delRegFlags : SHREGDEL_FLAGS -> 'int32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("SHLWAPI.dll", {
  SHRegDeleteEmptyUSKeyA: { parameters: ["isize", "buffer", "i32"], result: "u32" },
});
// lib.symbols.SHRegDeleteEmptyUSKeyA(hUSKey, pszSubKey, delRegFlags)
// hUSKey : INT_PTR -> "isize"
// pszSubKey : LPCSTR -> "buffer"
// delRegFlags : SHREGDEL_FLAGS -> "i32"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t SHRegDeleteEmptyUSKeyA(
    intptr_t hUSKey,
    const char* pszSubKey,
    int32_t delRegFlags);
C, "SHLWAPI.dll");
// $ffi->SHRegDeleteEmptyUSKeyA(hUSKey, pszSubKey, delRegFlags);
// hUSKey : INT_PTR
// pszSubKey : LPCSTR
// delRegFlags : SHREGDEL_FLAGS
// 構造体/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 SHRegDeleteEmptyUSKeyA(
        long hUSKey,   // INT_PTR
        String pszSubKey,   // LPCSTR
        int delRegFlags   // SHREGDEL_FLAGS
    );
}
@[Link("shlwapi")]
lib LibSHLWAPI
  fun SHRegDeleteEmptyUSKeyA = SHRegDeleteEmptyUSKeyA(
    hUSKey : LibC::SSizeT,   # INT_PTR
    pszSubKey : UInt8*,   # LPCSTR
    delRegFlags : Int32   # SHREGDEL_FLAGS
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef SHRegDeleteEmptyUSKeyANative = Uint32 Function(IntPtr, Pointer<Utf8>, Int32);
typedef SHRegDeleteEmptyUSKeyADart = int Function(int, Pointer<Utf8>, int);
final SHRegDeleteEmptyUSKeyA = DynamicLibrary.open('SHLWAPI.dll')
    .lookupFunction<SHRegDeleteEmptyUSKeyANative, SHRegDeleteEmptyUSKeyADart>('SHRegDeleteEmptyUSKeyA');
// hUSKey : INT_PTR -> IntPtr
// pszSubKey : LPCSTR -> Pointer<Utf8>
// delRegFlags : SHREGDEL_FLAGS -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SHRegDeleteEmptyUSKeyA(
  hUSKey: NativeInt;   // INT_PTR
  pszSubKey: PAnsiChar;   // LPCSTR
  delRegFlags: Integer   // SHREGDEL_FLAGS
): DWORD; stdcall;
  external 'SHLWAPI.dll' name 'SHRegDeleteEmptyUSKeyA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SHRegDeleteEmptyUSKeyA"
  c_SHRegDeleteEmptyUSKeyA :: CIntPtr -> CString -> Int32 -> IO Word32
-- hUSKey : INT_PTR -> CIntPtr
-- pszSubKey : LPCSTR -> CString
-- delRegFlags : SHREGDEL_FLAGS -> Int32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let shregdeleteemptyuskeya =
  foreign "SHRegDeleteEmptyUSKeyA"
    (intptr_t @-> string @-> int32_t @-> returning uint32_t)
(* hUSKey : INT_PTR -> intptr_t *)
(* pszSubKey : LPCSTR -> string *)
(* delRegFlags : SHREGDEL_FLAGS -> int32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library shlwapi (t "SHLWAPI.dll"))
(cffi:use-foreign-library shlwapi)

(cffi:defcfun ("SHRegDeleteEmptyUSKeyA" shreg-delete-empty-uskey-a :convention :stdcall) :uint32
  (h-uskey :int64)   ; INT_PTR
  (psz-sub-key :string)   ; LPCSTR
  (del-reg-flags :int32))   ; SHREGDEL_FLAGS
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SHRegDeleteEmptyUSKeyA = Win32::API::More->new('SHLWAPI',
    'DWORD SHRegDeleteEmptyUSKeyA(LPARAM hUSKey, LPCSTR pszSubKey, int delRegFlags)');
# my $ret = $SHRegDeleteEmptyUSKeyA->Call($hUSKey, $pszSubKey, $delRegFlags);
# hUSKey : INT_PTR -> LPARAM
# pszSubKey : LPCSTR -> LPCSTR
# delRegFlags : SHREGDEL_FLAGS -> int
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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