SHSetValueW
関数サブキーと値名を指定してレジストリに値を設定する。
シグネチャ
// SHLWAPI.dll (Unicode / -W)
#include <windows.h>
INT SHSetValueW(
HKEY hkey,
LPCWSTR pszSubKey, // optional
LPCWSTR pszValue, // optional
DWORD dwType,
const void* pvData, // optional
DWORD cbData
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| hkey | HKEY | in | 現在開いているキーへのハンドル、または以下の定義済みの値のいずれか。 HKEY_CLASSES_ROOTHKEY_CURRENT_CONFIGHKEY_CURRENT_USERHKEY_LOCAL_MACHINEHKEY_PERFORMANCE_DATAHKEY_USERS |
| pszSubKey | LPCWSTR | inoptional | 値が関連付けられているサブキーの名前を指定する、null で終わる文字列のアドレス。これは NULL または空文字列へのポインターでもかまいません。その場合、値は hkey パラメーターで識別されるキーに追加されます。 |
| pszValue | LPCWSTR | inoptional | 値を指定する、null で終わる文字列のアドレス。この値は NULL でもかまいません。 |
| dwType | DWORD | in | 格納するデータの型。このパラメーターは REG_SZ 型でなければなりません。詳細については、レジストリのデータ型を参照してください。 |
| pvData | void* | inoptional | 指定された値に設定するデータを格納するバッファーへのポインター。この値は NULL でもかまいません。 |
| cbData | DWORD | in | pvData パラメーターが指すバッファーの長さ(バイト単位)。データが null で終わる文字列の場合、この長さには終端の null 文字が含まれます。 - hkey.HKEY_CLASSES_ROOT- hkey.HKEY_CURRENT_CONFIG- hkey.HKEY_CURRENT_USER- hkey.HKEY_LOCAL_MACHINE- hkey.HKEY_PERFORMANCE_DATA- hkey.HKEY_USERS |
戻り値の型: INT
公式ドキュメント
レジストリキーの値を設定します。(Unicode)
戻り値
型: LSTATUS
成功した場合は ERROR_SUCCESS を返します。それ以外の場合は、Winerror.h で定義されている 0 以外のエラーコードを返します。FormatMessage 関数を FORMAT_MESSAGE_FROM_SYSTEM フラグと共に使用すると、エラーの一般的な説明を取得できます。
解説(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)
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// SHLWAPI.dll (Unicode / -W)
#include <windows.h>
INT SHSetValueW(
HKEY hkey,
LPCWSTR pszSubKey, // optional
LPCWSTR pszValue, // optional
DWORD dwType,
const void* pvData, // optional
DWORD cbData
);[DllImport("SHLWAPI.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern int SHSetValueW(
IntPtr hkey, // HKEY
[MarshalAs(UnmanagedType.LPWStr)] string pszSubKey, // LPCWSTR optional
[MarshalAs(UnmanagedType.LPWStr)] string pszValue, // LPCWSTR optional
uint dwType, // DWORD
IntPtr pvData, // void* optional
uint cbData // DWORD
);<DllImport("SHLWAPI.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function SHSetValueW(
hkey As IntPtr, ' HKEY
<MarshalAs(UnmanagedType.LPWStr)> pszSubKey As String, ' LPCWSTR optional
<MarshalAs(UnmanagedType.LPWStr)> pszValue As String, ' LPCWSTR optional
dwType As UInteger, ' DWORD
pvData As IntPtr, ' void* optional
cbData As UInteger ' DWORD
) As Integer
End Function' hkey : HKEY
' pszSubKey : LPCWSTR optional
' pszValue : LPCWSTR optional
' dwType : DWORD
' pvData : void* optional
' cbData : DWORD
Declare PtrSafe Function SHSetValueW Lib "shlwapi" ( _
ByVal hkey As LongPtr, _
ByVal pszSubKey As LongPtr, _
ByVal pszValue As LongPtr, _
ByVal dwType As Long, _
ByVal pvData As LongPtr, _
ByVal cbData 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
SHSetValueW = ctypes.windll.shlwapi.SHSetValueW
SHSetValueW.restype = ctypes.c_int
SHSetValueW.argtypes = [
wintypes.HANDLE, # hkey : HKEY
wintypes.LPCWSTR, # pszSubKey : LPCWSTR optional
wintypes.LPCWSTR, # pszValue : LPCWSTR 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')
SHSetValueW = Fiddle::Function.new(
lib['SHSetValueW'],
[
Fiddle::TYPE_VOIDP, # hkey : HKEY
Fiddle::TYPE_VOIDP, # pszSubKey : LPCWSTR optional
Fiddle::TYPE_VOIDP, # pszValue : LPCWSTR optional
-Fiddle::TYPE_INT, # dwType : DWORD
Fiddle::TYPE_VOIDP, # pvData : void* optional
-Fiddle::TYPE_INT, # cbData : DWORD
],
Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"#[link(name = "shlwapi")]
extern "system" {
fn SHSetValueW(
hkey: *mut core::ffi::c_void, // HKEY
pszSubKey: *const u16, // LPCWSTR optional
pszValue: *const u16, // LPCWSTR 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.Unicode)]
public static extern int SHSetValueW(IntPtr hkey, [MarshalAs(UnmanagedType.LPWStr)] string pszSubKey, [MarshalAs(UnmanagedType.LPWStr)] string pszValue, uint dwType, IntPtr pvData, uint cbData);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_SHSetValueW' -Namespace Win32 -PassThru
# $api::SHSetValueW(hkey, pszSubKey, pszValue, dwType, pvData, cbData)#uselib "SHLWAPI.dll"
#func global SHSetValueW "SHSetValueW" wptr, wptr, wptr, wptr, wptr, wptr
; SHSetValueW hkey, pszSubKey, pszValue, dwType, pvData, cbData ; 戻り値は stat
; hkey : HKEY -> "wptr"
; pszSubKey : LPCWSTR optional -> "wptr"
; pszValue : LPCWSTR optional -> "wptr"
; dwType : DWORD -> "wptr"
; pvData : void* optional -> "wptr"
; cbData : DWORD -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "SHLWAPI.dll"
#cfunc global SHSetValueW "SHSetValueW" sptr, wstr, wstr, int, sptr, int
; res = SHSetValueW(hkey, pszSubKey, pszValue, dwType, pvData, cbData)
; hkey : HKEY -> "sptr"
; pszSubKey : LPCWSTR optional -> "wstr"
; pszValue : LPCWSTR optional -> "wstr"
; dwType : DWORD -> "int"
; pvData : void* optional -> "sptr"
; cbData : DWORD -> "int"; INT SHSetValueW(HKEY hkey, LPCWSTR pszSubKey, LPCWSTR pszValue, DWORD dwType, void* pvData, DWORD cbData)
#uselib "SHLWAPI.dll"
#cfunc global SHSetValueW "SHSetValueW" intptr, wstr, wstr, int, intptr, int
; res = SHSetValueW(hkey, pszSubKey, pszValue, dwType, pvData, cbData)
; hkey : HKEY -> "intptr"
; pszSubKey : LPCWSTR optional -> "wstr"
; pszValue : LPCWSTR optional -> "wstr"
; dwType : DWORD -> "int"
; pvData : void* optional -> "intptr"
; cbData : DWORD -> "int"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
shlwapi = windows.NewLazySystemDLL("SHLWAPI.dll")
procSHSetValueW = shlwapi.NewProc("SHSetValueW")
)
// hkey (HKEY), pszSubKey (LPCWSTR optional), pszValue (LPCWSTR optional), dwType (DWORD), pvData (void* optional), cbData (DWORD)
r1, _, err := procSHSetValueW.Call(
uintptr(hkey),
uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(pszSubKey))),
uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(pszValue))),
uintptr(dwType),
uintptr(pvData),
uintptr(cbData),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // INTfunction SHSetValueW(
hkey: THandle; // HKEY
pszSubKey: PWideChar; // LPCWSTR optional
pszValue: PWideChar; // LPCWSTR optional
dwType: DWORD; // DWORD
pvData: Pointer; // void* optional
cbData: DWORD // DWORD
): Integer; stdcall;
external 'SHLWAPI.dll' name 'SHSetValueW';result := DllCall("SHLWAPI\SHSetValueW"
, "Ptr", hkey ; HKEY
, "WStr", pszSubKey ; LPCWSTR optional
, "WStr", pszValue ; LPCWSTR optional
, "UInt", dwType ; DWORD
, "Ptr", pvData ; void* optional
, "UInt", cbData ; DWORD
, "Int") ; return: INT●SHSetValueW(hkey, pszSubKey, pszValue, dwType, pvData, cbData) = DLL("SHLWAPI.dll", "int SHSetValueW(void*, char*, char*, dword, void*, dword)")
# 呼び出し: SHSetValueW(hkey, pszSubKey, pszValue, dwType, pvData, cbData)
# hkey : HKEY -> "void*"
# pszSubKey : LPCWSTR optional -> "char*"
# pszValue : LPCWSTR optional -> "char*"
# dwType : DWORD -> "dword"
# pvData : void* optional -> "void*"
# cbData : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。const std = @import("std");
extern "shlwapi" fn SHSetValueW(
hkey: ?*anyopaque, // HKEY
pszSubKey: [*c]const u16, // LPCWSTR optional
pszValue: [*c]const u16, // LPCWSTR optional
dwType: u32, // DWORD
pvData: ?*anyopaque, // void* optional
cbData: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。proc SHSetValueW(
hkey: pointer, # HKEY
pszSubKey: WideCString, # LPCWSTR optional
pszValue: WideCString, # LPCWSTR optional
dwType: uint32, # DWORD
pvData: pointer, # void* optional
cbData: uint32 # DWORD
): int32 {.importc: "SHSetValueW", stdcall, dynlib: "SHLWAPI.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。pragma(lib, "shlwapi");
extern(Windows)
int SHSetValueW(
void* hkey, // HKEY
const(wchar)* pszSubKey, // LPCWSTR optional
const(wchar)* pszValue, // LPCWSTR optional
uint dwType, // DWORD
void* pvData, // void* optional
uint cbData // DWORD
);ccall((:SHSetValueW, "SHLWAPI.dll"), stdcall, Int32,
(Ptr{Cvoid}, Cwstring, Cwstring, UInt32, Ptr{Cvoid}, UInt32),
hkey, pszSubKey, pszValue, dwType, pvData, cbData)
# hkey : HKEY -> Ptr{Cvoid}
# pszSubKey : LPCWSTR optional -> Cwstring
# pszValue : LPCWSTR optional -> Cwstring
# dwType : DWORD -> UInt32
# pvData : void* optional -> Ptr{Cvoid}
# cbData : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。local ffi = require("ffi")
ffi.cdef[[
int32_t SHSetValueW(
void* hkey,
const uint16_t* pszSubKey,
const uint16_t* pszValue,
uint32_t dwType,
void* pvData,
uint32_t cbData);
]]
local shlwapi = ffi.load("shlwapi")
-- shlwapi.SHSetValueW(hkey, pszSubKey, pszValue, dwType, pvData, cbData)
-- hkey : HKEY
-- pszSubKey : LPCWSTR optional
-- pszValue : LPCWSTR optional
-- dwType : DWORD
-- pvData : void* optional
-- cbData : DWORD
-- 構造体/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 SHSetValueW = lib.func('__stdcall', 'SHSetValueW', 'int32_t', ['void *', 'str16', 'str16', 'uint32_t', 'void *', 'uint32_t']);
// SHSetValueW(hkey, pszSubKey, pszValue, dwType, pvData, cbData)
// hkey : HKEY -> 'void *'
// pszSubKey : LPCWSTR optional -> 'str16'
// pszValue : LPCWSTR optional -> 'str16'
// dwType : DWORD -> 'uint32_t'
// pvData : void* optional -> 'void *'
// cbData : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("SHLWAPI.dll", {
SHSetValueW: { parameters: ["pointer", "buffer", "buffer", "u32", "pointer", "u32"], result: "i32" },
});
// lib.symbols.SHSetValueW(hkey, pszSubKey, pszValue, dwType, pvData, cbData)
// hkey : HKEY -> "pointer"
// pszSubKey : LPCWSTR optional -> "buffer"
// pszValue : LPCWSTR optional -> "buffer"
// dwType : DWORD -> "u32"
// pvData : void* optional -> "pointer"
// cbData : DWORD -> "u32"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t SHSetValueW(
void* hkey,
const uint16_t* pszSubKey,
const uint16_t* pszValue,
uint32_t dwType,
void* pvData,
uint32_t cbData);
C, "SHLWAPI.dll");
// $ffi->SHSetValueW(hkey, pszSubKey, pszValue, dwType, pvData, cbData);
// hkey : HKEY
// pszSubKey : LPCWSTR optional
// pszValue : LPCWSTR 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.UNICODE_OPTIONS);
int SHSetValueW(
Pointer hkey, // HKEY
WString pszSubKey, // LPCWSTR optional
WString pszValue, // LPCWSTR optional
int dwType, // DWORD
Pointer pvData, // void* optional
int cbData // DWORD
);
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。@[Link("shlwapi")]
lib LibSHLWAPI
fun SHSetValueW = SHSetValueW(
hkey : Void*, # HKEY
pszSubKey : UInt16*, # LPCWSTR optional
pszValue : UInt16*, # LPCWSTR 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 SHSetValueWNative = Int32 Function(Pointer<Void>, Pointer<Utf16>, Pointer<Utf16>, Uint32, Pointer<Void>, Uint32);
typedef SHSetValueWDart = int Function(Pointer<Void>, Pointer<Utf16>, Pointer<Utf16>, int, Pointer<Void>, int);
final SHSetValueW = DynamicLibrary.open('SHLWAPI.dll')
.lookupFunction<SHSetValueWNative, SHSetValueWDart>('SHSetValueW');
// hkey : HKEY -> Pointer<Void>
// pszSubKey : LPCWSTR optional -> Pointer<Utf16>
// pszValue : LPCWSTR optional -> Pointer<Utf16>
// dwType : DWORD -> Uint32
// pvData : void* optional -> Pointer<Void>
// cbData : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function SHSetValueW(
hkey: THandle; // HKEY
pszSubKey: PWideChar; // LPCWSTR optional
pszValue: PWideChar; // LPCWSTR optional
dwType: DWORD; // DWORD
pvData: Pointer; // void* optional
cbData: DWORD // DWORD
): Integer; stdcall;
external 'SHLWAPI.dll' name 'SHSetValueW';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "SHSetValueW"
c_SHSetValueW :: Ptr () -> CWString -> CWString -> Word32 -> Ptr () -> Word32 -> IO Int32
-- hkey : HKEY -> Ptr ()
-- pszSubKey : LPCWSTR optional -> CWString
-- pszValue : LPCWSTR optional -> CWString
-- dwType : DWORD -> Word32
-- pvData : void* optional -> Ptr ()
-- cbData : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let shsetvaluew =
foreign "SHSetValueW"
((ptr void) @-> (ptr uint16_t) @-> (ptr uint16_t) @-> uint32_t @-> (ptr void) @-> uint32_t @-> returning int32_t)
(* hkey : HKEY -> (ptr void) *)
(* pszSubKey : LPCWSTR optional -> (ptr uint16_t) *)
(* pszValue : LPCWSTR optional -> (ptr uint16_t) *)
(* 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 ("SHSetValueW" shset-value-w :convention :stdcall) :int32
(hkey :pointer) ; HKEY
(psz-sub-key (:string :encoding :utf-16le)) ; LPCWSTR optional
(psz-value (:string :encoding :utf-16le)) ; LPCWSTR 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 $SHSetValueW = Win32::API::More->new('SHLWAPI',
'int SHSetValueW(HANDLE hkey, LPCWSTR pszSubKey, LPCWSTR pszValue, DWORD dwType, LPVOID pvData, DWORD cbData)');
# my $ret = $SHSetValueW->Call($hkey, $pszSubKey, $pszValue, $dwType, $pvData, $cbData);
# hkey : HKEY -> HANDLE
# pszSubKey : LPCWSTR optional -> LPCWSTR
# pszValue : LPCWSTR optional -> LPCWSTR
# dwType : DWORD -> DWORD
# pvData : void* optional -> LPVOID
# cbData : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。関連項目
文字セット違い
- f SHSetValueA (ANSI版) — サブキーと値名を指定してレジストリに値を設定する。