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

SHRegSetUSValueW

関数
ユーザー単位レジストリのサブキーと値名に値を設定する。
DLLSHLWAPI.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

WIN32_ERROR SHRegSetUSValueW(
    LPCWSTR pwzSubKey,
    LPCWSTR pwzValue,
    DWORD dwType,
    const void* pvData,   // optional
    DWORD cbData,   // optional
    DWORD dwFlags   // optional
);

パラメーター

名前方向説明
pwzSubKeyLPCWSTRinTBD
pwzValueLPCWSTRinTBD
dwTypeDWORDin格納するデータの型。このパラメーターは REG_SZ 型である必要があります。詳細については、Registry Data Types を参照してください。
pvDatavoid*inoptional 指定したキーに設定する値を含む、null で終わる文字列へのポインター。
cbDataDWORDinoptionalpvData パラメーターが指す文字列の長さ(バイト単位)。終端の null 文字は含みません。
dwFlagsDWORDinoptional

データの書き込み先を示すフラグ。

SHREGSET_HKCU

空の場合は HKEY_CURRENT_USER に書き込みます。

SHREGSET_FORCE_HKCU

HKEY_CURRENT_USER に書き込みます。

SHREGSET_HKLM

空の場合は HKEY_LOCAL_MACHINE に書き込みます。

SHREGSET_FORCE_HKLM

HKEY_LOCAL_MACHINE に書き込みます。

SHREGSET_DEFAULT

(SHREGSET_FORCE_HKCU | SHREGSET_HKLM) と同等です。

戻り値の型: WIN32_ERROR

公式ドキュメント

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

戻り値

型: LSTATUS

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

解説(Remarks)

この関数は、使用するたびにキーを開きます。同じキーに一連の値を設定するコードの場合は、SHRegOpenUSKey でキーを一度だけ開き、その後 SHRegWriteUSValue を使用してデータを書き込む方が効率的です。

メモ

shlwapi.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして SHRegSetUSValue を定義します。エンコーディング非依存のエイリアスを、エンコーディング非依存でないコードと混在させて使用すると、不一致が生じ、コンパイルエラーや実行時エラーを引き起こす可能性があります。詳細については、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 SHRegSetUSValueW(
    LPCWSTR pwzSubKey,
    LPCWSTR pwzValue,
    DWORD dwType,
    const void* pvData,   // optional
    DWORD cbData,   // optional
    DWORD dwFlags   // optional
);
[DllImport("SHLWAPI.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint SHRegSetUSValueW(
    [MarshalAs(UnmanagedType.LPWStr)] string pwzSubKey,   // LPCWSTR
    [MarshalAs(UnmanagedType.LPWStr)] string pwzValue,   // LPCWSTR
    uint dwType,   // DWORD
    IntPtr pvData,   // void* optional
    uint cbData,   // DWORD optional
    uint dwFlags   // DWORD optional
);
<DllImport("SHLWAPI.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function SHRegSetUSValueW(
    <MarshalAs(UnmanagedType.LPWStr)> pwzSubKey As String,   ' LPCWSTR
    <MarshalAs(UnmanagedType.LPWStr)> pwzValue As String,   ' LPCWSTR
    dwType As UInteger,   ' DWORD
    pvData As IntPtr,   ' void* optional
    cbData As UInteger,   ' DWORD optional
    dwFlags As UInteger   ' DWORD optional
) As UInteger
End Function
' pwzSubKey : LPCWSTR
' pwzValue : LPCWSTR
' dwType : DWORD
' pvData : void* optional
' cbData : DWORD optional
' dwFlags : DWORD optional
Declare PtrSafe Function SHRegSetUSValueW Lib "shlwapi" ( _
    ByVal pwzSubKey As LongPtr, _
    ByVal pwzValue As LongPtr, _
    ByVal dwType As Long, _
    ByVal pvData As LongPtr, _
    ByVal cbData As Long, _
    ByVal dwFlags 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

SHRegSetUSValueW = ctypes.windll.shlwapi.SHRegSetUSValueW
SHRegSetUSValueW.restype = wintypes.DWORD
SHRegSetUSValueW.argtypes = [
    wintypes.LPCWSTR,  # pwzSubKey : LPCWSTR
    wintypes.LPCWSTR,  # pwzValue : LPCWSTR
    wintypes.DWORD,  # dwType : DWORD
    ctypes.POINTER(None),  # pvData : void* optional
    wintypes.DWORD,  # cbData : DWORD optional
    wintypes.DWORD,  # dwFlags : DWORD optional
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHLWAPI.dll')
SHRegSetUSValueW = Fiddle::Function.new(
  lib['SHRegSetUSValueW'],
  [
    Fiddle::TYPE_VOIDP,  # pwzSubKey : LPCWSTR
    Fiddle::TYPE_VOIDP,  # pwzValue : LPCWSTR
    -Fiddle::TYPE_INT,  # dwType : DWORD
    Fiddle::TYPE_VOIDP,  # pvData : void* optional
    -Fiddle::TYPE_INT,  # cbData : DWORD optional
    -Fiddle::TYPE_INT,  # dwFlags : DWORD optional
  ],
  -Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "shlwapi")]
extern "system" {
    fn SHRegSetUSValueW(
        pwzSubKey: *const u16,  // LPCWSTR
        pwzValue: *const u16,  // LPCWSTR
        dwType: u32,  // DWORD
        pvData: *const (),  // void* optional
        cbData: u32,  // DWORD optional
        dwFlags: u32  // DWORD optional
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("SHLWAPI.dll", CharSet = CharSet.Unicode)]
public static extern uint SHRegSetUSValueW([MarshalAs(UnmanagedType.LPWStr)] string pwzSubKey, [MarshalAs(UnmanagedType.LPWStr)] string pwzValue, uint dwType, IntPtr pvData, uint cbData, uint dwFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_SHRegSetUSValueW' -Namespace Win32 -PassThru
# $api::SHRegSetUSValueW(pwzSubKey, pwzValue, dwType, pvData, cbData, dwFlags)
#uselib "SHLWAPI.dll"
#func global SHRegSetUSValueW "SHRegSetUSValueW" wptr, wptr, wptr, wptr, wptr, wptr
; SHRegSetUSValueW pwzSubKey, pwzValue, dwType, pvData, cbData, dwFlags   ; 戻り値は stat
; pwzSubKey : LPCWSTR -> "wptr"
; pwzValue : LPCWSTR -> "wptr"
; dwType : DWORD -> "wptr"
; pvData : void* optional -> "wptr"
; cbData : DWORD optional -> "wptr"
; dwFlags : DWORD optional -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "SHLWAPI.dll"
#cfunc global SHRegSetUSValueW "SHRegSetUSValueW" wstr, wstr, int, sptr, int, int
; res = SHRegSetUSValueW(pwzSubKey, pwzValue, dwType, pvData, cbData, dwFlags)
; pwzSubKey : LPCWSTR -> "wstr"
; pwzValue : LPCWSTR -> "wstr"
; dwType : DWORD -> "int"
; pvData : void* optional -> "sptr"
; cbData : DWORD optional -> "int"
; dwFlags : DWORD optional -> "int"
; WIN32_ERROR SHRegSetUSValueW(LPCWSTR pwzSubKey, LPCWSTR pwzValue, DWORD dwType, void* pvData, DWORD cbData, DWORD dwFlags)
#uselib "SHLWAPI.dll"
#cfunc global SHRegSetUSValueW "SHRegSetUSValueW" wstr, wstr, int, intptr, int, int
; res = SHRegSetUSValueW(pwzSubKey, pwzValue, dwType, pvData, cbData, dwFlags)
; pwzSubKey : LPCWSTR -> "wstr"
; pwzValue : LPCWSTR -> "wstr"
; dwType : DWORD -> "int"
; pvData : void* optional -> "intptr"
; cbData : DWORD optional -> "int"
; dwFlags : DWORD optional -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	shlwapi = windows.NewLazySystemDLL("SHLWAPI.dll")
	procSHRegSetUSValueW = shlwapi.NewProc("SHRegSetUSValueW")
)

// pwzSubKey (LPCWSTR), pwzValue (LPCWSTR), dwType (DWORD), pvData (void* optional), cbData (DWORD optional), dwFlags (DWORD optional)
r1, _, err := procSHRegSetUSValueW.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(pwzSubKey))),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(pwzValue))),
	uintptr(dwType),
	uintptr(pvData),
	uintptr(cbData),
	uintptr(dwFlags),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // WIN32_ERROR
function SHRegSetUSValueW(
  pwzSubKey: PWideChar;   // LPCWSTR
  pwzValue: PWideChar;   // LPCWSTR
  dwType: DWORD;   // DWORD
  pvData: Pointer;   // void* optional
  cbData: DWORD;   // DWORD optional
  dwFlags: DWORD   // DWORD optional
): DWORD; stdcall;
  external 'SHLWAPI.dll' name 'SHRegSetUSValueW';
result := DllCall("SHLWAPI\SHRegSetUSValueW"
    , "WStr", pwzSubKey   ; LPCWSTR
    , "WStr", pwzValue   ; LPCWSTR
    , "UInt", dwType   ; DWORD
    , "Ptr", pvData   ; void* optional
    , "UInt", cbData   ; DWORD optional
    , "UInt", dwFlags   ; DWORD optional
    , "UInt")   ; return: WIN32_ERROR
●SHRegSetUSValueW(pwzSubKey, pwzValue, dwType, pvData, cbData, dwFlags) = DLL("SHLWAPI.dll", "dword SHRegSetUSValueW(char*, char*, dword, void*, dword, dword)")
# 呼び出し: SHRegSetUSValueW(pwzSubKey, pwzValue, dwType, pvData, cbData, dwFlags)
# pwzSubKey : LPCWSTR -> "char*"
# pwzValue : LPCWSTR -> "char*"
# dwType : DWORD -> "dword"
# pvData : void* optional -> "void*"
# cbData : DWORD optional -> "dword"
# dwFlags : DWORD optional -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "shlwapi" fn SHRegSetUSValueW(
    pwzSubKey: [*c]const u16, // LPCWSTR
    pwzValue: [*c]const u16, // LPCWSTR
    dwType: u32, // DWORD
    pvData: ?*anyopaque, // void* optional
    cbData: u32, // DWORD optional
    dwFlags: u32 // DWORD optional
) callconv(std.os.windows.WINAPI) u32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc SHRegSetUSValueW(
    pwzSubKey: WideCString,  # LPCWSTR
    pwzValue: WideCString,  # LPCWSTR
    dwType: uint32,  # DWORD
    pvData: pointer,  # void* optional
    cbData: uint32,  # DWORD optional
    dwFlags: uint32  # DWORD optional
): uint32 {.importc: "SHRegSetUSValueW", stdcall, dynlib: "SHLWAPI.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "shlwapi");
extern(Windows)
uint SHRegSetUSValueW(
    const(wchar)* pwzSubKey,   // LPCWSTR
    const(wchar)* pwzValue,   // LPCWSTR
    uint dwType,   // DWORD
    void* pvData,   // void* optional
    uint cbData,   // DWORD optional
    uint dwFlags   // DWORD optional
);
ccall((:SHRegSetUSValueW, "SHLWAPI.dll"), stdcall, UInt32,
      (Cwstring, Cwstring, UInt32, Ptr{Cvoid}, UInt32, UInt32),
      pwzSubKey, pwzValue, dwType, pvData, cbData, dwFlags)
# pwzSubKey : LPCWSTR -> Cwstring
# pwzValue : LPCWSTR -> Cwstring
# dwType : DWORD -> UInt32
# pvData : void* optional -> Ptr{Cvoid}
# cbData : DWORD optional -> UInt32
# dwFlags : DWORD optional -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
uint32_t SHRegSetUSValueW(
    const uint16_t* pwzSubKey,
    const uint16_t* pwzValue,
    uint32_t dwType,
    void* pvData,
    uint32_t cbData,
    uint32_t dwFlags);
]]
local shlwapi = ffi.load("shlwapi")
-- shlwapi.SHRegSetUSValueW(pwzSubKey, pwzValue, dwType, pvData, cbData, dwFlags)
-- pwzSubKey : LPCWSTR
-- pwzValue : LPCWSTR
-- dwType : DWORD
-- pvData : void* optional
-- cbData : DWORD optional
-- dwFlags : DWORD optional
-- 構造体/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 SHRegSetUSValueW = lib.func('__stdcall', 'SHRegSetUSValueW', 'uint32_t', ['str16', 'str16', 'uint32_t', 'void *', 'uint32_t', 'uint32_t']);
// SHRegSetUSValueW(pwzSubKey, pwzValue, dwType, pvData, cbData, dwFlags)
// pwzSubKey : LPCWSTR -> 'str16'
// pwzValue : LPCWSTR -> 'str16'
// dwType : DWORD -> 'uint32_t'
// pvData : void* optional -> 'void *'
// cbData : DWORD optional -> 'uint32_t'
// dwFlags : DWORD optional -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("SHLWAPI.dll", {
  SHRegSetUSValueW: { parameters: ["buffer", "buffer", "u32", "pointer", "u32", "u32"], result: "u32" },
});
// lib.symbols.SHRegSetUSValueW(pwzSubKey, pwzValue, dwType, pvData, cbData, dwFlags)
// pwzSubKey : LPCWSTR -> "buffer"
// pwzValue : LPCWSTR -> "buffer"
// dwType : DWORD -> "u32"
// pvData : void* optional -> "pointer"
// cbData : DWORD optional -> "u32"
// dwFlags : DWORD optional -> "u32"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t SHRegSetUSValueW(
    const uint16_t* pwzSubKey,
    const uint16_t* pwzValue,
    uint32_t dwType,
    void* pvData,
    uint32_t cbData,
    uint32_t dwFlags);
C, "SHLWAPI.dll");
// $ffi->SHRegSetUSValueW(pwzSubKey, pwzValue, dwType, pvData, cbData, dwFlags);
// pwzSubKey : LPCWSTR
// pwzValue : LPCWSTR
// dwType : DWORD
// pvData : void* optional
// cbData : DWORD optional
// dwFlags : DWORD optional
// 構造体/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 SHRegSetUSValueW(
        WString pwzSubKey,   // LPCWSTR
        WString pwzValue,   // LPCWSTR
        int dwType,   // DWORD
        Pointer pvData,   // void* optional
        int cbData,   // DWORD optional
        int dwFlags   // DWORD optional
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("shlwapi")]
lib LibSHLWAPI
  fun SHRegSetUSValueW = SHRegSetUSValueW(
    pwzSubKey : UInt16*,   # LPCWSTR
    pwzValue : UInt16*,   # LPCWSTR
    dwType : UInt32,   # DWORD
    pvData : Void*,   # void* optional
    cbData : UInt32,   # DWORD optional
    dwFlags : UInt32   # DWORD optional
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef SHRegSetUSValueWNative = Uint32 Function(Pointer<Utf16>, Pointer<Utf16>, Uint32, Pointer<Void>, Uint32, Uint32);
typedef SHRegSetUSValueWDart = int Function(Pointer<Utf16>, Pointer<Utf16>, int, Pointer<Void>, int, int);
final SHRegSetUSValueW = DynamicLibrary.open('SHLWAPI.dll')
    .lookupFunction<SHRegSetUSValueWNative, SHRegSetUSValueWDart>('SHRegSetUSValueW');
// pwzSubKey : LPCWSTR -> Pointer<Utf16>
// pwzValue : LPCWSTR -> Pointer<Utf16>
// dwType : DWORD -> Uint32
// pvData : void* optional -> Pointer<Void>
// cbData : DWORD optional -> Uint32
// dwFlags : DWORD optional -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SHRegSetUSValueW(
  pwzSubKey: PWideChar;   // LPCWSTR
  pwzValue: PWideChar;   // LPCWSTR
  dwType: DWORD;   // DWORD
  pvData: Pointer;   // void* optional
  cbData: DWORD;   // DWORD optional
  dwFlags: DWORD   // DWORD optional
): DWORD; stdcall;
  external 'SHLWAPI.dll' name 'SHRegSetUSValueW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SHRegSetUSValueW"
  c_SHRegSetUSValueW :: CWString -> CWString -> Word32 -> Ptr () -> Word32 -> Word32 -> IO Word32
-- pwzSubKey : LPCWSTR -> CWString
-- pwzValue : LPCWSTR -> CWString
-- dwType : DWORD -> Word32
-- pvData : void* optional -> Ptr ()
-- cbData : DWORD optional -> Word32
-- dwFlags : DWORD optional -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let shregsetusvaluew =
  foreign "SHRegSetUSValueW"
    ((ptr uint16_t) @-> (ptr uint16_t) @-> uint32_t @-> (ptr void) @-> uint32_t @-> uint32_t @-> returning uint32_t)
(* pwzSubKey : LPCWSTR -> (ptr uint16_t) *)
(* pwzValue : LPCWSTR -> (ptr uint16_t) *)
(* dwType : DWORD -> uint32_t *)
(* pvData : void* optional -> (ptr void) *)
(* cbData : DWORD optional -> uint32_t *)
(* dwFlags : DWORD optional -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library shlwapi (t "SHLWAPI.dll"))
(cffi:use-foreign-library shlwapi)

(cffi:defcfun ("SHRegSetUSValueW" shreg-set-usvalue-w :convention :stdcall) :uint32
  (pwz-sub-key (:string :encoding :utf-16le))   ; LPCWSTR
  (pwz-value (:string :encoding :utf-16le))   ; LPCWSTR
  (dw-type :uint32)   ; DWORD
  (pv-data :pointer)   ; void* optional
  (cb-data :uint32)   ; DWORD optional
  (dw-flags :uint32))   ; DWORD optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SHRegSetUSValueW = Win32::API::More->new('SHLWAPI',
    'DWORD SHRegSetUSValueW(LPCWSTR pwzSubKey, LPCWSTR pwzValue, DWORD dwType, LPVOID pvData, DWORD cbData, DWORD dwFlags)');
# my $ret = $SHRegSetUSValueW->Call($pwzSubKey, $pwzValue, $dwType, $pvData, $cbData, $dwFlags);
# pwzSubKey : LPCWSTR -> LPCWSTR
# pwzValue : LPCWSTR -> LPCWSTR
# dwType : DWORD -> DWORD
# pvData : void* optional -> LPVOID
# cbData : DWORD optional -> DWORD
# dwFlags : DWORD optional -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

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