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

SHRegWriteUSValueA

関数
ユーザー単位レジストリキーに値を書き込む。
DLLSHLWAPI.dll文字セットANSI (-A)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

WIN32_ERROR SHRegWriteUSValueA(
    INT_PTR hUSKey,
    LPCSTR pszValue,
    DWORD dwType,
    const void* pvData,
    DWORD cbData,
    DWORD dwFlags
);

パラメーター

名前方向説明
hUSKeyINT_PTRin

現在開いているレジストリ サブキーへのハンドル。サブキーは KEY_SET_VALUE アクセス権で開かれている必要があります。詳細については、レジストリ キーのセキュリティとアクセス権を参照してください。

このハンドルは SHRegOpenUSKey 関数によって取得できます。

pszValueLPCSTRin

値の名前を指定する null 終端文字列へのポインター。この値は、hUSKey で指定されたサブキー内のエントリです。この名前を持つ値がサブキー内にまだ存在しない場合は、追加されます。

このパラメーターが NULL または空の文字列の場合、関数はサブキーの既定値 (Default) の型とデータを設定します。

dwTypeDWORDin

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)

pvDatavoid*inpszValue で指定された値に設定するデータへのポインター。REG_SZ などの文字列ベースの型の場合、文字列は null 終端である必要があります。REG_MULTI_SZ データ型の場合、文字列は 2 つの null 文字で終端する必要があります。パスに含まれるバックスラッシュは、エスケープ文字として別のバックスラッシュを前に付ける必要があります。たとえば、文字列 "C:\mydir\myfile" を格納するには "C:\mydir\myfile" と指定します。
cbDataDWORDinpvData パラメーターが指すデータのサイズ (バイト単位)。データが REG_SZREG_EXPAND_SZ、または REG_MULTI_SZ 型の場合、cbData には終端の null 文字のサイズを含める必要があります。
dwFlagsDWORDin

データを書き込むサブツリーを示すフラグ。次の値のうち 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) 内のレジストリ サブキーに値を書き込みます。(ANSI)

戻り値

型: LSTATUS

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

解説(Remarks)

SHRegWriteUSValue を使用するには、まず SHRegOpenUSKey でキーを開く必要があります。キーを開いた後は、SHRegWriteUSValue を必要な回数だけ使用できます。

単一の値のみを書き込む必要がある場合は、キーを開いて値の書き込みを同時に行う SHRegSetUSValue を使用してください。

同じキーに複数の値を書き込む必要がある場合は、キーが一度だけ開かれるため、通常は SHRegWriteUSValue を複数回呼び出す方が SHRegSetUSValue よりも効率的です。

メモ

shlwapi.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして SHRegWriteUSValue を定義します。エンコード非依存のエイリアスを、エンコード非依存ではないコードと混在させて使用すると、不一致が生じ、コンパイル エラーまたは実行時エラーを引き起こす可能性があります。詳細については、関数プロトタイプの規則を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 SHRegWriteUSValueA(
    INT_PTR hUSKey,
    LPCSTR pszValue,
    DWORD dwType,
    const void* pvData,
    DWORD cbData,
    DWORD dwFlags
);
[DllImport("SHLWAPI.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint SHRegWriteUSValueA(
    IntPtr hUSKey,   // INT_PTR
    [MarshalAs(UnmanagedType.LPStr)] string pszValue,   // LPCSTR
    uint dwType,   // DWORD
    IntPtr pvData,   // void*
    uint cbData,   // DWORD
    uint dwFlags   // DWORD
);
<DllImport("SHLWAPI.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function SHRegWriteUSValueA(
    hUSKey As IntPtr,   ' INT_PTR
    <MarshalAs(UnmanagedType.LPStr)> pszValue As String,   ' LPCSTR
    dwType As UInteger,   ' DWORD
    pvData As IntPtr,   ' void*
    cbData As UInteger,   ' DWORD
    dwFlags As UInteger   ' DWORD
) As UInteger
End Function
' hUSKey : INT_PTR
' pszValue : LPCSTR
' dwType : DWORD
' pvData : void*
' cbData : DWORD
' dwFlags : DWORD
Declare PtrSafe Function SHRegWriteUSValueA Lib "shlwapi" ( _
    ByVal hUSKey As LongPtr, _
    ByVal pszValue As String, _
    ByVal dwType As Long, _
    ByVal pvData As LongPtr, _
    ByVal cbData As Long, _
    ByVal dwFlags As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SHRegWriteUSValueA = ctypes.windll.shlwapi.SHRegWriteUSValueA
SHRegWriteUSValueA.restype = wintypes.DWORD
SHRegWriteUSValueA.argtypes = [
    ctypes.c_ssize_t,  # hUSKey : INT_PTR
    wintypes.LPCSTR,  # pszValue : LPCSTR
    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')
SHRegWriteUSValueA = Fiddle::Function.new(
  lib['SHRegWriteUSValueA'],
  [
    Fiddle::TYPE_INTPTR_T,  # hUSKey : INT_PTR
    Fiddle::TYPE_VOIDP,  # pszValue : LPCSTR
    -Fiddle::TYPE_INT,  # dwType : DWORD
    Fiddle::TYPE_VOIDP,  # pvData : void*
    -Fiddle::TYPE_INT,  # cbData : DWORD
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
  ],
  -Fiddle::TYPE_INT)
#[link(name = "shlwapi")]
extern "system" {
    fn SHRegWriteUSValueA(
        hUSKey: isize,  // INT_PTR
        pszValue: *const u8,  // LPCSTR
        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.Ansi)]
public static extern uint SHRegWriteUSValueA(IntPtr hUSKey, [MarshalAs(UnmanagedType.LPStr)] string pszValue, uint dwType, IntPtr pvData, uint cbData, uint dwFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_SHRegWriteUSValueA' -Namespace Win32 -PassThru
# $api::SHRegWriteUSValueA(hUSKey, pszValue, dwType, pvData, cbData, dwFlags)
#uselib "SHLWAPI.dll"
#func global SHRegWriteUSValueA "SHRegWriteUSValueA" sptr, sptr, sptr, sptr, sptr, sptr
; SHRegWriteUSValueA hUSKey, pszValue, dwType, pvData, cbData, dwFlags   ; 戻り値は stat
; hUSKey : INT_PTR -> "sptr"
; pszValue : LPCSTR -> "sptr"
; dwType : DWORD -> "sptr"
; pvData : void* -> "sptr"
; cbData : DWORD -> "sptr"
; dwFlags : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "SHLWAPI.dll"
#cfunc global SHRegWriteUSValueA "SHRegWriteUSValueA" sptr, str, int, sptr, int, int
; res = SHRegWriteUSValueA(hUSKey, pszValue, dwType, pvData, cbData, dwFlags)
; hUSKey : INT_PTR -> "sptr"
; pszValue : LPCSTR -> "str"
; dwType : DWORD -> "int"
; pvData : void* -> "sptr"
; cbData : DWORD -> "int"
; dwFlags : DWORD -> "int"
; WIN32_ERROR SHRegWriteUSValueA(INT_PTR hUSKey, LPCSTR pszValue, DWORD dwType, void* pvData, DWORD cbData, DWORD dwFlags)
#uselib "SHLWAPI.dll"
#cfunc global SHRegWriteUSValueA "SHRegWriteUSValueA" intptr, str, int, intptr, int, int
; res = SHRegWriteUSValueA(hUSKey, pszValue, dwType, pvData, cbData, dwFlags)
; hUSKey : INT_PTR -> "intptr"
; pszValue : LPCSTR -> "str"
; 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")
	procSHRegWriteUSValueA = shlwapi.NewProc("SHRegWriteUSValueA")
)

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

extern "shlwapi" fn SHRegWriteUSValueA(
    hUSKey: isize, // INT_PTR
    pszValue: [*c]const u8, // LPCSTR
    dwType: u32, // DWORD
    pvData: ?*anyopaque, // void*
    cbData: u32, // DWORD
    dwFlags: u32 // DWORD
) callconv(std.os.windows.WINAPI) u32;
proc SHRegWriteUSValueA(
    hUSKey: int,  # INT_PTR
    pszValue: cstring,  # LPCSTR
    dwType: uint32,  # DWORD
    pvData: pointer,  # void*
    cbData: uint32,  # DWORD
    dwFlags: uint32  # DWORD
): uint32 {.importc: "SHRegWriteUSValueA", stdcall, dynlib: "SHLWAPI.dll".}
pragma(lib, "shlwapi");
extern(Windows)
uint SHRegWriteUSValueA(
    ptrdiff_t hUSKey,   // INT_PTR
    const(char)* pszValue,   // LPCSTR
    uint dwType,   // DWORD
    void* pvData,   // void*
    uint cbData,   // DWORD
    uint dwFlags   // DWORD
);
ccall((:SHRegWriteUSValueA, "SHLWAPI.dll"), stdcall, UInt32,
      (Int, Cstring, UInt32, Ptr{Cvoid}, UInt32, UInt32),
      hUSKey, pszValue, dwType, pvData, cbData, dwFlags)
# hUSKey : INT_PTR -> Int
# pszValue : LPCSTR -> Cstring
# dwType : DWORD -> UInt32
# pvData : void* -> Ptr{Cvoid}
# cbData : DWORD -> UInt32
# dwFlags : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t SHRegWriteUSValueA(
    intptr_t hUSKey,
    const char* pszValue,
    uint32_t dwType,
    void* pvData,
    uint32_t cbData,
    uint32_t dwFlags);
]]
local shlwapi = ffi.load("shlwapi")
-- shlwapi.SHRegWriteUSValueA(hUSKey, pszValue, dwType, pvData, cbData, dwFlags)
-- hUSKey : INT_PTR
-- pszValue : LPCSTR
-- dwType : DWORD
-- pvData : void*
-- cbData : DWORD
-- dwFlags : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('SHLWAPI.dll');
const SHRegWriteUSValueA = lib.func('__stdcall', 'SHRegWriteUSValueA', 'uint32_t', ['intptr_t', 'str', 'uint32_t', 'void *', 'uint32_t', 'uint32_t']);
// SHRegWriteUSValueA(hUSKey, pszValue, dwType, pvData, cbData, dwFlags)
// hUSKey : INT_PTR -> 'intptr_t'
// pszValue : LPCSTR -> 'str'
// 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", {
  SHRegWriteUSValueA: { parameters: ["isize", "buffer", "u32", "pointer", "u32", "u32"], result: "u32" },
});
// lib.symbols.SHRegWriteUSValueA(hUSKey, pszValue, dwType, pvData, cbData, dwFlags)
// hUSKey : INT_PTR -> "isize"
// pszValue : LPCSTR -> "buffer"
// dwType : DWORD -> "u32"
// pvData : void* -> "pointer"
// cbData : DWORD -> "u32"
// dwFlags : DWORD -> "u32"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t SHRegWriteUSValueA(
    intptr_t hUSKey,
    const char* pszValue,
    uint32_t dwType,
    void* pvData,
    uint32_t cbData,
    uint32_t dwFlags);
C, "SHLWAPI.dll");
// $ffi->SHRegWriteUSValueA(hUSKey, pszValue, dwType, pvData, cbData, dwFlags);
// hUSKey : INT_PTR
// pszValue : LPCSTR
// 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.ASCII_OPTIONS);
    int SHRegWriteUSValueA(
        long hUSKey,   // INT_PTR
        String pszValue,   // LPCSTR
        int dwType,   // DWORD
        Pointer pvData,   // void*
        int cbData,   // DWORD
        int dwFlags   // DWORD
    );
}
@[Link("shlwapi")]
lib LibSHLWAPI
  fun SHRegWriteUSValueA = SHRegWriteUSValueA(
    hUSKey : LibC::SSizeT,   # INT_PTR
    pszValue : UInt8*,   # LPCSTR
    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 SHRegWriteUSValueANative = Uint32 Function(IntPtr, Pointer<Utf8>, Uint32, Pointer<Void>, Uint32, Uint32);
typedef SHRegWriteUSValueADart = int Function(int, Pointer<Utf8>, int, Pointer<Void>, int, int);
final SHRegWriteUSValueA = DynamicLibrary.open('SHLWAPI.dll')
    .lookupFunction<SHRegWriteUSValueANative, SHRegWriteUSValueADart>('SHRegWriteUSValueA');
// hUSKey : INT_PTR -> IntPtr
// pszValue : LPCSTR -> Pointer<Utf8>
// dwType : DWORD -> Uint32
// pvData : void* -> Pointer<Void>
// cbData : DWORD -> Uint32
// dwFlags : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SHRegWriteUSValueA(
  hUSKey: NativeInt;   // INT_PTR
  pszValue: PAnsiChar;   // LPCSTR
  dwType: DWORD;   // DWORD
  pvData: Pointer;   // void*
  cbData: DWORD;   // DWORD
  dwFlags: DWORD   // DWORD
): DWORD; stdcall;
  external 'SHLWAPI.dll' name 'SHRegWriteUSValueA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SHRegWriteUSValueA"
  c_SHRegWriteUSValueA :: CIntPtr -> CString -> Word32 -> Ptr () -> Word32 -> Word32 -> IO Word32
-- hUSKey : INT_PTR -> CIntPtr
-- pszValue : LPCSTR -> CString
-- dwType : DWORD -> Word32
-- pvData : void* -> Ptr ()
-- cbData : DWORD -> Word32
-- dwFlags : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let shregwriteusvaluea =
  foreign "SHRegWriteUSValueA"
    (intptr_t @-> string @-> uint32_t @-> (ptr void) @-> uint32_t @-> uint32_t @-> returning uint32_t)
(* hUSKey : INT_PTR -> intptr_t *)
(* pszValue : LPCSTR -> string *)
(* 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 ("SHRegWriteUSValueA" shreg-write-usvalue-a :convention :stdcall) :uint32
  (h-uskey :int64)   ; INT_PTR
  (psz-value :string)   ; LPCSTR
  (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 $SHRegWriteUSValueA = Win32::API::More->new('SHLWAPI',
    'DWORD SHRegWriteUSValueA(LPARAM hUSKey, LPCSTR pszValue, DWORD dwType, LPVOID pvData, DWORD cbData, DWORD dwFlags)');
# my $ret = $SHRegWriteUSValueA->Call($hUSKey, $pszValue, $dwType, $pvData, $cbData, $dwFlags);
# hUSKey : INT_PTR -> LPARAM
# pszValue : LPCSTR -> LPCSTR
# dwType : DWORD -> DWORD
# pvData : void* -> LPVOID
# cbData : DWORD -> DWORD
# dwFlags : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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