SHRegDeleteEmptyUSKeyW
関数シグネチャ
// SHLWAPI.dll (Unicode / -W)
#include <windows.h>
WIN32_ERROR SHRegDeleteEmptyUSKeyW(
INT_PTR hUSKey,
LPCWSTR pwzSubKey,
SHREGDEL_FLAGS delRegFlags
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| hUSKey | INT_PTR | in | 現在開いているレジストリ サブキーのハンドル。このサブキーは KEY_SET_VALUE アクセス権で開かれている必要があります。詳細については、Registry Key Security and Access Rights を参照してください。 このハンドルは SHRegOpenUSKey 関数を通じて取得できます。 |
| pwzSubKey | LPCWSTR | in | 未定 (TBD) |
| delRegFlags | SHREGDEL_FLAGS | in | サブキーをどのベース キーから削除するかを指定する SHREGDEL_FLAGS のいずれか。 - pszSubKey [in]型: LPCSTR 削除する空のユーザー定義レジストリ サブキーを指定する null 終端文字列へのポインター。 |
戻り値の型: WIN32_ERROR
公式ドキュメント
ユーザー固有のサブツリー(HKEY_CURRENT_USER または HKEY_LOCAL_MACHINE)内の空のレジストリ サブキーを削除します。(Unicode)
戻り値
型: LSTATUS
成功した場合は ERROR_SUCCESS を返し、それ以外の場合は Winerror.h で定義されている 0 以外のエラー コードを返します。FormatMessage 関数を FORMAT_MESSAGE_FROM_SYSTEM フラグとともに使用すると、エラーの一般的な説明を取得できます。
解説(Remarks)
shlwapi.h ヘッダーは SHRegDeleteEmptyUSKey を、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして定義します。エンコーディング非依存のエイリアスの使用を、エンコーディング非依存でないコードと混在させると、不一致が生じてコンパイル エラーや実行時エラーの原因となる場合があります。詳細については、Conventions for Function Prototypes を参照してください。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// SHLWAPI.dll (Unicode / -W)
#include <windows.h>
WIN32_ERROR SHRegDeleteEmptyUSKeyW(
INT_PTR hUSKey,
LPCWSTR pwzSubKey,
SHREGDEL_FLAGS delRegFlags
);[DllImport("SHLWAPI.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint SHRegDeleteEmptyUSKeyW(
IntPtr hUSKey, // INT_PTR
[MarshalAs(UnmanagedType.LPWStr)] string pwzSubKey, // LPCWSTR
int delRegFlags // SHREGDEL_FLAGS
);<DllImport("SHLWAPI.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function SHRegDeleteEmptyUSKeyW(
hUSKey As IntPtr, ' INT_PTR
<MarshalAs(UnmanagedType.LPWStr)> pwzSubKey As String, ' LPCWSTR
delRegFlags As Integer ' SHREGDEL_FLAGS
) As UInteger
End Function' hUSKey : INT_PTR
' pwzSubKey : LPCWSTR
' delRegFlags : SHREGDEL_FLAGS
Declare PtrSafe Function SHRegDeleteEmptyUSKeyW Lib "shlwapi" ( _
ByVal hUSKey As LongPtr, _
ByVal pwzSubKey As LongPtr, _
ByVal delRegFlags As Long) 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
SHRegDeleteEmptyUSKeyW = ctypes.windll.shlwapi.SHRegDeleteEmptyUSKeyW
SHRegDeleteEmptyUSKeyW.restype = wintypes.DWORD
SHRegDeleteEmptyUSKeyW.argtypes = [
ctypes.c_ssize_t, # hUSKey : INT_PTR
wintypes.LPCWSTR, # pwzSubKey : LPCWSTR
ctypes.c_int, # delRegFlags : SHREGDEL_FLAGS
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('SHLWAPI.dll')
SHRegDeleteEmptyUSKeyW = Fiddle::Function.new(
lib['SHRegDeleteEmptyUSKeyW'],
[
Fiddle::TYPE_INTPTR_T, # hUSKey : INT_PTR
Fiddle::TYPE_VOIDP, # pwzSubKey : LPCWSTR
Fiddle::TYPE_INT, # delRegFlags : SHREGDEL_FLAGS
],
-Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"#[link(name = "shlwapi")]
extern "system" {
fn SHRegDeleteEmptyUSKeyW(
hUSKey: isize, // INT_PTR
pwzSubKey: *const u16, // LPCWSTR
delRegFlags: i32 // SHREGDEL_FLAGS
) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("SHLWAPI.dll", CharSet = CharSet.Unicode)]
public static extern uint SHRegDeleteEmptyUSKeyW(IntPtr hUSKey, [MarshalAs(UnmanagedType.LPWStr)] string pwzSubKey, int delRegFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_SHRegDeleteEmptyUSKeyW' -Namespace Win32 -PassThru
# $api::SHRegDeleteEmptyUSKeyW(hUSKey, pwzSubKey, delRegFlags)#uselib "SHLWAPI.dll"
#func global SHRegDeleteEmptyUSKeyW "SHRegDeleteEmptyUSKeyW" wptr, wptr, wptr
; SHRegDeleteEmptyUSKeyW hUSKey, pwzSubKey, delRegFlags ; 戻り値は stat
; hUSKey : INT_PTR -> "wptr"
; pwzSubKey : LPCWSTR -> "wptr"
; delRegFlags : SHREGDEL_FLAGS -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "SHLWAPI.dll"
#cfunc global SHRegDeleteEmptyUSKeyW "SHRegDeleteEmptyUSKeyW" sptr, wstr, int
; res = SHRegDeleteEmptyUSKeyW(hUSKey, pwzSubKey, delRegFlags)
; hUSKey : INT_PTR -> "sptr"
; pwzSubKey : LPCWSTR -> "wstr"
; delRegFlags : SHREGDEL_FLAGS -> "int"; WIN32_ERROR SHRegDeleteEmptyUSKeyW(INT_PTR hUSKey, LPCWSTR pwzSubKey, SHREGDEL_FLAGS delRegFlags)
#uselib "SHLWAPI.dll"
#cfunc global SHRegDeleteEmptyUSKeyW "SHRegDeleteEmptyUSKeyW" intptr, wstr, int
; res = SHRegDeleteEmptyUSKeyW(hUSKey, pwzSubKey, delRegFlags)
; hUSKey : INT_PTR -> "intptr"
; pwzSubKey : LPCWSTR -> "wstr"
; delRegFlags : SHREGDEL_FLAGS -> "int"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
shlwapi = windows.NewLazySystemDLL("SHLWAPI.dll")
procSHRegDeleteEmptyUSKeyW = shlwapi.NewProc("SHRegDeleteEmptyUSKeyW")
)
// hUSKey (INT_PTR), pwzSubKey (LPCWSTR), delRegFlags (SHREGDEL_FLAGS)
r1, _, err := procSHRegDeleteEmptyUSKeyW.Call(
uintptr(hUSKey),
uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(pwzSubKey))),
uintptr(delRegFlags),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // WIN32_ERRORfunction SHRegDeleteEmptyUSKeyW(
hUSKey: NativeInt; // INT_PTR
pwzSubKey: PWideChar; // LPCWSTR
delRegFlags: Integer // SHREGDEL_FLAGS
): DWORD; stdcall;
external 'SHLWAPI.dll' name 'SHRegDeleteEmptyUSKeyW';result := DllCall("SHLWAPI\SHRegDeleteEmptyUSKeyW"
, "Ptr", hUSKey ; INT_PTR
, "WStr", pwzSubKey ; LPCWSTR
, "Int", delRegFlags ; SHREGDEL_FLAGS
, "UInt") ; return: WIN32_ERROR●SHRegDeleteEmptyUSKeyW(hUSKey, pwzSubKey, delRegFlags) = DLL("SHLWAPI.dll", "dword SHRegDeleteEmptyUSKeyW(int, char*, int)")
# 呼び出し: SHRegDeleteEmptyUSKeyW(hUSKey, pwzSubKey, delRegFlags)
# hUSKey : INT_PTR -> "int"
# pwzSubKey : LPCWSTR -> "char*"
# delRegFlags : SHREGDEL_FLAGS -> "int"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。const std = @import("std");
extern "shlwapi" fn SHRegDeleteEmptyUSKeyW(
hUSKey: isize, // INT_PTR
pwzSubKey: [*c]const u16, // LPCWSTR
delRegFlags: i32 // SHREGDEL_FLAGS
) callconv(std.os.windows.WINAPI) u32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。proc SHRegDeleteEmptyUSKeyW(
hUSKey: int, # INT_PTR
pwzSubKey: WideCString, # LPCWSTR
delRegFlags: int32 # SHREGDEL_FLAGS
): uint32 {.importc: "SHRegDeleteEmptyUSKeyW", stdcall, dynlib: "SHLWAPI.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。pragma(lib, "shlwapi");
extern(Windows)
uint SHRegDeleteEmptyUSKeyW(
ptrdiff_t hUSKey, // INT_PTR
const(wchar)* pwzSubKey, // LPCWSTR
int delRegFlags // SHREGDEL_FLAGS
);ccall((:SHRegDeleteEmptyUSKeyW, "SHLWAPI.dll"), stdcall, UInt32,
(Int, Cwstring, Int32),
hUSKey, pwzSubKey, delRegFlags)
# hUSKey : INT_PTR -> Int
# pwzSubKey : LPCWSTR -> Cwstring
# delRegFlags : SHREGDEL_FLAGS -> Int32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。local ffi = require("ffi")
ffi.cdef[[
uint32_t SHRegDeleteEmptyUSKeyW(
intptr_t hUSKey,
const uint16_t* pwzSubKey,
int32_t delRegFlags);
]]
local shlwapi = ffi.load("shlwapi")
-- shlwapi.SHRegDeleteEmptyUSKeyW(hUSKey, pwzSubKey, delRegFlags)
-- hUSKey : INT_PTR
-- pwzSubKey : LPCWSTR
-- delRegFlags : SHREGDEL_FLAGS
-- 構造体/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 SHRegDeleteEmptyUSKeyW = lib.func('__stdcall', 'SHRegDeleteEmptyUSKeyW', 'uint32_t', ['intptr_t', 'str16', 'int32_t']);
// SHRegDeleteEmptyUSKeyW(hUSKey, pwzSubKey, delRegFlags)
// hUSKey : INT_PTR -> 'intptr_t'
// pwzSubKey : LPCWSTR -> 'str16'
// delRegFlags : SHREGDEL_FLAGS -> 'int32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("SHLWAPI.dll", {
SHRegDeleteEmptyUSKeyW: { parameters: ["isize", "buffer", "i32"], result: "u32" },
});
// lib.symbols.SHRegDeleteEmptyUSKeyW(hUSKey, pwzSubKey, delRegFlags)
// hUSKey : INT_PTR -> "isize"
// pwzSubKey : LPCWSTR -> "buffer"
// delRegFlags : SHREGDEL_FLAGS -> "i32"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
uint32_t SHRegDeleteEmptyUSKeyW(
intptr_t hUSKey,
const uint16_t* pwzSubKey,
int32_t delRegFlags);
C, "SHLWAPI.dll");
// $ffi->SHRegDeleteEmptyUSKeyW(hUSKey, pwzSubKey, delRegFlags);
// hUSKey : INT_PTR
// pwzSubKey : LPCWSTR
// 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.UNICODE_OPTIONS);
int SHRegDeleteEmptyUSKeyW(
long hUSKey, // INT_PTR
WString pwzSubKey, // LPCWSTR
int delRegFlags // SHREGDEL_FLAGS
);
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。@[Link("shlwapi")]
lib LibSHLWAPI
fun SHRegDeleteEmptyUSKeyW = SHRegDeleteEmptyUSKeyW(
hUSKey : LibC::SSizeT, # INT_PTR
pwzSubKey : UInt16*, # LPCWSTR
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 SHRegDeleteEmptyUSKeyWNative = Uint32 Function(IntPtr, Pointer<Utf16>, Int32);
typedef SHRegDeleteEmptyUSKeyWDart = int Function(int, Pointer<Utf16>, int);
final SHRegDeleteEmptyUSKeyW = DynamicLibrary.open('SHLWAPI.dll')
.lookupFunction<SHRegDeleteEmptyUSKeyWNative, SHRegDeleteEmptyUSKeyWDart>('SHRegDeleteEmptyUSKeyW');
// hUSKey : INT_PTR -> IntPtr
// pwzSubKey : LPCWSTR -> Pointer<Utf16>
// delRegFlags : SHREGDEL_FLAGS -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function SHRegDeleteEmptyUSKeyW(
hUSKey: NativeInt; // INT_PTR
pwzSubKey: PWideChar; // LPCWSTR
delRegFlags: Integer // SHREGDEL_FLAGS
): DWORD; stdcall;
external 'SHLWAPI.dll' name 'SHRegDeleteEmptyUSKeyW';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "SHRegDeleteEmptyUSKeyW"
c_SHRegDeleteEmptyUSKeyW :: CIntPtr -> CWString -> Int32 -> IO Word32
-- hUSKey : INT_PTR -> CIntPtr
-- pwzSubKey : LPCWSTR -> CWString
-- delRegFlags : SHREGDEL_FLAGS -> Int32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let shregdeleteemptyuskeyw =
foreign "SHRegDeleteEmptyUSKeyW"
(intptr_t @-> (ptr uint16_t) @-> int32_t @-> returning uint32_t)
(* hUSKey : INT_PTR -> intptr_t *)
(* pwzSubKey : LPCWSTR -> (ptr uint16_t) *)
(* 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 ("SHRegDeleteEmptyUSKeyW" shreg-delete-empty-uskey-w :convention :stdcall) :uint32
(h-uskey :int64) ; INT_PTR
(pwz-sub-key (:string :encoding :utf-16le)) ; LPCWSTR
(del-reg-flags :int32)) ; SHREGDEL_FLAGS
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $SHRegDeleteEmptyUSKeyW = Win32::API::More->new('SHLWAPI',
'DWORD SHRegDeleteEmptyUSKeyW(LPARAM hUSKey, LPCWSTR pwzSubKey, int delRegFlags)');
# my $ret = $SHRegDeleteEmptyUSKeyW->Call($hUSKey, $pwzSubKey, $delRegFlags);
# hUSKey : INT_PTR -> LPARAM
# pwzSubKey : LPCWSTR -> LPCWSTR
# delRegFlags : SHREGDEL_FLAGS -> int
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。関連項目
- f SHRegDeleteEmptyUSKeyA (ANSI版) — 空のユーザー単位レジストリサブキーを削除する。
- f SHRegDeleteUSValueW — ユーザー単位レジストリキーから値を削除する。