ホーム › System.Registry › RegCreateKeyTransactedA

RegCreateKeyTransactedA

関数

トランザクション処理でレジストリキーを作成または開く。

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

シグネチャ

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

WIN32_ERROR RegCreateKeyTransactedA(
    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
    HANDLE hTransaction,
    void* pExtendedParemeter   // optional
);

パラメーター

名前

型

方向

説明

hKey

HKEY

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

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

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

HKEY_CLASSES_ROOT

HKEY_CURRENT_CONFIG

HKEY_CURRENT_USER

HKEY_LOCAL_MACHINE

HKEY_USERS

lpSubKey

LPCSTR

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

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

hTransaction

HANDLE

アクティブなトランザクションへのハンドル。このハンドルは CreateTransaction 関数によって返されます。

pExtendedParemeter

void*

optional

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

戻り値の型: WIN32_ERROR

公式ドキュメント

指定したレジストリキーを作成し、トランザクションに関連付けます。(ANSI)

戻り値

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

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

解説(Remarks)

この関数を使用してキーを作成すると、そのキーに対する以降の操作はトランザクション化されます。トランザクションがコミットされる前にキーに対して非トランザクションの操作が行われた場合、トランザクションはロールバックされます。トランザクションがコミットまたはロールバックされた後で、さらに操作をトランザクション化するには、アクティブなトランザクションハンドルを指定して RegCreateKeyTransacted または RegOpenKeyTransacted でキーを再度開く必要があります。トランザクションの詳細については、Kernel Transaction Manager を参照してください。

なお、このキーのサブキーに対する以降の操作は自動的にはトランザクション化されません。したがって、RegDeleteKeyEx はトランザクション化された削除操作を実行しません。トランザクション化された削除操作を実行するには、代わりに RegDeleteKeyTransacted 関数を使用してください。

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

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

subkey1\subkey2\subkey3\subkey4

なお、この動作により、パス内の既存キーのつづりが誤っていると、意図しないキーが作成される結果になることに注意してください。

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

メモ

winreg.h ヘッダーは RegCreateKeyTransacted を、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  (ANSI / -A)
#include <windows.h>

WIN32_ERROR RegCreateKeyTransactedA(
    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
    HANDLE hTransaction,
    void* pExtendedParemeter   // optional
);

[DllImport("ADVAPI32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint RegCreateKeyTransactedA(
    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
    IntPtr hTransaction,   // HANDLE
    IntPtr pExtendedParemeter   // void* optional
);

<DllImport("ADVAPI32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function RegCreateKeyTransactedA(
    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
    hTransaction As IntPtr,   ' HANDLE
    pExtendedParemeter As IntPtr   ' void* optional
) 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
' hTransaction : HANDLE
' pExtendedParemeter : void* optional
Declare PtrSafe Function RegCreateKeyTransactedA 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, _
    ByVal hTransaction As LongPtr, _
    ByVal pExtendedParemeter As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

RegCreateKeyTransactedA = ctypes.windll.advapi32.RegCreateKeyTransactedA
RegCreateKeyTransactedA.restype = wintypes.DWORD
RegCreateKeyTransactedA.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
    wintypes.HANDLE,  # hTransaction : HANDLE
    ctypes.POINTER(None),  # pExtendedParemeter : void* optional
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
RegCreateKeyTransactedA = Fiddle::Function.new(
  lib['RegCreateKeyTransactedA'],
  [
    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_VOIDP,  # hTransaction : HANDLE
    Fiddle::TYPE_VOIDP,  # pExtendedParemeter : void* optional
  ],
  -Fiddle::TYPE_INT)

#[link(name = "advapi32")]
extern "system" {
    fn RegCreateKeyTransactedA(
        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
        hTransaction: *mut core::ffi::c_void,  // HANDLE
        pExtendedParemeter: *mut ()  // void* optional
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

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

#uselib "ADVAPI32.dll"
#func global RegCreateKeyTransactedA "RegCreateKeyTransactedA" sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr
; RegCreateKeyTransactedA hKey, lpSubKey, Reserved, lpClass, dwOptions, samDesired, varptr(lpSecurityAttributes), phkResult, varptr(lpdwDisposition), hTransaction, pExtendedParemeter   ; 戻り値は 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"
; hTransaction : HANDLE -> "sptr"
; pExtendedParemeter : void* optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "ADVAPI32.dll"
#cfunc global RegCreateKeyTransactedA "RegCreateKeyTransactedA" sptr, str, int, str, int, int, var, sptr, var, sptr, sptr
; res = RegCreateKeyTransactedA(hKey, lpSubKey, Reserved, lpClass, dwOptions, samDesired, lpSecurityAttributes, phkResult, lpdwDisposition, hTransaction, pExtendedParemeter)
; 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"
; hTransaction : HANDLE -> "sptr"
; pExtendedParemeter : void* optional -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "ADVAPI32.dll"
#cfunc global RegCreateKeyTransactedA "RegCreateKeyTransactedA" sptr, str, int, str, int, int, sptr, sptr, sptr, sptr, sptr
; res = RegCreateKeyTransactedA(hKey, lpSubKey, Reserved, lpClass, dwOptions, samDesired, varptr(lpSecurityAttributes), phkResult, varptr(lpdwDisposition), hTransaction, pExtendedParemeter)
; 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"
; hTransaction : HANDLE -> "sptr"
; pExtendedParemeter : void* optional -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。