RegCreateKeyExW

関数

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

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

シグネチャ

// ADVAPI32.dll  (Unicode / -W)
#include <windows.h>

WIN32_ERROR RegCreateKeyExW(
    HKEY hKey,
    LPCWSTR lpSubKey,
    DWORD Reserved,   // optional
    LPWSTR 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 アクセス権を持っている必要があります。詳細については、 Registry Key Security and Access Rights を参照してください。

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

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

HKEY_CLASSES_ROOT

HKEY_CURRENT_CONFIG

HKEY_CURRENT_USER

HKEY_LOCAL_MACHINE

HKEY_USERS

lpSubKey

LPCWSTR

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

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

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

Reserved

DWORD

optional

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

lpClass

LPWSTR

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 アクセス権で開かれます。両方の特権が有効になっている場合、キーは両方の特権を組み合わせたアクセス権を持ちます。詳細については、 Running with Special Privileges を参照してください。
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

作成するキーのアクセス権を指定するマスク。詳細については、 Registry Key Security and Access Rights を参照してください。

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

公式ドキュメント

指定したレジストリキーを作成します。キーが既に存在する場合、この関数はそのキーを開きます。なお、キー名は大文字と小文字を区別しません。(Unicode)

戻り値

関数が成功すると、戻り値は ERROR_SUCCESS です。

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

解説(Remarks)

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

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

subkey1\subkey2\subkey3\subkey4

なお、この動作のため、パス内の既存のキーのスペルが間違っていると、意図しないキーが作成される結果になります。

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

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

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

メモ

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

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

各言語での呼び出し定義

// ADVAPI32.dll  (Unicode / -W)
#include <windows.h>

WIN32_ERROR RegCreateKeyExW(
    HKEY hKey,
    LPCWSTR lpSubKey,
    DWORD Reserved,   // optional
    LPWSTR 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.Unicode, ExactSpelling = true)]
static extern uint RegCreateKeyExW(
    IntPtr hKey,   // HKEY
    [MarshalAs(UnmanagedType.LPWStr)] string lpSubKey,   // LPCWSTR
    uint Reserved,   // DWORD optional
    [MarshalAs(UnmanagedType.LPWStr)] string lpClass,   // LPWSTR 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.Unicode, ExactSpelling:=True)>
Public Shared Function RegCreateKeyExW(
    hKey As IntPtr,   ' HKEY
    <MarshalAs(UnmanagedType.LPWStr)> lpSubKey As String,   ' LPCWSTR
    Reserved As UInteger,   ' DWORD optional
    <MarshalAs(UnmanagedType.LPWStr)> lpClass As String,   ' LPWSTR 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 : LPCWSTR
' Reserved : DWORD optional
' lpClass : LPWSTR 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 RegCreateKeyExW Lib "advapi32" ( _
    ByVal hKey As LongPtr, _
    ByVal lpSubKey As LongPtr, _
    ByVal Reserved As Long, _
    ByVal lpClass As LongPtr, _
    ByVal dwOptions As Long, _
    ByVal samDesired As Long, _
    ByVal lpSecurityAttributes As LongPtr, _
    ByVal phkResult As LongPtr, _
    ByVal lpdwDisposition As LongPtr) 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

RegCreateKeyExW = ctypes.windll.advapi32.RegCreateKeyExW
RegCreateKeyExW.restype = wintypes.DWORD
RegCreateKeyExW.argtypes = [
    wintypes.HANDLE,  # hKey : HKEY
    wintypes.LPCWSTR,  # lpSubKey : LPCWSTR
    wintypes.DWORD,  # Reserved : DWORD optional
    wintypes.LPCWSTR,  # lpClass : LPWSTR 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')
RegCreateKeyExW = Fiddle::Function.new(
  lib['RegCreateKeyExW'],
  [
    Fiddle::TYPE_VOIDP,  # hKey : HKEY
    Fiddle::TYPE_VOIDP,  # lpSubKey : LPCWSTR
    -Fiddle::TYPE_INT,  # Reserved : DWORD optional
    Fiddle::TYPE_VOIDP,  # lpClass : LPWSTR 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)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "advapi32")]
extern "system" {
    fn RegCreateKeyExW(
        hKey: *mut core::ffi::c_void,  // HKEY
        lpSubKey: *const u16,  // LPCWSTR
        Reserved: u32,  // DWORD optional
        lpClass: *mut u16,  // LPWSTR 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.Unicode)]
public static extern uint RegCreateKeyExW(IntPtr hKey, [MarshalAs(UnmanagedType.LPWStr)] string lpSubKey, uint Reserved, [MarshalAs(UnmanagedType.LPWStr)] string lpClass, uint dwOptions, uint samDesired, IntPtr lpSecurityAttributes, IntPtr phkResult, IntPtr lpdwDisposition);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_RegCreateKeyExW' -Namespace Win32 -PassThru
# $api::RegCreateKeyExW(hKey, lpSubKey, Reserved, lpClass, dwOptions, samDesired, lpSecurityAttributes, phkResult, lpdwDisposition)

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

出力引数:

#uselib "ADVAPI32.dll"
#cfunc global RegCreateKeyExW "RegCreateKeyExW" sptr, wstr, int, wstr, int, int, var, sptr, var
; res = RegCreateKeyExW(hKey, lpSubKey, Reserved, lpClass, dwOptions, samDesired, lpSecurityAttributes, phkResult, lpdwDisposition)
; hKey : HKEY -> "sptr"
; lpSubKey : LPCWSTR -> "wstr"
; Reserved : DWORD optional -> "int"
; lpClass : LPWSTR optional -> "wstr"
; 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 RegCreateKeyExW "RegCreateKeyExW" sptr, wstr, int, wstr, int, int, sptr, sptr, sptr
; res = RegCreateKeyExW(hKey, lpSubKey, Reserved, lpClass, dwOptions, samDesired, varptr(lpSecurityAttributes), phkResult, varptr(lpdwDisposition))
; hKey : HKEY -> "sptr"
; lpSubKey : LPCWSTR -> "wstr"
; Reserved : DWORD optional -> "int"
; lpClass : LPWSTR optional -> "wstr"
; 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(変数))。