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

SHDeleteValueA

関数
指定したレジストリの値を削除する。
DLLSHLWAPI.dll文字セットANSI (-A)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

WIN32_ERROR SHDeleteValueA(
    HKEY hkey,
    LPCSTR pszSubKey,   // optional
    LPCSTR pszValue
);

パラメーター

名前方向説明
hkeyHKEYin

現在開いているキーへのハンドル、または以下の定義済みの値のいずれか。

HKEY_CLASSES_ROOT

HKEY_CURRENT_CONFIG

HKEY_CURRENT_USER

HKEY_LOCAL_MACHINE

HKEY_PERFORMANCE_DATA

HKEY_USERS

pszSubKeyLPCSTRinoptional値を変更するサブキーの名前を指定する、null で終わる文字列のアドレス。
pszValueLPCSTRin削除する値のアドレス。

戻り値の型: WIN32_ERROR

公式ドキュメント

指定したレジストリ キーから、名前付きの値を削除します。(ANSI)

戻り値

型: LSTATUS

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

解説(Remarks)

メモ

shlwapi.h ヘッダーは、SHDeleteValue をエイリアスとして定義しており、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  (ANSI / -A)
#include <windows.h>

WIN32_ERROR SHDeleteValueA(
    HKEY hkey,
    LPCSTR pszSubKey,   // optional
    LPCSTR pszValue
);
[DllImport("SHLWAPI.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint SHDeleteValueA(
    IntPtr hkey,   // HKEY
    [MarshalAs(UnmanagedType.LPStr)] string pszSubKey,   // LPCSTR optional
    [MarshalAs(UnmanagedType.LPStr)] string pszValue   // LPCSTR
);
<DllImport("SHLWAPI.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function SHDeleteValueA(
    hkey As IntPtr,   ' HKEY
    <MarshalAs(UnmanagedType.LPStr)> pszSubKey As String,   ' LPCSTR optional
    <MarshalAs(UnmanagedType.LPStr)> pszValue As String   ' LPCSTR
) As UInteger
End Function
' hkey : HKEY
' pszSubKey : LPCSTR optional
' pszValue : LPCSTR
Declare PtrSafe Function SHDeleteValueA Lib "shlwapi" ( _
    ByVal hkey As LongPtr, _
    ByVal pszSubKey As String, _
    ByVal pszValue As String) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SHDeleteValueA = ctypes.windll.shlwapi.SHDeleteValueA
SHDeleteValueA.restype = wintypes.DWORD
SHDeleteValueA.argtypes = [
    wintypes.HANDLE,  # hkey : HKEY
    wintypes.LPCSTR,  # pszSubKey : LPCSTR optional
    wintypes.LPCSTR,  # pszValue : LPCSTR
]
require 'fiddle'
require 'fiddle/import'

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

var (
	shlwapi = windows.NewLazySystemDLL("SHLWAPI.dll")
	procSHDeleteValueA = shlwapi.NewProc("SHDeleteValueA")
)

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

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

typedef SHDeleteValueANative = Uint32 Function(Pointer<Void>, Pointer<Utf8>, Pointer<Utf8>);
typedef SHDeleteValueADart = int Function(Pointer<Void>, Pointer<Utf8>, Pointer<Utf8>);
final SHDeleteValueA = DynamicLibrary.open('SHLWAPI.dll')
    .lookupFunction<SHDeleteValueANative, SHDeleteValueADart>('SHDeleteValueA');
// hkey : HKEY -> Pointer<Void>
// pszSubKey : LPCSTR optional -> Pointer<Utf8>
// pszValue : LPCSTR -> Pointer<Utf8>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SHDeleteValueA(
  hkey: THandle;   // HKEY
  pszSubKey: PAnsiChar;   // LPCSTR optional
  pszValue: PAnsiChar   // LPCSTR
): DWORD; stdcall;
  external 'SHLWAPI.dll' name 'SHDeleteValueA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SHDeleteValueA"
  c_SHDeleteValueA :: Ptr () -> CString -> CString -> IO Word32
-- hkey : HKEY -> Ptr ()
-- pszSubKey : LPCSTR optional -> CString
-- pszValue : LPCSTR -> CString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let shdeletevaluea =
  foreign "SHDeleteValueA"
    ((ptr void) @-> string @-> string @-> returning uint32_t)
(* hkey : HKEY -> (ptr void) *)
(* pszSubKey : LPCSTR optional -> string *)
(* pszValue : LPCSTR -> string *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library shlwapi (t "SHLWAPI.dll"))
(cffi:use-foreign-library shlwapi)

(cffi:defcfun ("SHDeleteValueA" shdelete-value-a :convention :stdcall) :uint32
  (hkey :pointer)   ; HKEY
  (psz-sub-key :string)   ; LPCSTR optional
  (psz-value :string))   ; LPCSTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SHDeleteValueA = Win32::API::More->new('SHLWAPI',
    'DWORD SHDeleteValueA(HANDLE hkey, LPCSTR pszSubKey, LPCSTR pszValue)');
# my $ret = $SHDeleteValueA->Call($hkey, $pszSubKey, $pszValue);
# hkey : HKEY -> HANDLE
# pszSubKey : LPCSTR optional -> LPCSTR
# pszValue : LPCSTR -> LPCSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い
使用する型