RegCreateKeyExA

関数

オプションやアクセス権を指定してレジストリキーを作成または開く。

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

シグネチャ

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

WIN32_ERROR RegCreateKeyExA(
    HKEY hKey,
    LPCSTR lpSubKey,
    DWORD Reserved,   // optional
    LPSTR lpClass,   // optional
    REG_OPEN_CREATE_OPTIONS dwOptions,
    REG_SAM_FLAGS samDesired,
    const SECURITY_ATTRIBUTES* lpSecurityAttributes,   // optional
    HKEY* phkResult,
    REG_CREATE_KEY_DISPOSITION* lpdwDisposition   // optional
);

パラメーター

名前

型

方向

説明

hKey

HKEY

開いているレジストリキーへのハンドル。呼び出し元のプロセスは、そのキーに対する KEY_CREATE_SUB_KEY アクセス権を持っている必要があります。詳細については、レジストリキーのセキュリティとアクセス権を参照してください。

キー作成のためのアクセスは、ハンドル取得時に指定したアクセスマスクではなく、レジストリキーのセキュリティ記述子に対して検査されます。したがって、hKey が samDesired に KEY_READ を指定して開かれていた場合でも、そのセキュリティ記述子が許可していれば、レジストリを変更する操作に使用できます。

このハンドルは、 RegCreateKeyEx または RegOpenKeyEx 関数によって返されます。あるいは、次の定義済みキーのいずれかを指定することもできます。

HKEY_CLASSES_ROOT

HKEY_CURRENT_CONFIG

HKEY_CURRENT_USER

HKEY_LOCAL_MACHINE

HKEY_USERS

lpSubKey

LPCSTR

この関数が開く、または作成するサブキーの名前。指定するサブキーは、hKey パラメーターで識別されるキーのサブキーである必要があります。レジストリツリー内で最大 32 レベルの深さまで指定できます。キー名の詳細については、レジストリの構造を参照してください。

lpSubKey が空の文字列へのポインターである場合、phkResult は hKey で指定されたキーへの新しいハンドルを受け取ります。

このパラメーターを NULL にすることはできません。

Reserved

DWORD

optional

このパラメーターは予約されており、ゼロにする必要があります。

lpClass

LPSTR

inoptional

このキーのユーザー定義のクラス型。このパラメーターは無視される場合があります。このパラメーターは NULL にすることができます。

dwOptions

REG_OPEN_CREATE_OPTIONS

このパラメーターには、次のいずれかの値を指定できます。

値	意味
REG_OPTION_BACKUP_RESTORE 0x00000004L	このフラグが設定されている場合、関数は samDesired パラメーターを無視し、キーのバックアップまたは復元に必要なアクセス権でキーを開こうとします。呼び出し元のスレッドで SE_BACKUP_NAME 特権が有効になっている場合、キーは ACCESS_SYSTEM_SECURITY および KEY_READ アクセス権で開かれます。呼び出し元のスレッドで SE_RESTORE_NAME 特権が有効になっている場合、Windows Vista 以降では、キーは ACCESS_SYSTEM_SECURITY、DELETE および KEY_WRITE アクセス権で開かれます。両方の特権が有効になっている場合、キーは両方の特権を組み合わせたアクセス権を持ちます。詳細については、特別な特権での実行を参照してください。
REG_OPTION_CREATE_LINK 0x00000002L	注意レジストリのシンボリックリンクは、どうしても必要な場合のアプリケーション互換性のためにのみ使用してください。このキーはシンボリックリンクです。ターゲットパスは、キーの L"SymbolicLinkValue" 値に割り当てられます。ターゲットパスは絶対レジストリパスである必要があります。
REG_OPTION_NON_VOLATILE 0x00000000L	このキーは揮発性ではありません。これが既定の動作です。情報はファイルに格納され、システムの再起動時にも保持されます。 RegSaveKey 関数は、揮発性ではないキーを保存します。
REG_OPTION_VOLATILE 0x00000001L	この関数によって作成されるすべてのキーは揮発性です。情報はメモリに格納され、対応するレジストリハイブがアンロードされると保持されません。HKEY_LOCAL_MACHINE の場合、これはシステムが完全なシャットダウンを開始したときにのみ発生します。 RegLoadKey 関数によって読み込まれたレジストリキーの場合、これは対応する RegUnLoadKey が実行されたときに発生します。 RegSaveKey 関数は揮発性キーを保存しません。このフラグは、既に存在するキーに対しては無視されます。注意ユーザーが選択するシャットダウンでは、高速スタートアップによるシャットダウンがシステムの既定の動作です。

samDesired

REG_SAM_FLAGS

作成するキーのアクセス権を指定するマスク。詳細については、レジストリキーのセキュリティとアクセス権を参照してください。

lpSecurityAttributes

SECURITY_ATTRIBUTES*

inoptional

返されるハンドルが子プロセスによって継承可能かどうかを決定する SECURITY_ATTRIBUTES 構造体へのポインター。lpSecurityAttributes が NULL の場合、ハンドルは継承できません。

構造体の lpSecurityDescriptor メンバーは、新しいキーのセキュリティ記述子を指定します。lpSecurityAttributes が NULL の場合、キーには既定のセキュリティ記述子が付与されます。キーの既定のセキュリティ記述子内の ACL は、その直接の親キーから継承されます。

phkResult

HKEY*

out

開かれた、または作成されたキーへのハンドルを受け取る変数へのポインター。キーが定義済みレジストリキーのいずれでもない場合は、ハンドルの使用を終えた後で RegCloseKey 関数を呼び出してください。

lpdwDisposition

REG_CREATE_KEY_DISPOSITION*

outoptional

次のいずれかの処理結果(disposition)値を受け取る変数へのポインター。

値	意味
REG_CREATED_NEW_KEY 0x00000001L	キーは存在せず、新しく作成されました。
REG_OPENED_EXISTING_KEY 0x00000002L	キーは既に存在し、変更されることなく単に開かれました。

lpdwDisposition が NULL の場合、処理結果情報は返されません。

戻り値の型: WIN32_ERROR

公式ドキュメント

指定されたレジストリキーを作成します。キーが既に存在する場合、この関数はそのキーを開きます。キー名は大文字と小文字を区別しないことに注意してください。(ANSI)

戻り値

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

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

解説(Remarks)

RegCreateKeyEx 関数が作成するキーには値がありません。アプリケーションは、 RegSetValueEx 関数を使用してキーの値を設定できます。

RegCreateKeyEx 関数は、指定されたパス内に存在しないすべてのキーを作成します。アプリケーションは、この動作を利用して複数のキーを一度に作成できます。たとえば、lpSubKey パラメーターに次の形式の文字列を指定することで、アプリケーションは 4 レベルの深さのサブキーを、それに先行する 3 つのサブキーと同時に作成できます。

subkey1\subkey2\subkey3\subkey4

この動作により、パス内の既存のキーのスペルが誤っている場合には、意図しないキーが作成されることに注意してください。

アプリケーションは、HKEY_USERS または HKEY_LOCAL_MACHINE の直接の子であるキーを作成することはできません。アプリケーションは、HKEY_USERS または HKEY_LOCAL_MACHINE ツリーのより下位のレベルにサブキーを作成できます。

サービスやアプリケーションが異なるユーザーを偽装(impersonate)する場合は、この関数を HKEY_CURRENT_USER とともに使用しないでください。代わりに、RegOpenCurrentUser 関数を呼び出してください。

特定のレジストリキーにアクセスする操作はリダイレクトされることに注意してください。詳細については、レジストリの仮想化およびレジストリ内の 32 ビットおよび 64 ビットアプリケーションデータを参照してください。

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 RegCreateKeyExA(
    HKEY hKey,
    LPCSTR lpSubKey,
    DWORD Reserved,   // optional
    LPSTR lpClass,   // optional
    REG_OPEN_CREATE_OPTIONS dwOptions,
    REG_SAM_FLAGS samDesired,
    const SECURITY_ATTRIBUTES* lpSecurityAttributes,   // optional
    HKEY* phkResult,
    REG_CREATE_KEY_DISPOSITION* lpdwDisposition   // optional
);

[DllImport("ADVAPI32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint RegCreateKeyExA(
    IntPtr hKey,   // HKEY
    [MarshalAs(UnmanagedType.LPStr)] string lpSubKey,   // LPCSTR
    uint Reserved,   // DWORD optional
    [MarshalAs(UnmanagedType.LPStr)] string lpClass,   // LPSTR optional
    uint dwOptions,   // REG_OPEN_CREATE_OPTIONS
    uint samDesired,   // REG_SAM_FLAGS
    IntPtr lpSecurityAttributes,   // SECURITY_ATTRIBUTES* optional
    IntPtr phkResult,   // HKEY* out
    IntPtr lpdwDisposition   // REG_CREATE_KEY_DISPOSITION* optional, out
);

<DllImport("ADVAPI32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function RegCreateKeyExA(
    hKey As IntPtr,   ' HKEY
    <MarshalAs(UnmanagedType.LPStr)> lpSubKey As String,   ' LPCSTR
    Reserved As UInteger,   ' DWORD optional
    <MarshalAs(UnmanagedType.LPStr)> lpClass As String,   ' LPSTR optional
    dwOptions As UInteger,   ' REG_OPEN_CREATE_OPTIONS
    samDesired As UInteger,   ' REG_SAM_FLAGS
    lpSecurityAttributes As IntPtr,   ' SECURITY_ATTRIBUTES* optional
    phkResult As IntPtr,   ' HKEY* out
    lpdwDisposition As IntPtr   ' REG_CREATE_KEY_DISPOSITION* optional, out
) As UInteger
End Function

' hKey : HKEY
' lpSubKey : LPCSTR
' Reserved : DWORD optional
' lpClass : LPSTR optional
' dwOptions : REG_OPEN_CREATE_OPTIONS
' samDesired : REG_SAM_FLAGS
' lpSecurityAttributes : SECURITY_ATTRIBUTES* optional
' phkResult : HKEY* out
' lpdwDisposition : REG_CREATE_KEY_DISPOSITION* optional, out
Declare PtrSafe Function RegCreateKeyExA Lib "advapi32" ( _
    ByVal hKey As LongPtr, _
    ByVal lpSubKey As String, _
    ByVal Reserved As Long, _
    ByVal lpClass As String, _
    ByVal dwOptions As Long, _
    ByVal samDesired As Long, _
    ByVal lpSecurityAttributes As LongPtr, _
    ByVal phkResult As LongPtr, _
    ByVal lpdwDisposition As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

RegCreateKeyExA = ctypes.windll.advapi32.RegCreateKeyExA
RegCreateKeyExA.restype = wintypes.DWORD
RegCreateKeyExA.argtypes = [
    wintypes.HANDLE,  # hKey : HKEY
    wintypes.LPCSTR,  # lpSubKey : LPCSTR
    wintypes.DWORD,  # Reserved : DWORD optional
    wintypes.LPCSTR,  # lpClass : LPSTR optional
    wintypes.DWORD,  # dwOptions : REG_OPEN_CREATE_OPTIONS
    wintypes.DWORD,  # samDesired : REG_SAM_FLAGS
    ctypes.c_void_p,  # lpSecurityAttributes : SECURITY_ATTRIBUTES* optional
    ctypes.c_void_p,  # phkResult : HKEY* out
    ctypes.c_void_p,  # lpdwDisposition : REG_CREATE_KEY_DISPOSITION* optional, out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
RegCreateKeyExA = Fiddle::Function.new(
  lib['RegCreateKeyExA'],
  [
    Fiddle::TYPE_VOIDP,  # hKey : HKEY
    Fiddle::TYPE_VOIDP,  # lpSubKey : LPCSTR
    -Fiddle::TYPE_INT,  # Reserved : DWORD optional
    Fiddle::TYPE_VOIDP,  # lpClass : LPSTR optional
    -Fiddle::TYPE_INT,  # dwOptions : REG_OPEN_CREATE_OPTIONS
    -Fiddle::TYPE_INT,  # samDesired : REG_SAM_FLAGS
    Fiddle::TYPE_VOIDP,  # lpSecurityAttributes : SECURITY_ATTRIBUTES* optional
    Fiddle::TYPE_VOIDP,  # phkResult : HKEY* out
    Fiddle::TYPE_VOIDP,  # lpdwDisposition : REG_CREATE_KEY_DISPOSITION* optional, out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "advapi32")]
extern "system" {
    fn RegCreateKeyExA(
        hKey: *mut core::ffi::c_void,  // HKEY
        lpSubKey: *const u8,  // LPCSTR
        Reserved: u32,  // DWORD optional
        lpClass: *mut u8,  // LPSTR optional
        dwOptions: u32,  // REG_OPEN_CREATE_OPTIONS
        samDesired: u32,  // REG_SAM_FLAGS
        lpSecurityAttributes: *const SECURITY_ATTRIBUTES,  // SECURITY_ATTRIBUTES* optional
        phkResult: *mut *mut core::ffi::c_void,  // HKEY* out
        lpdwDisposition: *mut u32  // REG_CREATE_KEY_DISPOSITION* optional, out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("ADVAPI32.dll", CharSet = CharSet.Ansi)]
public static extern uint RegCreateKeyExA(IntPtr hKey, [MarshalAs(UnmanagedType.LPStr)] string lpSubKey, uint Reserved, [MarshalAs(UnmanagedType.LPStr)] string lpClass, uint dwOptions, uint samDesired, IntPtr lpSecurityAttributes, IntPtr phkResult, IntPtr lpdwDisposition);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_RegCreateKeyExA' -Namespace Win32 -PassThru
# $api::RegCreateKeyExA(hKey, lpSubKey, Reserved, lpClass, dwOptions, samDesired, lpSecurityAttributes, phkResult, lpdwDisposition)

#uselib "ADVAPI32.dll"
#func global RegCreateKeyExA "RegCreateKeyExA" sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr
; RegCreateKeyExA hKey, lpSubKey, Reserved, lpClass, dwOptions, samDesired, varptr(lpSecurityAttributes), phkResult, varptr(lpdwDisposition)   ; 戻り値は stat
; hKey : HKEY -> "sptr"
; lpSubKey : LPCSTR -> "sptr"
; Reserved : DWORD optional -> "sptr"
; lpClass : LPSTR optional -> "sptr"
; dwOptions : REG_OPEN_CREATE_OPTIONS -> "sptr"
; samDesired : REG_SAM_FLAGS -> "sptr"
; lpSecurityAttributes : SECURITY_ATTRIBUTES* optional -> "sptr"
; phkResult : HKEY* out -> "sptr"
; lpdwDisposition : REG_CREATE_KEY_DISPOSITION* optional, out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "ADVAPI32.dll"
#cfunc global RegCreateKeyExA "RegCreateKeyExA" sptr, str, int, str, int, int, var, sptr, var
; res = RegCreateKeyExA(hKey, lpSubKey, Reserved, lpClass, dwOptions, samDesired, lpSecurityAttributes, phkResult, lpdwDisposition)
; hKey : HKEY -> "sptr"
; lpSubKey : LPCSTR -> "str"
; Reserved : DWORD optional -> "int"
; lpClass : LPSTR optional -> "str"
; dwOptions : REG_OPEN_CREATE_OPTIONS -> "int"
; samDesired : REG_SAM_FLAGS -> "int"
; lpSecurityAttributes : SECURITY_ATTRIBUTES* optional -> "var"
; phkResult : HKEY* out -> "sptr"
; lpdwDisposition : REG_CREATE_KEY_DISPOSITION* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "ADVAPI32.dll"
#cfunc global RegCreateKeyExA "RegCreateKeyExA" sptr, str, int, str, int, int, sptr, sptr, sptr
; res = RegCreateKeyExA(hKey, lpSubKey, Reserved, lpClass, dwOptions, samDesired, varptr(lpSecurityAttributes), phkResult, varptr(lpdwDisposition))
; hKey : HKEY -> "sptr"
; lpSubKey : LPCSTR -> "str"
; Reserved : DWORD optional -> "int"
; lpClass : LPSTR optional -> "str"
; dwOptions : REG_OPEN_CREATE_OPTIONS -> "int"
; samDesired : REG_SAM_FLAGS -> "int"
; lpSecurityAttributes : SECURITY_ATTRIBUTES* optional -> "sptr"
; phkResult : HKEY* out -> "sptr"
; lpdwDisposition : REG_CREATE_KEY_DISPOSITION* optional, out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。