ホーム › System.Registry › RegCreateKeyTransactedW

RegCreateKeyTransactedW

関数

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

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

シグネチャ

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

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

パラメーター

名前

型

方向

説明

hKey

HKEY

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

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

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

HKEY_CLASSES_ROOT

HKEY_CURRENT_CONFIG

HKEY_CURRENT_USER

HKEY_LOCAL_MACHINE

HKEY_USERS

lpSubKey

LPCWSTR

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

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

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

Reserved

DWORD

optional

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

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

hTransaction

HANDLE

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

pExtendedParemeter

void*

optional

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

戻り値の型: WIN32_ERROR

公式ドキュメント

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

戻り値

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

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

解説(Remarks)

この関数を使用してキーを作成すると、そのキーに対する以降の操作はトランザクション処理されます。トランザクションがコミットされる前にキーに対して非トランザクションの操作が実行されると、トランザクションはロールバックされます。トランザクションがコミットまたはロールバックされた後、追加の操作をトランザクション処理するには、アクティブなトランザクションハンドルを指定して RegCreateKeyTransacted または RegOpenKeyTransacted でキーを開き直す必要があります。トランザクションの詳細については、カーネルトランザクションマネージャーを参照してください。

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

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

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

subkey1\subkey2\subkey3\subkey4

この動作により、パス内の既存のキーのつづりが誤っている場合には、不要なキーが作成される結果になる点に注意してください。

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

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 RegCreateKeyTransactedW(
    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
    HANDLE hTransaction,
    void* pExtendedParemeter   // optional
);

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

<DllImport("ADVAPI32.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function RegCreateKeyTransactedW(
    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
    hTransaction As IntPtr,   ' HANDLE
    pExtendedParemeter As IntPtr   ' void* optional
) 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
' hTransaction : HANDLE
' pExtendedParemeter : void* optional
Declare PtrSafe Function RegCreateKeyTransactedW 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, _
    ByVal hTransaction As LongPtr, _
    ByVal pExtendedParemeter 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

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

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
RegCreateKeyTransactedW = Fiddle::Function.new(
  lib['RegCreateKeyTransactedW'],
  [
    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_VOIDP,  # hTransaction : HANDLE
    Fiddle::TYPE_VOIDP,  # pExtendedParemeter : void* optional
  ],
  -Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "advapi32")]
extern "system" {
    fn RegCreateKeyTransactedW(
        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
        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.Unicode)]
public static extern uint RegCreateKeyTransactedW(IntPtr hKey, [MarshalAs(UnmanagedType.LPWStr)] string lpSubKey, uint Reserved, [MarshalAs(UnmanagedType.LPWStr)] string lpClass, uint dwOptions, uint samDesired, IntPtr lpSecurityAttributes, IntPtr phkResult, IntPtr lpdwDisposition, IntPtr hTransaction, IntPtr pExtendedParemeter);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_RegCreateKeyTransactedW' -Namespace Win32 -PassThru
# $api::RegCreateKeyTransactedW(hKey, lpSubKey, Reserved, lpClass, dwOptions, samDesired, lpSecurityAttributes, phkResult, lpdwDisposition, hTransaction, pExtendedParemeter)

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

出力引数:

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