SHRegWriteUSValueW
関数シグネチャ
// SHLWAPI.dll (Unicode / -W)
#include <windows.h>
WIN32_ERROR SHRegWriteUSValueW(
INT_PTR hUSKey,
LPCWSTR pwzValue,
DWORD dwType,
const void* pvData,
DWORD cbData,
DWORD dwFlags
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| hUSKey | INT_PTR | in | 現在開いているレジストリ サブキーへのハンドルです。このサブキーは KEY_SET_VALUE アクセス権で開かれている必要があります。詳細については、Registry Key Security and Access Rights を参照してください。 このハンドルは SHRegOpenUSKey 関数を使用して取得できます。 |
| pwzValue | LPCWSTR | in | TBD |
| dwType | DWORD | in | pszValue で指定された値に格納するデータの型です。Winnt.h および Wdm.h で定義されている以下のレジストリ値型のいずれかを指定します。 REG_NONE (0x00000000)REG_SZ (0x00000001)REG_EXPAND_SZ (0x00000002)REG_BINARY (0x00000003)REG_DWORD (0x00000004)REG_DWORD_LITTLE_ENDIAN (0x00000004)REG_DWORD_BIG_ENDIAN (0x00000005)REG_LINK (0x00000006)REG_MULTI_SZ (0x00000007)REG_RESOURCE_LIST (0x00000008)REG_FULL_RESOURCE_DESCRIPTOR (0x00000009)REG_RESOURCE_REQUIREMENTS_LIST (0x0000000A)REG_QWORD (0x0000000B)REG_QWORD_LITTLE_ENDIAN (0x0000000B) |
| pvData | void* | in | pszValue で指定された値に設定するデータへのポインターです。REG_SZ などの文字列ベースの型では、文字列は null 終端されている必要があります。REG_MULTI_SZ データ型では、文字列は 2 つの null 文字で終端されている必要があります。パス内のバックスラッシュには、エスケープ文字として別のバックスラッシュを前置する必要があります。たとえば、文字列 "C:\mydir\myfile" を格納するには "C:\mydir\myfile" を指定します。 |
| cbData | DWORD | in | pvData パラメーターが指すデータのサイズ (バイト単位) です。データが REG_SZ、REG_EXPAND_SZ、または REG_MULTI_SZ 型の場合、cbData には終端の null 文字のサイズを含める必要があります。 |
| dwFlags | DWORD | in | データを書き込むサブツリーを示すフラグです。以下の値のうち 1 つ以上を指定します。 SHREGSET_HKCU (0x00000001)指定されたサブキーの下に pszValue で指定された名前の値が現在存在しない場合にのみ HKEY_CURRENT_USER に書き込みます。 SHREGSET_FORCE_HKCU (0x00000002)HKEY_CURRENT_USER に書き込みます。pszValue で指定された名前の値が既に存在する場合は上書きされます。 SHREGSET_HKLM (0x00000004)指定されたサブキーの下に pszValue で指定された名前の値が現在存在しない場合にのみ HKEY_LOCAL_MACHINE に書き込みます。 SHREGSET_FORCE_HKLM (0x00000008)HKEY_LOCAL_MACHINE に書き込みます。pszValue で指定された名前の値が既に存在する場合は上書きされます。 SHREGSET_DEFAULT (0x00000006)(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)
SHRegWriteUSValue を使用するには、まず SHRegOpenUSKey でキーを開く必要があります。キーを開いた後は、SHRegWriteUSValue を必要な回数だけ使用できます。
単一の値のみを書き込む必要がある場合は、キーを開いて値を書き込む処理の両方を行う SHRegSetUSValue を使用してください。
同じキーに複数の値を書き込む必要がある場合は、キーが一度しか開かれないため、通常は SHRegWriteUSValue を複数回呼び出す方が SHRegSetUSValue よりも効率的です。
shlwapi.h ヘッダーは、SHRegWriteUSValue を、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして定義します。エンコーディング非依存のエイリアスの使用を、エンコーディング非依存ではないコードと混在させると、不一致が生じ、コンパイル エラーまたは実行時エラーを引き起こす可能性があります。詳細については、Conventions for Function Prototypes を参照してください。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// SHLWAPI.dll (Unicode / -W)
#include <windows.h>
WIN32_ERROR SHRegWriteUSValueW(
INT_PTR hUSKey,
LPCWSTR pwzValue,
DWORD dwType,
const void* pvData,
DWORD cbData,
DWORD dwFlags
);[DllImport("SHLWAPI.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint SHRegWriteUSValueW(
IntPtr hUSKey, // INT_PTR
[MarshalAs(UnmanagedType.LPWStr)] string pwzValue, // LPCWSTR
uint dwType, // DWORD
IntPtr pvData, // void*
uint cbData, // DWORD
uint dwFlags // DWORD
);<DllImport("SHLWAPI.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function SHRegWriteUSValueW(
hUSKey As IntPtr, ' INT_PTR
<MarshalAs(UnmanagedType.LPWStr)> pwzValue As String, ' LPCWSTR
dwType As UInteger, ' DWORD
pvData As IntPtr, ' void*
cbData As UInteger, ' DWORD
dwFlags As UInteger ' DWORD
) As UInteger
End Function' hUSKey : INT_PTR
' pwzValue : LPCWSTR
' dwType : DWORD
' pvData : void*
' cbData : DWORD
' dwFlags : DWORD
Declare PtrSafe Function SHRegWriteUSValueW Lib "shlwapi" ( _
ByVal hUSKey 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
SHRegWriteUSValueW = ctypes.windll.shlwapi.SHRegWriteUSValueW
SHRegWriteUSValueW.restype = wintypes.DWORD
SHRegWriteUSValueW.argtypes = [
ctypes.c_ssize_t, # hUSKey : INT_PTR
wintypes.LPCWSTR, # pwzValue : LPCWSTR
wintypes.DWORD, # dwType : DWORD
ctypes.POINTER(None), # pvData : void*
wintypes.DWORD, # cbData : DWORD
wintypes.DWORD, # dwFlags : DWORD
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('SHLWAPI.dll')
SHRegWriteUSValueW = Fiddle::Function.new(
lib['SHRegWriteUSValueW'],
[
Fiddle::TYPE_INTPTR_T, # hUSKey : INT_PTR
Fiddle::TYPE_VOIDP, # pwzValue : LPCWSTR
-Fiddle::TYPE_INT, # dwType : DWORD
Fiddle::TYPE_VOIDP, # pvData : void*
-Fiddle::TYPE_INT, # cbData : DWORD
-Fiddle::TYPE_INT, # dwFlags : DWORD
],
-Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"#[link(name = "shlwapi")]
extern "system" {
fn SHRegWriteUSValueW(
hUSKey: isize, // INT_PTR
pwzValue: *const u16, // LPCWSTR
dwType: u32, // DWORD
pvData: *const (), // void*
cbData: u32, // DWORD
dwFlags: u32 // DWORD
) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("SHLWAPI.dll", CharSet = CharSet.Unicode)]
public static extern uint SHRegWriteUSValueW(IntPtr hUSKey, [MarshalAs(UnmanagedType.LPWStr)] string pwzValue, uint dwType, IntPtr pvData, uint cbData, uint dwFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_SHRegWriteUSValueW' -Namespace Win32 -PassThru
# $api::SHRegWriteUSValueW(hUSKey, pwzValue, dwType, pvData, cbData, dwFlags)#uselib "SHLWAPI.dll"
#func global SHRegWriteUSValueW "SHRegWriteUSValueW" wptr, wptr, wptr, wptr, wptr, wptr
; SHRegWriteUSValueW hUSKey, pwzValue, dwType, pvData, cbData, dwFlags ; 戻り値は stat
; hUSKey : INT_PTR -> "wptr"
; pwzValue : LPCWSTR -> "wptr"
; dwType : DWORD -> "wptr"
; pvData : void* -> "wptr"
; cbData : DWORD -> "wptr"
; dwFlags : DWORD -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "SHLWAPI.dll"
#cfunc global SHRegWriteUSValueW "SHRegWriteUSValueW" sptr, wstr, int, sptr, int, int
; res = SHRegWriteUSValueW(hUSKey, pwzValue, dwType, pvData, cbData, dwFlags)
; hUSKey : INT_PTR -> "sptr"
; pwzValue : LPCWSTR -> "wstr"
; dwType : DWORD -> "int"
; pvData : void* -> "sptr"
; cbData : DWORD -> "int"
; dwFlags : DWORD -> "int"; WIN32_ERROR SHRegWriteUSValueW(INT_PTR hUSKey, LPCWSTR pwzValue, DWORD dwType, void* pvData, DWORD cbData, DWORD dwFlags)
#uselib "SHLWAPI.dll"
#cfunc global SHRegWriteUSValueW "SHRegWriteUSValueW" intptr, wstr, int, intptr, int, int
; res = SHRegWriteUSValueW(hUSKey, pwzValue, dwType, pvData, cbData, dwFlags)
; hUSKey : INT_PTR -> "intptr"
; pwzValue : LPCWSTR -> "wstr"
; dwType : DWORD -> "int"
; pvData : void* -> "intptr"
; cbData : DWORD -> "int"
; dwFlags : DWORD -> "int"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
shlwapi = windows.NewLazySystemDLL("SHLWAPI.dll")
procSHRegWriteUSValueW = shlwapi.NewProc("SHRegWriteUSValueW")
)
// hUSKey (INT_PTR), pwzValue (LPCWSTR), dwType (DWORD), pvData (void*), cbData (DWORD), dwFlags (DWORD)
r1, _, err := procSHRegWriteUSValueW.Call(
uintptr(hUSKey),
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_ERRORfunction SHRegWriteUSValueW(
hUSKey: NativeInt; // INT_PTR
pwzValue: PWideChar; // LPCWSTR
dwType: DWORD; // DWORD
pvData: Pointer; // void*
cbData: DWORD; // DWORD
dwFlags: DWORD // DWORD
): DWORD; stdcall;
external 'SHLWAPI.dll' name 'SHRegWriteUSValueW';result := DllCall("SHLWAPI\SHRegWriteUSValueW"
, "Ptr", hUSKey ; INT_PTR
, "WStr", pwzValue ; LPCWSTR
, "UInt", dwType ; DWORD
, "Ptr", pvData ; void*
, "UInt", cbData ; DWORD
, "UInt", dwFlags ; DWORD
, "UInt") ; return: WIN32_ERROR●SHRegWriteUSValueW(hUSKey, pwzValue, dwType, pvData, cbData, dwFlags) = DLL("SHLWAPI.dll", "dword SHRegWriteUSValueW(int, char*, dword, void*, dword, dword)")
# 呼び出し: SHRegWriteUSValueW(hUSKey, pwzValue, dwType, pvData, cbData, dwFlags)
# hUSKey : INT_PTR -> "int"
# pwzValue : LPCWSTR -> "char*"
# dwType : DWORD -> "dword"
# pvData : void* -> "void*"
# cbData : DWORD -> "dword"
# dwFlags : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。const std = @import("std");
extern "shlwapi" fn SHRegWriteUSValueW(
hUSKey: isize, // INT_PTR
pwzValue: [*c]const u16, // LPCWSTR
dwType: u32, // DWORD
pvData: ?*anyopaque, // void*
cbData: u32, // DWORD
dwFlags: u32 // DWORD
) callconv(std.os.windows.WINAPI) u32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。proc SHRegWriteUSValueW(
hUSKey: int, # INT_PTR
pwzValue: WideCString, # LPCWSTR
dwType: uint32, # DWORD
pvData: pointer, # void*
cbData: uint32, # DWORD
dwFlags: uint32 # DWORD
): uint32 {.importc: "SHRegWriteUSValueW", stdcall, dynlib: "SHLWAPI.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。pragma(lib, "shlwapi");
extern(Windows)
uint SHRegWriteUSValueW(
ptrdiff_t hUSKey, // INT_PTR
const(wchar)* pwzValue, // LPCWSTR
uint dwType, // DWORD
void* pvData, // void*
uint cbData, // DWORD
uint dwFlags // DWORD
);ccall((:SHRegWriteUSValueW, "SHLWAPI.dll"), stdcall, UInt32,
(Int, Cwstring, UInt32, Ptr{Cvoid}, UInt32, UInt32),
hUSKey, pwzValue, dwType, pvData, cbData, dwFlags)
# hUSKey : INT_PTR -> Int
# pwzValue : LPCWSTR -> Cwstring
# dwType : DWORD -> UInt32
# pvData : void* -> Ptr{Cvoid}
# cbData : DWORD -> UInt32
# dwFlags : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。local ffi = require("ffi")
ffi.cdef[[
uint32_t SHRegWriteUSValueW(
intptr_t hUSKey,
const uint16_t* pwzValue,
uint32_t dwType,
void* pvData,
uint32_t cbData,
uint32_t dwFlags);
]]
local shlwapi = ffi.load("shlwapi")
-- shlwapi.SHRegWriteUSValueW(hUSKey, pwzValue, dwType, pvData, cbData, dwFlags)
-- hUSKey : INT_PTR
-- pwzValue : LPCWSTR
-- dwType : DWORD
-- pvData : void*
-- cbData : DWORD
-- dwFlags : 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 SHRegWriteUSValueW = lib.func('__stdcall', 'SHRegWriteUSValueW', 'uint32_t', ['intptr_t', 'str16', 'uint32_t', 'void *', 'uint32_t', 'uint32_t']);
// SHRegWriteUSValueW(hUSKey, pwzValue, dwType, pvData, cbData, dwFlags)
// hUSKey : INT_PTR -> 'intptr_t'
// pwzValue : LPCWSTR -> 'str16'
// dwType : DWORD -> 'uint32_t'
// pvData : void* -> 'void *'
// cbData : DWORD -> 'uint32_t'
// dwFlags : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("SHLWAPI.dll", {
SHRegWriteUSValueW: { parameters: ["isize", "buffer", "u32", "pointer", "u32", "u32"], result: "u32" },
});
// lib.symbols.SHRegWriteUSValueW(hUSKey, pwzValue, dwType, pvData, cbData, dwFlags)
// hUSKey : INT_PTR -> "isize"
// pwzValue : LPCWSTR -> "buffer"
// dwType : DWORD -> "u32"
// pvData : void* -> "pointer"
// cbData : DWORD -> "u32"
// dwFlags : DWORD -> "u32"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
uint32_t SHRegWriteUSValueW(
intptr_t hUSKey,
const uint16_t* pwzValue,
uint32_t dwType,
void* pvData,
uint32_t cbData,
uint32_t dwFlags);
C, "SHLWAPI.dll");
// $ffi->SHRegWriteUSValueW(hUSKey, pwzValue, dwType, pvData, cbData, dwFlags);
// hUSKey : INT_PTR
// pwzValue : LPCWSTR
// dwType : DWORD
// pvData : void*
// cbData : DWORD
// dwFlags : 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 SHRegWriteUSValueW(
long hUSKey, // INT_PTR
WString pwzValue, // LPCWSTR
int dwType, // DWORD
Pointer pvData, // void*
int cbData, // DWORD
int dwFlags // DWORD
);
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。@[Link("shlwapi")]
lib LibSHLWAPI
fun SHRegWriteUSValueW = SHRegWriteUSValueW(
hUSKey : LibC::SSizeT, # INT_PTR
pwzValue : UInt16*, # LPCWSTR
dwType : UInt32, # DWORD
pvData : Void*, # void*
cbData : UInt32, # DWORD
dwFlags : UInt32 # DWORD
) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef SHRegWriteUSValueWNative = Uint32 Function(IntPtr, Pointer<Utf16>, Uint32, Pointer<Void>, Uint32, Uint32);
typedef SHRegWriteUSValueWDart = int Function(int, Pointer<Utf16>, int, Pointer<Void>, int, int);
final SHRegWriteUSValueW = DynamicLibrary.open('SHLWAPI.dll')
.lookupFunction<SHRegWriteUSValueWNative, SHRegWriteUSValueWDart>('SHRegWriteUSValueW');
// hUSKey : INT_PTR -> IntPtr
// pwzValue : LPCWSTR -> Pointer<Utf16>
// dwType : DWORD -> Uint32
// pvData : void* -> Pointer<Void>
// cbData : DWORD -> Uint32
// dwFlags : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function SHRegWriteUSValueW(
hUSKey: NativeInt; // INT_PTR
pwzValue: PWideChar; // LPCWSTR
dwType: DWORD; // DWORD
pvData: Pointer; // void*
cbData: DWORD; // DWORD
dwFlags: DWORD // DWORD
): DWORD; stdcall;
external 'SHLWAPI.dll' name 'SHRegWriteUSValueW';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "SHRegWriteUSValueW"
c_SHRegWriteUSValueW :: CIntPtr -> CWString -> Word32 -> Ptr () -> Word32 -> Word32 -> IO Word32
-- hUSKey : INT_PTR -> CIntPtr
-- pwzValue : LPCWSTR -> CWString
-- dwType : DWORD -> Word32
-- pvData : void* -> Ptr ()
-- cbData : DWORD -> Word32
-- dwFlags : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let shregwriteusvaluew =
foreign "SHRegWriteUSValueW"
(intptr_t @-> (ptr uint16_t) @-> uint32_t @-> (ptr void) @-> uint32_t @-> uint32_t @-> returning uint32_t)
(* hUSKey : INT_PTR -> intptr_t *)
(* pwzValue : LPCWSTR -> (ptr uint16_t) *)
(* dwType : DWORD -> uint32_t *)
(* pvData : void* -> (ptr void) *)
(* cbData : DWORD -> uint32_t *)
(* dwFlags : 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 ("SHRegWriteUSValueW" shreg-write-usvalue-w :convention :stdcall) :uint32
(h-uskey :int64) ; INT_PTR
(pwz-value (:string :encoding :utf-16le)) ; LPCWSTR
(dw-type :uint32) ; DWORD
(pv-data :pointer) ; void*
(cb-data :uint32) ; DWORD
(dw-flags :uint32)) ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $SHRegWriteUSValueW = Win32::API::More->new('SHLWAPI',
'DWORD SHRegWriteUSValueW(LPARAM hUSKey, LPCWSTR pwzValue, DWORD dwType, LPVOID pvData, DWORD cbData, DWORD dwFlags)');
# my $ret = $SHRegWriteUSValueW->Call($hUSKey, $pwzValue, $dwType, $pvData, $cbData, $dwFlags);
# hUSKey : INT_PTR -> LPARAM
# pwzValue : LPCWSTR -> LPCWSTR
# dwType : DWORD -> DWORD
# pvData : void* -> LPVOID
# cbData : DWORD -> DWORD
# dwFlags : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。関連項目
- f SHRegWriteUSValueA (ANSI版) — ユーザー単位レジストリキーに値を書き込む。