SHSetValueA

関数

サブキーと値名を指定してレジストリに値を設定する。

DLLSHLWAPI.dll文字セットANSI (-A)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

INT SHSetValueA(
    HKEY hkey,
    LPCSTR pszSubKey,   // optional
    LPCSTR pszValue,   // optional
    DWORD dwType,
    const void* pvData,   // optional
    DWORD cbData
);

パラメーター

名前	型	方向	説明
hkey	HKEY	in	現在開いているキーへのハンドル、または次の定義済みの値のいずれか。 HKEY_CLASSES_ROOT HKEY_CURRENT_CONFIG HKEY_CURRENT_USER HKEY_LOCAL_MACHINE HKEY_PERFORMANCE_DATA HKEY_USERS
pszSubKey	LPCSTR	inoptional	値が関連付けられているサブキーの名前を指定する、null で終わる文字列のアドレス。これは NULL または空文字列へのポインターでもかまいません。その場合、値は hkey パラメーターで識別されるキーに追加されます。
pszValue	LPCSTR	inoptional	値を指定する、null で終わる文字列のアドレス。この値は NULL でもかまいません。
dwType	DWORD	in	格納するデータの型。このパラメーターは REG_SZ 型でなければなりません。詳細については、レジストリのデータ型を参照してください。
pvData	void*	inoptional	指定した値に設定するデータを格納するバッファーへのポインター。この値は NULL でもかまいません。
cbData	DWORD	in	pvData パラメーターが指すバッファーの長さ(バイト単位)。データが null で終わる文字列の場合、この長さには終端の null 文字が含まれます。

戻り値の型: INT

公式ドキュメント

レジストリキーの値を設定します。(ANSI)

戻り値

型: LSTATUS

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

解説(Remarks)

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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>

INT SHSetValueA(
    HKEY hkey,
    LPCSTR pszSubKey,   // optional
    LPCSTR pszValue,   // optional
    DWORD dwType,
    const void* pvData,   // optional
    DWORD cbData
);

[DllImport("SHLWAPI.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern int SHSetValueA(
    IntPtr hkey,   // HKEY
    [MarshalAs(UnmanagedType.LPStr)] string pszSubKey,   // LPCSTR optional
    [MarshalAs(UnmanagedType.LPStr)] string pszValue,   // LPCSTR optional
    uint dwType,   // DWORD
    IntPtr pvData,   // void* optional
    uint cbData   // DWORD
);

<DllImport("SHLWAPI.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function SHSetValueA(
    hkey As IntPtr,   ' HKEY
    <MarshalAs(UnmanagedType.LPStr)> pszSubKey As String,   ' LPCSTR optional
    <MarshalAs(UnmanagedType.LPStr)> pszValue As String,   ' LPCSTR optional
    dwType As UInteger,   ' DWORD
    pvData As IntPtr,   ' void* optional
    cbData As UInteger   ' DWORD
) As Integer
End Function

' hkey : HKEY
' pszSubKey : LPCSTR optional
' pszValue : LPCSTR optional
' dwType : DWORD
' pvData : void* optional
' cbData : DWORD
Declare PtrSafe Function SHSetValueA Lib "shlwapi" ( _
    ByVal hkey As LongPtr, _
    ByVal pszSubKey As String, _
    ByVal pszValue As String, _
    ByVal dwType As Long, _
    ByVal pvData As LongPtr, _
    ByVal cbData As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

SHSetValueA = ctypes.windll.shlwapi.SHSetValueA
SHSetValueA.restype = ctypes.c_int
SHSetValueA.argtypes = [
    wintypes.HANDLE,  # hkey : HKEY
    wintypes.LPCSTR,  # pszSubKey : LPCSTR optional
    wintypes.LPCSTR,  # pszValue : LPCSTR optional
    wintypes.DWORD,  # dwType : DWORD
    ctypes.POINTER(None),  # pvData : void* optional
    wintypes.DWORD,  # cbData : DWORD
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHLWAPI.dll')
SHSetValueA = Fiddle::Function.new(
  lib['SHSetValueA'],
  [
    Fiddle::TYPE_VOIDP,  # hkey : HKEY
    Fiddle::TYPE_VOIDP,  # pszSubKey : LPCSTR optional
    Fiddle::TYPE_VOIDP,  # pszValue : LPCSTR optional
    -Fiddle::TYPE_INT,  # dwType : DWORD
    Fiddle::TYPE_VOIDP,  # pvData : void* optional
    -Fiddle::TYPE_INT,  # cbData : DWORD
  ],
  Fiddle::TYPE_INT)

#[link(name = "shlwapi")]
extern "system" {
    fn SHSetValueA(
        hkey: *mut core::ffi::c_void,  // HKEY
        pszSubKey: *const u8,  // LPCSTR optional
        pszValue: *const u8,  // LPCSTR optional
        dwType: u32,  // DWORD
        pvData: *const (),  // void* optional
        cbData: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("SHLWAPI.dll", CharSet = CharSet.Ansi)]
public static extern int SHSetValueA(IntPtr hkey, [MarshalAs(UnmanagedType.LPStr)] string pszSubKey, [MarshalAs(UnmanagedType.LPStr)] string pszValue, uint dwType, IntPtr pvData, uint cbData);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_SHSetValueA' -Namespace Win32 -PassThru
# $api::SHSetValueA(hkey, pszSubKey, pszValue, dwType, pvData, cbData)

#uselib "SHLWAPI.dll"
#func global SHSetValueA "SHSetValueA" sptr, sptr, sptr, sptr, sptr, sptr
; SHSetValueA hkey, pszSubKey, pszValue, dwType, pvData, cbData   ; 戻り値は stat
; hkey : HKEY -> "sptr"
; pszSubKey : LPCSTR optional -> "sptr"
; pszValue : LPCSTR optional -> "sptr"
; dwType : DWORD -> "sptr"
; pvData : void* optional -> "sptr"
; cbData : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

#uselib "SHLWAPI.dll"
#cfunc global SHSetValueA "SHSetValueA" sptr, str, str, int, sptr, int
; res = SHSetValueA(hkey, pszSubKey, pszValue, dwType, pvData, cbData)
; hkey : HKEY -> "sptr"
; pszSubKey : LPCSTR optional -> "str"
; pszValue : LPCSTR optional -> "str"
; dwType : DWORD -> "int"
; pvData : void* optional -> "sptr"
; cbData : DWORD -> "int"

; INT SHSetValueA(HKEY hkey, LPCSTR pszSubKey, LPCSTR pszValue, DWORD dwType, void* pvData, DWORD cbData)
#uselib "SHLWAPI.dll"
#cfunc global SHSetValueA "SHSetValueA" intptr, str, str, int, intptr, int
; res = SHSetValueA(hkey, pszSubKey, pszValue, dwType, pvData, cbData)
; hkey : HKEY -> "intptr"
; pszSubKey : LPCSTR optional -> "str"
; pszValue : LPCSTR optional -> "str"
; dwType : DWORD -> "int"
; pvData : void* optional -> "intptr"
; cbData : DWORD -> "int"

import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	shlwapi = windows.NewLazySystemDLL("SHLWAPI.dll")
	procSHSetValueA = shlwapi.NewProc("SHSetValueA")
)

// hkey (HKEY), pszSubKey (LPCSTR optional), pszValue (LPCSTR optional), dwType (DWORD), pvData (void* optional), cbData (DWORD)
r1, _, err := procSHSetValueA.Call(
	uintptr(hkey),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(pszSubKey))),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(pszValue))),
	uintptr(dwType),
	uintptr(pvData),
	uintptr(cbData),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // INT

function SHSetValueA(
  hkey: THandle;   // HKEY
  pszSubKey: PAnsiChar;   // LPCSTR optional
  pszValue: PAnsiChar;   // LPCSTR optional
  dwType: DWORD;   // DWORD
  pvData: Pointer;   // void* optional
  cbData: DWORD   // DWORD
): Integer; stdcall;
  external 'SHLWAPI.dll' name 'SHSetValueA';

result := DllCall("SHLWAPI\SHSetValueA"
    , "Ptr", hkey   ; HKEY
    , "AStr", pszSubKey   ; LPCSTR optional
    , "AStr", pszValue   ; LPCSTR optional
    , "UInt", dwType   ; DWORD
    , "Ptr", pvData   ; void* optional
    , "UInt", cbData   ; DWORD
    , "Int")   ; return: INT

●SHSetValueA(hkey, pszSubKey, pszValue, dwType, pvData, cbData) = DLL("SHLWAPI.dll", "int SHSetValueA(void*, char*, char*, dword, void*, dword)")
# 呼び出し: SHSetValueA(hkey, pszSubKey, pszValue, dwType, pvData, cbData)
# hkey : HKEY -> "void*"
# pszSubKey : LPCSTR optional -> "char*"
# pszValue : LPCSTR optional -> "char*"
# dwType : DWORD -> "dword"
# pvData : void* optional -> "void*"
# cbData : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。

const std = @import("std");

extern "shlwapi" fn SHSetValueA(
    hkey: ?*anyopaque, // HKEY
    pszSubKey: [*c]const u8, // LPCSTR optional
    pszValue: [*c]const u8, // LPCSTR optional
    dwType: u32, // DWORD
    pvData: ?*anyopaque, // void* optional
    cbData: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;

proc SHSetValueA(
    hkey: pointer,  # HKEY
    pszSubKey: cstring,  # LPCSTR optional
    pszValue: cstring,  # LPCSTR optional
    dwType: uint32,  # DWORD
    pvData: pointer,  # void* optional
    cbData: uint32  # DWORD
): int32 {.importc: "SHSetValueA", stdcall, dynlib: "SHLWAPI.dll".}

pragma(lib, "shlwapi");
extern(Windows)
int SHSetValueA(
    void* hkey,   // HKEY
    const(char)* pszSubKey,   // LPCSTR optional
    const(char)* pszValue,   // LPCSTR optional
    uint dwType,   // DWORD
    void* pvData,   // void* optional
    uint cbData   // DWORD
);

ccall((:SHSetValueA, "SHLWAPI.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Cstring, Cstring, UInt32, Ptr{Cvoid}, UInt32),
      hkey, pszSubKey, pszValue, dwType, pvData, cbData)
# hkey : HKEY -> Ptr{Cvoid}
# pszSubKey : LPCSTR optional -> Cstring
# pszValue : LPCSTR optional -> Cstring
# dwType : DWORD -> UInt32
# pvData : void* optional -> Ptr{Cvoid}
# cbData : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。

local ffi = require("ffi")
ffi.cdef[[
int32_t SHSetValueA(
    void* hkey,
    const char* pszSubKey,
    const char* pszValue,
    uint32_t dwType,
    void* pvData,
    uint32_t cbData);
]]
local shlwapi = ffi.load("shlwapi")
-- shlwapi.SHSetValueA(hkey, pszSubKey, pszValue, dwType, pvData, cbData)
-- hkey : HKEY
-- pszSubKey : LPCSTR optional
-- pszValue : LPCSTR optional
-- dwType : DWORD
-- pvData : void* optional
-- cbData : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。

const koffi = require('koffi');
const lib = koffi.load('SHLWAPI.dll');
const SHSetValueA = lib.func('__stdcall', 'SHSetValueA', 'int32_t', ['void *', 'str', 'str', 'uint32_t', 'void *', 'uint32_t']);
// SHSetValueA(hkey, pszSubKey, pszValue, dwType, pvData, cbData)
// hkey : HKEY -> 'void *'
// pszSubKey : LPCSTR optional -> 'str'
// pszValue : LPCSTR optional -> 'str'
// dwType : DWORD -> 'uint32_t'
// pvData : void* optional -> 'void *'
// cbData : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。

const lib = Deno.dlopen("SHLWAPI.dll", {
  SHSetValueA: { parameters: ["pointer", "buffer", "buffer", "u32", "pointer", "u32"], result: "i32" },
});
// lib.symbols.SHSetValueA(hkey, pszSubKey, pszValue, dwType, pvData, cbData)
// hkey : HKEY -> "pointer"
// pszSubKey : LPCSTR optional -> "buffer"
// pszValue : LPCSTR optional -> "buffer"
// dwType : DWORD -> "u32"
// pvData : void* optional -> "pointer"
// cbData : DWORD -> "u32"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。

<?php
$ffi = FFI::cdef(<<<C
int32_t SHSetValueA(
    void* hkey,
    const char* pszSubKey,
    const char* pszValue,
    uint32_t dwType,
    void* pvData,
    uint32_t cbData);
C, "SHLWAPI.dll");
// $ffi->SHSetValueA(hkey, pszSubKey, pszValue, dwType, pvData, cbData);
// hkey : HKEY
// pszSubKey : LPCSTR optional
// pszValue : LPCSTR optional
// dwType : DWORD
// pvData : void* optional
// cbData : DWORD
// 構造体/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 SHSetValueA(
        Pointer hkey,   // HKEY
        String pszSubKey,   // LPCSTR optional
        String pszValue,   // LPCSTR optional
        int dwType,   // DWORD
        Pointer pvData,   // void* optional
        int cbData   // DWORD
    );
}

@[Link("shlwapi")]
lib LibSHLWAPI
  fun SHSetValueA = SHSetValueA(
    hkey : Void*,   # HKEY
    pszSubKey : UInt8*,   # LPCSTR optional
    pszValue : UInt8*,   # LPCSTR optional
    dwType : UInt32,   # DWORD
    pvData : Void*,   # void* optional
    cbData : UInt32   # DWORD
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。

import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef SHSetValueANative = Int32 Function(Pointer<Void>, Pointer<Utf8>, Pointer<Utf8>, Uint32, Pointer<Void>, Uint32);
typedef SHSetValueADart = int Function(Pointer<Void>, Pointer<Utf8>, Pointer<Utf8>, int, Pointer<Void>, int);
final SHSetValueA = DynamicLibrary.open('SHLWAPI.dll')
    .lookupFunction<SHSetValueANative, SHSetValueADart>('SHSetValueA');
// hkey : HKEY -> Pointer<Void>
// pszSubKey : LPCSTR optional -> Pointer<Utf8>
// pszValue : LPCSTR optional -> Pointer<Utf8>
// dwType : DWORD -> Uint32
// pvData : void* optional -> Pointer<Void>
// cbData : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。

{$mode objfpc}{$H+}
function SHSetValueA(
  hkey: THandle;   // HKEY
  pszSubKey: PAnsiChar;   // LPCSTR optional
  pszValue: PAnsiChar;   // LPCSTR optional
  dwType: DWORD;   // DWORD
  pvData: Pointer;   // void* optional
  cbData: DWORD   // DWORD
): Integer; stdcall;
  external 'SHLWAPI.dll' name 'SHSetValueA';

import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SHSetValueA"
  c_SHSetValueA :: Ptr () -> CString -> CString -> Word32 -> Ptr () -> Word32 -> IO Int32
-- hkey : HKEY -> Ptr ()
-- pszSubKey : LPCSTR optional -> CString
-- pszValue : LPCSTR optional -> CString
-- dwType : DWORD -> Word32
-- pvData : void* optional -> Ptr ()
-- cbData : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。

open Ctypes
open Foreign

let shsetvaluea =
  foreign "SHSetValueA"
    ((ptr void) @-> string @-> string @-> uint32_t @-> (ptr void) @-> uint32_t @-> returning int32_t)
(* hkey : HKEY -> (ptr void) *)
(* pszSubKey : LPCSTR optional -> string *)
(* pszValue : LPCSTR optional -> string *)
(* dwType : DWORD -> uint32_t *)
(* pvData : void* optional -> (ptr void) *)
(* cbData : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)

(cffi:define-foreign-library shlwapi (t "SHLWAPI.dll"))
(cffi:use-foreign-library shlwapi)

(cffi:defcfun ("SHSetValueA" shset-value-a :convention :stdcall) :int32
  (hkey :pointer)   ; HKEY
  (psz-sub-key :string)   ; LPCSTR optional
  (psz-value :string)   ; LPCSTR optional
  (dw-type :uint32)   ; DWORD
  (pv-data :pointer)   ; void* optional
  (cb-data :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。

use Win32::API;
my $SHSetValueA = Win32::API::More->new('SHLWAPI',
    'int SHSetValueA(HANDLE hkey, LPCSTR pszSubKey, LPCSTR pszValue, DWORD dwType, LPVOID pvData, DWORD cbData)');
# my $ret = $SHSetValueA->Call($hkey, $pszSubKey, $pszValue, $dwType, $pvData, $cbData);
# hkey : HKEY -> HANDLE
# pszSubKey : LPCSTR optional -> LPCSTR
# pszValue : LPCSTR optional -> LPCSTR
# dwType : DWORD -> DWORD
# pvData : void* optional -> LPVOID
# cbData : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

SHSetValueA

シグネチャ

パラメーター

HKEY_CLASSES_ROOT

HKEY_CURRENT_CONFIG

HKEY_CURRENT_USER

HKEY_LOCAL_MACHINE

HKEY_PERFORMANCE_DATA

HKEY_USERS

公式ドキュメント

戻り値

解説(Remarks)

各言語での呼び出し定義

関連項目