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

SHRegDeleteUSValueW

関数
ユーザー単位レジストリキーから値を削除する。
DLLSHLWAPI.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

WIN32_ERROR SHRegDeleteUSValueW(
    INT_PTR hUSKey,
    LPCWSTR pwzValue,
    SHREGDEL_FLAGS delRegFlags
);

パラメーター

名前方向説明
hUSKeyINT_PTRin

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

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

pwzValueLPCWSTRinTBD
delRegFlagsSHREGDEL_FLAGSin

値をどのベース キーから削除するかを指定する SHREGDEL_FLAGS のいずれかです。

- pszValue [in]

型: LPCTSTR

削除する値の名前を指定する null 終端文字列へのポインターです。

戻り値の型: WIN32_ERROR

公式ドキュメント

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

戻り値

型: LSTATUS

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

解説(Remarks)

メモ

shlwapi.h ヘッダーは SHRegDeleteUSValue をエイリアスとして定義しており、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 SHRegDeleteUSValueW(
    INT_PTR hUSKey,
    LPCWSTR pwzValue,
    SHREGDEL_FLAGS delRegFlags
);
[DllImport("SHLWAPI.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint SHRegDeleteUSValueW(
    IntPtr hUSKey,   // INT_PTR
    [MarshalAs(UnmanagedType.LPWStr)] string pwzValue,   // LPCWSTR
    int delRegFlags   // SHREGDEL_FLAGS
);
<DllImport("SHLWAPI.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function SHRegDeleteUSValueW(
    hUSKey As IntPtr,   ' INT_PTR
    <MarshalAs(UnmanagedType.LPWStr)> pwzValue As String,   ' LPCWSTR
    delRegFlags As Integer   ' SHREGDEL_FLAGS
) As UInteger
End Function
' hUSKey : INT_PTR
' pwzValue : LPCWSTR
' delRegFlags : SHREGDEL_FLAGS
Declare PtrSafe Function SHRegDeleteUSValueW Lib "shlwapi" ( _
    ByVal hUSKey As LongPtr, _
    ByVal pwzValue 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

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

lib = Fiddle.dlopen('SHLWAPI.dll')
SHRegDeleteUSValueW = Fiddle::Function.new(
  lib['SHRegDeleteUSValueW'],
  [
    Fiddle::TYPE_INTPTR_T,  # hUSKey : INT_PTR
    Fiddle::TYPE_VOIDP,  # pwzValue : 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 SHRegDeleteUSValueW(
        hUSKey: isize,  // INT_PTR
        pwzValue: *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 SHRegDeleteUSValueW(IntPtr hUSKey, [MarshalAs(UnmanagedType.LPWStr)] string pwzValue, int delRegFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_SHRegDeleteUSValueW' -Namespace Win32 -PassThru
# $api::SHRegDeleteUSValueW(hUSKey, pwzValue, delRegFlags)
#uselib "SHLWAPI.dll"
#func global SHRegDeleteUSValueW "SHRegDeleteUSValueW" wptr, wptr, wptr
; SHRegDeleteUSValueW hUSKey, pwzValue, delRegFlags   ; 戻り値は stat
; hUSKey : INT_PTR -> "wptr"
; pwzValue : LPCWSTR -> "wptr"
; delRegFlags : SHREGDEL_FLAGS -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "SHLWAPI.dll"
#cfunc global SHRegDeleteUSValueW "SHRegDeleteUSValueW" sptr, wstr, int
; res = SHRegDeleteUSValueW(hUSKey, pwzValue, delRegFlags)
; hUSKey : INT_PTR -> "sptr"
; pwzValue : LPCWSTR -> "wstr"
; delRegFlags : SHREGDEL_FLAGS -> "int"
; WIN32_ERROR SHRegDeleteUSValueW(INT_PTR hUSKey, LPCWSTR pwzValue, SHREGDEL_FLAGS delRegFlags)
#uselib "SHLWAPI.dll"
#cfunc global SHRegDeleteUSValueW "SHRegDeleteUSValueW" intptr, wstr, int
; res = SHRegDeleteUSValueW(hUSKey, pwzValue, delRegFlags)
; hUSKey : INT_PTR -> "intptr"
; pwzValue : LPCWSTR -> "wstr"
; delRegFlags : SHREGDEL_FLAGS -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	shlwapi = windows.NewLazySystemDLL("SHLWAPI.dll")
	procSHRegDeleteUSValueW = shlwapi.NewProc("SHRegDeleteUSValueW")
)

// hUSKey (INT_PTR), pwzValue (LPCWSTR), delRegFlags (SHREGDEL_FLAGS)
r1, _, err := procSHRegDeleteUSValueW.Call(
	uintptr(hUSKey),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(pwzValue))),
	uintptr(delRegFlags),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // WIN32_ERROR
function SHRegDeleteUSValueW(
  hUSKey: NativeInt;   // INT_PTR
  pwzValue: PWideChar;   // LPCWSTR
  delRegFlags: Integer   // SHREGDEL_FLAGS
): DWORD; stdcall;
  external 'SHLWAPI.dll' name 'SHRegDeleteUSValueW';
result := DllCall("SHLWAPI\SHRegDeleteUSValueW"
    , "Ptr", hUSKey   ; INT_PTR
    , "WStr", pwzValue   ; LPCWSTR
    , "Int", delRegFlags   ; SHREGDEL_FLAGS
    , "UInt")   ; return: WIN32_ERROR
●SHRegDeleteUSValueW(hUSKey, pwzValue, delRegFlags) = DLL("SHLWAPI.dll", "dword SHRegDeleteUSValueW(int, char*, int)")
# 呼び出し: SHRegDeleteUSValueW(hUSKey, pwzValue, delRegFlags)
# hUSKey : INT_PTR -> "int"
# pwzValue : 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 SHRegDeleteUSValueW(
    hUSKey: isize, // INT_PTR
    pwzValue: [*c]const u16, // LPCWSTR
    delRegFlags: i32 // SHREGDEL_FLAGS
) callconv(std.os.windows.WINAPI) u32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc SHRegDeleteUSValueW(
    hUSKey: int,  # INT_PTR
    pwzValue: WideCString,  # LPCWSTR
    delRegFlags: int32  # SHREGDEL_FLAGS
): uint32 {.importc: "SHRegDeleteUSValueW", stdcall, dynlib: "SHLWAPI.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "shlwapi");
extern(Windows)
uint SHRegDeleteUSValueW(
    ptrdiff_t hUSKey,   // INT_PTR
    const(wchar)* pwzValue,   // LPCWSTR
    int delRegFlags   // SHREGDEL_FLAGS
);
ccall((:SHRegDeleteUSValueW, "SHLWAPI.dll"), stdcall, UInt32,
      (Int, Cwstring, Int32),
      hUSKey, pwzValue, delRegFlags)
# hUSKey : INT_PTR -> Int
# pwzValue : LPCWSTR -> Cwstring
# delRegFlags : SHREGDEL_FLAGS -> Int32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
uint32_t SHRegDeleteUSValueW(
    intptr_t hUSKey,
    const uint16_t* pwzValue,
    int32_t delRegFlags);
]]
local shlwapi = ffi.load("shlwapi")
-- shlwapi.SHRegDeleteUSValueW(hUSKey, pwzValue, delRegFlags)
-- hUSKey : INT_PTR
-- pwzValue : 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 SHRegDeleteUSValueW = lib.func('__stdcall', 'SHRegDeleteUSValueW', 'uint32_t', ['intptr_t', 'str16', 'int32_t']);
// SHRegDeleteUSValueW(hUSKey, pwzValue, delRegFlags)
// hUSKey : INT_PTR -> 'intptr_t'
// pwzValue : LPCWSTR -> 'str16'
// delRegFlags : SHREGDEL_FLAGS -> 'int32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("SHLWAPI.dll", {
  SHRegDeleteUSValueW: { parameters: ["isize", "buffer", "i32"], result: "u32" },
});
// lib.symbols.SHRegDeleteUSValueW(hUSKey, pwzValue, delRegFlags)
// hUSKey : INT_PTR -> "isize"
// pwzValue : 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 SHRegDeleteUSValueW(
    intptr_t hUSKey,
    const uint16_t* pwzValue,
    int32_t delRegFlags);
C, "SHLWAPI.dll");
// $ffi->SHRegDeleteUSValueW(hUSKey, pwzValue, delRegFlags);
// hUSKey : INT_PTR
// pwzValue : 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 SHRegDeleteUSValueW(
        long hUSKey,   // INT_PTR
        WString pwzValue,   // LPCWSTR
        int delRegFlags   // SHREGDEL_FLAGS
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("shlwapi")]
lib LibSHLWAPI
  fun SHRegDeleteUSValueW = SHRegDeleteUSValueW(
    hUSKey : LibC::SSizeT,   # INT_PTR
    pwzValue : 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 SHRegDeleteUSValueWNative = Uint32 Function(IntPtr, Pointer<Utf16>, Int32);
typedef SHRegDeleteUSValueWDart = int Function(int, Pointer<Utf16>, int);
final SHRegDeleteUSValueW = DynamicLibrary.open('SHLWAPI.dll')
    .lookupFunction<SHRegDeleteUSValueWNative, SHRegDeleteUSValueWDart>('SHRegDeleteUSValueW');
// hUSKey : INT_PTR -> IntPtr
// pwzValue : LPCWSTR -> Pointer<Utf16>
// delRegFlags : SHREGDEL_FLAGS -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SHRegDeleteUSValueW(
  hUSKey: NativeInt;   // INT_PTR
  pwzValue: PWideChar;   // LPCWSTR
  delRegFlags: Integer   // SHREGDEL_FLAGS
): DWORD; stdcall;
  external 'SHLWAPI.dll' name 'SHRegDeleteUSValueW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let shregdeleteusvaluew =
  foreign "SHRegDeleteUSValueW"
    (intptr_t @-> (ptr uint16_t) @-> int32_t @-> returning uint32_t)
(* hUSKey : INT_PTR -> intptr_t *)
(* pwzValue : 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 ("SHRegDeleteUSValueW" shreg-delete-usvalue-w :convention :stdcall) :uint32
  (h-uskey :int64)   ; INT_PTR
  (pwz-value (: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 $SHRegDeleteUSValueW = Win32::API::More->new('SHLWAPI',
    'DWORD SHRegDeleteUSValueW(LPARAM hUSKey, LPCWSTR pwzValue, int delRegFlags)');
# my $ret = $SHRegDeleteUSValueW->Call($hUSKey, $pwzValue, $delRegFlags);
# hUSKey : INT_PTR -> LPARAM
# pwzValue : LPCWSTR -> LPCWSTR
# delRegFlags : SHREGDEL_FLAGS -> int
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

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