RegSetValueExA

関数

指定した名前のレジストリ値とデータを設定する。

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

シグネチャ

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

WIN32_ERROR RegSetValueExA(
    HKEY hKey,
    LPCSTR lpValueName,   // optional
    DWORD Reserved,   // optional
    REG_VALUE_TYPE dwType,
    const BYTE* lpData,   // optional
    DWORD cbData
);

パラメーター

名前	型	方向	説明
hKey	HKEY	in	開いているレジストリキーへのハンドル。キーは KEY_SET_VALUE アクセス権で開かれている必要があります。詳細については、 Registry Key Security and Access Rights を参照してください。このハンドルは、 RegCreateKeyEx、RegCreateKeyTransacted、RegOpenKeyEx、または RegOpenKeyTransacted 関数によって返されます。また、次の定義済みキーのいずれかを指定することもできます。 HKEY_CLASSES_ROOT HKEY_CURRENT_CONFIG HKEY_CURRENT_USER HKEY_LOCAL_MACHINE HKEY_USERS この関数の Unicode 版では、次の追加の定義済みキーがサポートされます。 HKEY_PERFORMANCE_TEXT HKEY_PERFORMANCE_NLSTEXT
lpValueName	LPCSTR	inoptional	設定する値の名前。この名前の値がキーにまだ存在しない場合、関数はその値をキーに追加します。 lpValueName が NULL または空文字列 "" の場合、関数はキーの名前なし(既定)の値の型とデータを設定します。詳細については、 Registry Element Size Limits を参照してください。レジストリキーは既定値を持ちませんが、任意の型を指定できる名前なしの値を 1 つ持つことができます。
Reserved	DWORD	optional	このパラメーターは予約されており、0 を指定する必要があります。
dwType	REG_VALUE_TYPE	in	lpData パラメーターが指すデータの型。指定可能な型の一覧については、 Registry Value Types を参照してください。
lpData	BYTE*	inoptional	格納するデータ。 REG_SZ などの文字列ベースの型の場合、文字列は null で終端されている必要があります。REG_MULTI_SZ データ型の場合、文字列は 2 つの null 文字で終端されている必要があります。注意 lpData が null 値を示すことは有効です。ただし、その場合は cbData を '0' に設定する必要があります。
cbData	DWORD	in	lpData パラメーターが指す情報のサイズ(バイト単位)。データの型が REG_SZ、REG_EXPAND_SZ、または REG_MULTI_SZ の場合、cbData には終端の null 文字のサイズを含める必要があります。

戻り値の型: WIN32_ERROR

公式ドキュメント

指定したレジストリキー配下の値のデータと型を設定します。(ANSI)

戻り値

関数が成功した場合、戻り値は ERROR_SUCCESS です。

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

解説(Remarks)

値のサイズは利用可能なメモリによって制限されます。ただし、大きな値をレジストリに格納すると、そのパフォーマンスに影響する場合があります。長い値(2,048 バイトを超えるもの)はファイルとして格納し、そのファイルの場所をレジストリに格納してください。

アイコン、ビットマップ、実行可能ファイルなどのアプリケーション要素は、ファイルとして格納し、レジストリには配置しないでください。

dwType が REG_SZ、REG_MULTI_SZ、または REG_EXPAND_SZ 型で、この関数の ANSI 版が使用されている場合(RegSetValueExA を明示的に呼び出すか、Windows.h ファイルをインクルードする前に UNICODE を定義しない場合のいずれか)、lpData パラメーターが指すデータは ANSI 文字列である必要があります。この文字列はレジストリに格納される前に Unicode に変換されます。

特定のレジストリキーにアクセスする操作はリダイレクトされる点に注意してください。詳細については、Registry Virtualization および 32-bit and 64-bit Application Data in the Registry を参照してください。

レジストリキーの値を設定するより便利な方法を提供する RegSetKeyValue 関数の使用を検討してください。

メモ

winreg.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして RegSetValueEx を定義します。エンコーディング中立のエイリアスの使用を、エンコーディング中立でないコードと混在させると、コンパイルエラーまたは実行時エラーを引き起こす不一致につながる可能性があります。詳細については、Conventions for Function Prototypes を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

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

WIN32_ERROR RegSetValueExA(
    HKEY hKey,
    LPCSTR lpValueName,   // optional
    DWORD Reserved,   // optional
    REG_VALUE_TYPE dwType,
    const BYTE* lpData,   // optional
    DWORD cbData
);

[DllImport("ADVAPI32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint RegSetValueExA(
    IntPtr hKey,   // HKEY
    [MarshalAs(UnmanagedType.LPStr)] string lpValueName,   // LPCSTR optional
    uint Reserved,   // DWORD optional
    uint dwType,   // REG_VALUE_TYPE
    IntPtr lpData,   // BYTE* optional
    uint cbData   // DWORD
);

<DllImport("ADVAPI32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function RegSetValueExA(
    hKey As IntPtr,   ' HKEY
    <MarshalAs(UnmanagedType.LPStr)> lpValueName As String,   ' LPCSTR optional
    Reserved As UInteger,   ' DWORD optional
    dwType As UInteger,   ' REG_VALUE_TYPE
    lpData As IntPtr,   ' BYTE* optional
    cbData As UInteger   ' DWORD
) As UInteger
End Function

' hKey : HKEY
' lpValueName : LPCSTR optional
' Reserved : DWORD optional
' dwType : REG_VALUE_TYPE
' lpData : BYTE* optional
' cbData : DWORD
Declare PtrSafe Function RegSetValueExA Lib "advapi32" ( _
    ByVal hKey As LongPtr, _
    ByVal lpValueName As String, _
    ByVal Reserved As Long, _
    ByVal dwType As Long, _
    ByVal lpData As LongPtr, _
    ByVal cbData As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

RegSetValueExA = ctypes.windll.advapi32.RegSetValueExA
RegSetValueExA.restype = wintypes.DWORD
RegSetValueExA.argtypes = [
    wintypes.HANDLE,  # hKey : HKEY
    wintypes.LPCSTR,  # lpValueName : LPCSTR optional
    wintypes.DWORD,  # Reserved : DWORD optional
    wintypes.DWORD,  # dwType : REG_VALUE_TYPE
    ctypes.POINTER(ctypes.c_ubyte),  # lpData : BYTE* optional
    wintypes.DWORD,  # cbData : DWORD
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
RegSetValueExA = Fiddle::Function.new(
  lib['RegSetValueExA'],
  [
    Fiddle::TYPE_VOIDP,  # hKey : HKEY
    Fiddle::TYPE_VOIDP,  # lpValueName : LPCSTR optional
    -Fiddle::TYPE_INT,  # Reserved : DWORD optional
    -Fiddle::TYPE_INT,  # dwType : REG_VALUE_TYPE
    Fiddle::TYPE_VOIDP,  # lpData : BYTE* optional
    -Fiddle::TYPE_INT,  # cbData : DWORD
  ],
  -Fiddle::TYPE_INT)

#[link(name = "advapi32")]
extern "system" {
    fn RegSetValueExA(
        hKey: *mut core::ffi::c_void,  // HKEY
        lpValueName: *const u8,  // LPCSTR optional
        Reserved: u32,  // DWORD optional
        dwType: u32,  // REG_VALUE_TYPE
        lpData: *const u8,  // BYTE* optional
        cbData: u32  // DWORD
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("ADVAPI32.dll", CharSet = CharSet.Ansi)]
public static extern uint RegSetValueExA(IntPtr hKey, [MarshalAs(UnmanagedType.LPStr)] string lpValueName, uint Reserved, uint dwType, IntPtr lpData, uint cbData);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_RegSetValueExA' -Namespace Win32 -PassThru
# $api::RegSetValueExA(hKey, lpValueName, Reserved, dwType, lpData, cbData)

#uselib "ADVAPI32.dll"
#func global RegSetValueExA "RegSetValueExA" sptr, sptr, sptr, sptr, sptr, sptr
; RegSetValueExA hKey, lpValueName, Reserved, dwType, varptr(lpData), cbData   ; 戻り値は stat
; hKey : HKEY -> "sptr"
; lpValueName : LPCSTR optional -> "sptr"
; Reserved : DWORD optional -> "sptr"
; dwType : REG_VALUE_TYPE -> "sptr"
; lpData : BYTE* optional -> "sptr"
; cbData : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "ADVAPI32.dll"
#cfunc global RegSetValueExA "RegSetValueExA" sptr, str, int, int, var, int
; res = RegSetValueExA(hKey, lpValueName, Reserved, dwType, lpData, cbData)
; hKey : HKEY -> "sptr"
; lpValueName : LPCSTR optional -> "str"
; Reserved : DWORD optional -> "int"
; dwType : REG_VALUE_TYPE -> "int"
; lpData : BYTE* optional -> "var"
; cbData : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "ADVAPI32.dll"
#cfunc global RegSetValueExA "RegSetValueExA" sptr, str, int, int, sptr, int
; res = RegSetValueExA(hKey, lpValueName, Reserved, dwType, varptr(lpData), cbData)
; hKey : HKEY -> "sptr"
; lpValueName : LPCSTR optional -> "str"
; Reserved : DWORD optional -> "int"
; dwType : REG_VALUE_TYPE -> "int"
; lpData : BYTE* optional -> "sptr"
; cbData : DWORD -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。