ホーム › UI.Shell › SHRegSetUSValueA

SHRegSetUSValueA

関数

ユーザー単位レジストリのサブキーと値名に値を設定する。

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

シグネチャ

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

WIN32_ERROR SHRegSetUSValueA(
    LPCSTR pszSubKey,
    LPCSTR pszValue,
    DWORD dwType,
    const void* pvData,   // optional
    DWORD cbData,   // optional
    DWORD dwFlags   // optional
);

パラメーター

名前	型	方向	説明
pszSubKey	LPCSTR	in	サブキーの名前を表す、null で終わる文字列へのポインターです。
pszValue	LPCSTR	in	値の名前を指定する、null で終わる文字列へのポインターです。
dwType	DWORD	in	格納するデータの型です。このパラメーターは REG_SZ 型である必要があります。詳細については、Registry Data Types を参照してください。
pvData	void*	inoptional	指定したキーに設定する値を含む、null で終わる文字列へのポインターです。
cbData	DWORD	inoptional	pvData パラメーターが指す文字列の長さ(バイト単位)です。終端の null 文字は含みません。
dwFlags	DWORD	inoptional	データの書き込み先を示すフラグです。 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)内のレジストリサブキーの値を設定します。(ANSI)

戻り値

型: 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  (ANSI / -A)
#include <windows.h>

WIN32_ERROR SHRegSetUSValueA(
    LPCSTR pszSubKey,
    LPCSTR pszValue,
    DWORD dwType,
    const void* pvData,   // optional
    DWORD cbData,   // optional
    DWORD dwFlags   // optional
);

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

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

' pszSubKey : LPCSTR
' pszValue : LPCSTR
' dwType : DWORD
' pvData : void* optional
' cbData : DWORD optional
' dwFlags : DWORD optional
Declare PtrSafe Function SHRegSetUSValueA Lib "shlwapi" ( _
    ByVal pszSubKey As String, _
    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

SHRegSetUSValueA = ctypes.windll.shlwapi.SHRegSetUSValueA
SHRegSetUSValueA.restype = wintypes.DWORD
SHRegSetUSValueA.argtypes = [
    wintypes.LPCSTR,  # pszSubKey : LPCSTR
    wintypes.LPCSTR,  # pszValue : LPCSTR
    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')
SHRegSetUSValueA = Fiddle::Function.new(
  lib['SHRegSetUSValueA'],
  [
    Fiddle::TYPE_VOIDP,  # pszSubKey : LPCSTR
    Fiddle::TYPE_VOIDP,  # pszValue : LPCSTR
    -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)

#[link(name = "shlwapi")]
extern "system" {
    fn SHRegSetUSValueA(
        pszSubKey: *const u8,  // LPCSTR
        pszValue: *const u8,  // LPCSTR
        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.Ansi)]
public static extern uint SHRegSetUSValueA([MarshalAs(UnmanagedType.LPStr)] string pszSubKey, [MarshalAs(UnmanagedType.LPStr)] string pszValue, uint dwType, IntPtr pvData, uint cbData, uint dwFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_SHRegSetUSValueA' -Namespace Win32 -PassThru
# $api::SHRegSetUSValueA(pszSubKey, pszValue, dwType, pvData, cbData, dwFlags)

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

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

; WIN32_ERROR SHRegSetUSValueA(LPCSTR pszSubKey, LPCSTR pszValue, DWORD dwType, void* pvData, DWORD cbData, DWORD dwFlags)
#uselib "SHLWAPI.dll"
#cfunc global SHRegSetUSValueA "SHRegSetUSValueA" str, str, int, intptr, int, int
; res = SHRegSetUSValueA(pszSubKey, pszValue, dwType, pvData, cbData, dwFlags)
; pszSubKey : LPCSTR -> "str"
; pszValue : LPCSTR -> "str"
; 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")
	procSHRegSetUSValueA = shlwapi.NewProc("SHRegSetUSValueA")
)

// pszSubKey (LPCSTR), pszValue (LPCSTR), dwType (DWORD), pvData (void* optional), cbData (DWORD optional), dwFlags (DWORD optional)
r1, _, err := procSHRegSetUSValueA.Call(
	uintptr(unsafe.Pointer(windows.BytePtrFromString(pszSubKey))),
	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 SHRegSetUSValueA(
  pszSubKey: PAnsiChar;   // LPCSTR
  pszValue: PAnsiChar;   // LPCSTR
  dwType: DWORD;   // DWORD
  pvData: Pointer;   // void* optional
  cbData: DWORD;   // DWORD optional
  dwFlags: DWORD   // DWORD optional
): DWORD; stdcall;
  external 'SHLWAPI.dll' name 'SHRegSetUSValueA';

result := DllCall("SHLWAPI\SHRegSetUSValueA"
    , "AStr", pszSubKey   ; LPCSTR
    , "AStr", pszValue   ; LPCSTR
    , "UInt", dwType   ; DWORD
    , "Ptr", pvData   ; void* optional
    , "UInt", cbData   ; DWORD optional
    , "UInt", dwFlags   ; DWORD optional
    , "UInt")   ; return: WIN32_ERROR

●SHRegSetUSValueA(pszSubKey, pszValue, dwType, pvData, cbData, dwFlags) = DLL("SHLWAPI.dll", "dword SHRegSetUSValueA(char*, char*, dword, void*, dword, dword)")
# 呼び出し: SHRegSetUSValueA(pszSubKey, pszValue, dwType, pvData, cbData, dwFlags)
# pszSubKey : LPCSTR -> "char*"
# pszValue : LPCSTR -> "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)。

const std = @import("std");

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

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

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

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

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

const koffi = require('koffi');
const lib = koffi.load('SHLWAPI.dll');
const SHRegSetUSValueA = lib.func('__stdcall', 'SHRegSetUSValueA', 'uint32_t', ['str', 'str', 'uint32_t', 'void *', 'uint32_t', 'uint32_t']);
// SHRegSetUSValueA(pszSubKey, pszValue, dwType, pvData, cbData, dwFlags)
// pszSubKey : LPCSTR -> 'str'
// pszValue : LPCSTR -> 'str'
// 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", {
  SHRegSetUSValueA: { parameters: ["buffer", "buffer", "u32", "pointer", "u32", "u32"], result: "u32" },
});
// lib.symbols.SHRegSetUSValueA(pszSubKey, pszValue, dwType, pvData, cbData, dwFlags)
// pszSubKey : LPCSTR -> "buffer"
// pszValue : LPCSTR -> "buffer"
// dwType : DWORD -> "u32"
// pvData : void* optional -> "pointer"
// cbData : DWORD optional -> "u32"
// dwFlags : DWORD optional -> "u32"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。

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

@[Link("shlwapi")]
lib LibSHLWAPI
  fun SHRegSetUSValueA = SHRegSetUSValueA(
    pszSubKey : UInt8*,   # LPCSTR
    pszValue : UInt8*,   # LPCSTR
    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 SHRegSetUSValueANative = Uint32 Function(Pointer<Utf8>, Pointer<Utf8>, Uint32, Pointer<Void>, Uint32, Uint32);
typedef SHRegSetUSValueADart = int Function(Pointer<Utf8>, Pointer<Utf8>, int, Pointer<Void>, int, int);
final SHRegSetUSValueA = DynamicLibrary.open('SHLWAPI.dll')
    .lookupFunction<SHRegSetUSValueANative, SHRegSetUSValueADart>('SHRegSetUSValueA');
// pszSubKey : LPCSTR -> Pointer<Utf8>
// pszValue : LPCSTR -> Pointer<Utf8>
// dwType : DWORD -> Uint32
// pvData : void* optional -> Pointer<Void>
// cbData : DWORD optional -> Uint32
// dwFlags : DWORD optional -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。

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

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

foreign import stdcall safe "SHRegSetUSValueA"
  c_SHRegSetUSValueA :: CString -> CString -> Word32 -> Ptr () -> Word32 -> Word32 -> IO Word32
-- pszSubKey : LPCSTR -> CString
-- pszValue : LPCSTR -> CString
-- 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 shregsetusvaluea =
  foreign "SHRegSetUSValueA"
    (string @-> string @-> uint32_t @-> (ptr void) @-> uint32_t @-> uint32_t @-> returning uint32_t)
(* pszSubKey : LPCSTR -> string *)
(* pszValue : LPCSTR -> string *)
(* 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 ("SHRegSetUSValueA" shreg-set-usvalue-a :convention :stdcall) :uint32
  (psz-sub-key :string)   ; LPCSTR
  (psz-value :string)   ; LPCSTR
  (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 $SHRegSetUSValueA = Win32::API::More->new('SHLWAPI',
    'DWORD SHRegSetUSValueA(LPCSTR pszSubKey, LPCSTR pszValue, DWORD dwType, LPVOID pvData, DWORD cbData, DWORD dwFlags)');
# my $ret = $SHRegSetUSValueA->Call($pszSubKey, $pszValue, $dwType, $pvData, $cbData, $dwFlags);
# pszSubKey : LPCSTR -> LPCSTR
# pszValue : LPCSTR -> LPCSTR
# dwType : DWORD -> DWORD
# pvData : void* optional -> LPVOID
# cbData : DWORD optional -> DWORD
# dwFlags : DWORD optional -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

SHRegSetUSValueA

シグネチャ

パラメーター

SHREGSET_HKCU

SHREGSET_FORCE_HKCU

SHREGSET_HKLM

SHREGSET_FORCE_HKLM

SHREGSET_DEFAULT

公式ドキュメント

戻り値

解説(Remarks)

各言語での呼び出し定義

関連項目