SHRegDeleteUSValueA
関数ユーザー単位レジストリキーから値を削除する。
シグネチャ
// SHLWAPI.dll (ANSI / -A)
#include <windows.h>
WIN32_ERROR SHRegDeleteUSValueA(
INT_PTR hUSKey,
LPCSTR pszValue,
SHREGDEL_FLAGS delRegFlags
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| hUSKey | INT_PTR | in | 現在開いているレジストリ サブキーへのハンドル。サブキーは KEY_SET_VALUE アクセス権で開かれている必要があります。詳細については、Registry Key Security and Access Rights を参照してください。 このハンドルは SHRegOpenUSKey 関数によって取得できます。 |
| pszValue | LPCSTR | in | 削除する値の名前を表す null 終端文字列へのポインター。 |
| delRegFlags | SHREGDEL_FLAGS | in | どのベース キーから値を削除するかを指定する 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 版を自動的に選択するエイリアスとして SHRegDeleteUSValue を定義しています。エンコード ニュートラルなエイリアスの使用を、エンコード ニュートラルでないコードと混在させると、不一致が生じてコンパイル エラーや実行時エラーを引き起こす可能性があります。詳細については、Conventions for Function Prototypes を参照してください。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// SHLWAPI.dll (ANSI / -A)
#include <windows.h>
WIN32_ERROR SHRegDeleteUSValueA(
INT_PTR hUSKey,
LPCSTR pszValue,
SHREGDEL_FLAGS delRegFlags
);[DllImport("SHLWAPI.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint SHRegDeleteUSValueA(
IntPtr hUSKey, // INT_PTR
[MarshalAs(UnmanagedType.LPStr)] string pszValue, // LPCSTR
int delRegFlags // SHREGDEL_FLAGS
);<DllImport("SHLWAPI.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function SHRegDeleteUSValueA(
hUSKey As IntPtr, ' INT_PTR
<MarshalAs(UnmanagedType.LPStr)> pszValue As String, ' LPCSTR
delRegFlags As Integer ' SHREGDEL_FLAGS
) As UInteger
End Function' hUSKey : INT_PTR
' pszValue : LPCSTR
' delRegFlags : SHREGDEL_FLAGS
Declare PtrSafe Function SHRegDeleteUSValueA Lib "shlwapi" ( _
ByVal hUSKey As LongPtr, _
ByVal pszValue 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
SHRegDeleteUSValueA = ctypes.windll.shlwapi.SHRegDeleteUSValueA
SHRegDeleteUSValueA.restype = wintypes.DWORD
SHRegDeleteUSValueA.argtypes = [
ctypes.c_ssize_t, # hUSKey : INT_PTR
wintypes.LPCSTR, # pszValue : LPCSTR
ctypes.c_int, # delRegFlags : SHREGDEL_FLAGS
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('SHLWAPI.dll')
SHRegDeleteUSValueA = Fiddle::Function.new(
lib['SHRegDeleteUSValueA'],
[
Fiddle::TYPE_INTPTR_T, # hUSKey : INT_PTR
Fiddle::TYPE_VOIDP, # pszValue : LPCSTR
Fiddle::TYPE_INT, # delRegFlags : SHREGDEL_FLAGS
],
-Fiddle::TYPE_INT)#[link(name = "shlwapi")]
extern "system" {
fn SHRegDeleteUSValueA(
hUSKey: isize, // INT_PTR
pszValue: *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 SHRegDeleteUSValueA(IntPtr hUSKey, [MarshalAs(UnmanagedType.LPStr)] string pszValue, int delRegFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_SHRegDeleteUSValueA' -Namespace Win32 -PassThru
# $api::SHRegDeleteUSValueA(hUSKey, pszValue, delRegFlags)#uselib "SHLWAPI.dll"
#func global SHRegDeleteUSValueA "SHRegDeleteUSValueA" sptr, sptr, sptr
; SHRegDeleteUSValueA hUSKey, pszValue, delRegFlags ; 戻り値は stat
; hUSKey : INT_PTR -> "sptr"
; pszValue : LPCSTR -> "sptr"
; delRegFlags : SHREGDEL_FLAGS -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "SHLWAPI.dll"
#cfunc global SHRegDeleteUSValueA "SHRegDeleteUSValueA" sptr, str, int
; res = SHRegDeleteUSValueA(hUSKey, pszValue, delRegFlags)
; hUSKey : INT_PTR -> "sptr"
; pszValue : LPCSTR -> "str"
; delRegFlags : SHREGDEL_FLAGS -> "int"; WIN32_ERROR SHRegDeleteUSValueA(INT_PTR hUSKey, LPCSTR pszValue, SHREGDEL_FLAGS delRegFlags)
#uselib "SHLWAPI.dll"
#cfunc global SHRegDeleteUSValueA "SHRegDeleteUSValueA" intptr, str, int
; res = SHRegDeleteUSValueA(hUSKey, pszValue, delRegFlags)
; hUSKey : INT_PTR -> "intptr"
; pszValue : LPCSTR -> "str"
; delRegFlags : SHREGDEL_FLAGS -> "int"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
shlwapi = windows.NewLazySystemDLL("SHLWAPI.dll")
procSHRegDeleteUSValueA = shlwapi.NewProc("SHRegDeleteUSValueA")
)
// hUSKey (INT_PTR), pszValue (LPCSTR), delRegFlags (SHREGDEL_FLAGS)
r1, _, err := procSHRegDeleteUSValueA.Call(
uintptr(hUSKey),
uintptr(unsafe.Pointer(windows.BytePtrFromString(pszValue))),
uintptr(delRegFlags),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // WIN32_ERRORfunction SHRegDeleteUSValueA(
hUSKey: NativeInt; // INT_PTR
pszValue: PAnsiChar; // LPCSTR
delRegFlags: Integer // SHREGDEL_FLAGS
): DWORD; stdcall;
external 'SHLWAPI.dll' name 'SHRegDeleteUSValueA';result := DllCall("SHLWAPI\SHRegDeleteUSValueA"
, "Ptr", hUSKey ; INT_PTR
, "AStr", pszValue ; LPCSTR
, "Int", delRegFlags ; SHREGDEL_FLAGS
, "UInt") ; return: WIN32_ERROR●SHRegDeleteUSValueA(hUSKey, pszValue, delRegFlags) = DLL("SHLWAPI.dll", "dword SHRegDeleteUSValueA(int, char*, int)")
# 呼び出し: SHRegDeleteUSValueA(hUSKey, pszValue, delRegFlags)
# hUSKey : INT_PTR -> "int"
# pszValue : LPCSTR -> "char*"
# delRegFlags : SHREGDEL_FLAGS -> "int"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "shlwapi" fn SHRegDeleteUSValueA(
hUSKey: isize, // INT_PTR
pszValue: [*c]const u8, // LPCSTR
delRegFlags: i32 // SHREGDEL_FLAGS
) callconv(std.os.windows.WINAPI) u32;proc SHRegDeleteUSValueA(
hUSKey: int, # INT_PTR
pszValue: cstring, # LPCSTR
delRegFlags: int32 # SHREGDEL_FLAGS
): uint32 {.importc: "SHRegDeleteUSValueA", stdcall, dynlib: "SHLWAPI.dll".}pragma(lib, "shlwapi");
extern(Windows)
uint SHRegDeleteUSValueA(
ptrdiff_t hUSKey, // INT_PTR
const(char)* pszValue, // LPCSTR
int delRegFlags // SHREGDEL_FLAGS
);ccall((:SHRegDeleteUSValueA, "SHLWAPI.dll"), stdcall, UInt32,
(Int, Cstring, Int32),
hUSKey, pszValue, delRegFlags)
# hUSKey : INT_PTR -> Int
# pszValue : LPCSTR -> Cstring
# delRegFlags : SHREGDEL_FLAGS -> Int32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
uint32_t SHRegDeleteUSValueA(
intptr_t hUSKey,
const char* pszValue,
int32_t delRegFlags);
]]
local shlwapi = ffi.load("shlwapi")
-- shlwapi.SHRegDeleteUSValueA(hUSKey, pszValue, delRegFlags)
-- hUSKey : INT_PTR
-- pszValue : LPCSTR
-- delRegFlags : SHREGDEL_FLAGS
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('SHLWAPI.dll');
const SHRegDeleteUSValueA = lib.func('__stdcall', 'SHRegDeleteUSValueA', 'uint32_t', ['intptr_t', 'str', 'int32_t']);
// SHRegDeleteUSValueA(hUSKey, pszValue, delRegFlags)
// hUSKey : INT_PTR -> 'intptr_t'
// pszValue : LPCSTR -> 'str'
// delRegFlags : SHREGDEL_FLAGS -> 'int32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("SHLWAPI.dll", {
SHRegDeleteUSValueA: { parameters: ["isize", "buffer", "i32"], result: "u32" },
});
// lib.symbols.SHRegDeleteUSValueA(hUSKey, pszValue, delRegFlags)
// hUSKey : INT_PTR -> "isize"
// pszValue : 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 SHRegDeleteUSValueA(
intptr_t hUSKey,
const char* pszValue,
int32_t delRegFlags);
C, "SHLWAPI.dll");
// $ffi->SHRegDeleteUSValueA(hUSKey, pszValue, delRegFlags);
// hUSKey : INT_PTR
// pszValue : 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 SHRegDeleteUSValueA(
long hUSKey, // INT_PTR
String pszValue, // LPCSTR
int delRegFlags // SHREGDEL_FLAGS
);
}@[Link("shlwapi")]
lib LibSHLWAPI
fun SHRegDeleteUSValueA = SHRegDeleteUSValueA(
hUSKey : LibC::SSizeT, # INT_PTR
pszValue : 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 SHRegDeleteUSValueANative = Uint32 Function(IntPtr, Pointer<Utf8>, Int32);
typedef SHRegDeleteUSValueADart = int Function(int, Pointer<Utf8>, int);
final SHRegDeleteUSValueA = DynamicLibrary.open('SHLWAPI.dll')
.lookupFunction<SHRegDeleteUSValueANative, SHRegDeleteUSValueADart>('SHRegDeleteUSValueA');
// hUSKey : INT_PTR -> IntPtr
// pszValue : LPCSTR -> Pointer<Utf8>
// delRegFlags : SHREGDEL_FLAGS -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function SHRegDeleteUSValueA(
hUSKey: NativeInt; // INT_PTR
pszValue: PAnsiChar; // LPCSTR
delRegFlags: Integer // SHREGDEL_FLAGS
): DWORD; stdcall;
external 'SHLWAPI.dll' name 'SHRegDeleteUSValueA';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "SHRegDeleteUSValueA"
c_SHRegDeleteUSValueA :: CIntPtr -> CString -> Int32 -> IO Word32
-- hUSKey : INT_PTR -> CIntPtr
-- pszValue : LPCSTR -> CString
-- delRegFlags : SHREGDEL_FLAGS -> Int32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let shregdeleteusvaluea =
foreign "SHRegDeleteUSValueA"
(intptr_t @-> string @-> int32_t @-> returning uint32_t)
(* hUSKey : INT_PTR -> intptr_t *)
(* pszValue : 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 ("SHRegDeleteUSValueA" shreg-delete-usvalue-a :convention :stdcall) :uint32
(h-uskey :int64) ; INT_PTR
(psz-value :string) ; LPCSTR
(del-reg-flags :int32)) ; SHREGDEL_FLAGS
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $SHRegDeleteUSValueA = Win32::API::More->new('SHLWAPI',
'DWORD SHRegDeleteUSValueA(LPARAM hUSKey, LPCSTR pszValue, int delRegFlags)');
# my $ret = $SHRegDeleteUSValueA->Call($hUSKey, $pszValue, $delRegFlags);
# hUSKey : INT_PTR -> LPARAM
# pszValue : LPCSTR -> LPCSTR
# delRegFlags : SHREGDEL_FLAGS -> int
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
文字セット違い
- f SHRegDeleteUSValueW (Unicode版) — ユーザー単位レジストリキーから値を削除する。
公式の関連項目
- f SHRegDeleteEmptyUSKeyA — 空のユーザー単位レジストリサブキーを削除する。