ホーム › Storage.FileSystem › CreateTransactionManager

CreateTransactionManager

関数

KTMトランザクションマネージャーを新規作成する。

DLLktmw32.dll呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

// ktmw32.dll
#include <windows.h>

HANDLE CreateTransactionManager(
    SECURITY_ATTRIBUTES* lpTransactionAttributes,
    LPWSTR LogFileName,
    DWORD CreateOptions,
    DWORD CommitStrength
);

パラメーター

名前

型

方向

説明

lpTransactionAttributes

SECURITY_ATTRIBUTES*

inout

TM オブジェクトに対するトランザクションの SECURITY_ATTRIBUTES (ACL) です。

LogFileName

LPWSTR

ログファイルのストリーム名です。ストリームがログ内に存在しない場合は作成されます。揮発性 TM を作成するには、このパラメーターを NULL にし、CreateOptions で TRANSACTION_MANAGER_VOLATILE を指定する必要があります。この場合、トランザクションマネージャーは揮発性とみなされます。

CreateOptions

DWORD

新しい TM の任意の属性です。

値	意味
TRANSACTION_MANAGER_VOLATILE	TM が揮発性であり、回復を実行しないことを示します。

CommitStrength

DWORD

予約済みです。ゼロを指定してください。

戻り値の型: HANDLE

公式ドキュメント

新しいトランザクションマネージャー (TM) オブジェクトを作成し、指定されたアクセス権を持つハンドルを返します。

戻り値

関数が成功した場合、戻り値はトランザクションマネージャーへのハンドルです。

関数が失敗した場合、戻り値は INVALID_HANDLE_VALUE です。拡張エラー情報を取得するには、GetLastError 関数を呼び出します。

次の一覧は、発生し得るエラーコードを示しています。

解説(Remarks)

この関数を呼び出した直後に、RecoverTransactionManager を呼び出す必要があります。

トランザクションマネージャーが揮発性の場合、すべてのリソースマネージャーも揮発性でなければなりません。

TM が正しく機能するためには、TM の作成後に RecoverTransactionManager を呼び出す必要があります。

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

各言語での呼び出し定義

// ktmw32.dll
#include <windows.h>

HANDLE CreateTransactionManager(
    SECURITY_ATTRIBUTES* lpTransactionAttributes,
    LPWSTR LogFileName,
    DWORD CreateOptions,
    DWORD CommitStrength
);

[DllImport("ktmw32.dll", SetLastError = true, ExactSpelling = true)]
static extern IntPtr CreateTransactionManager(
    IntPtr lpTransactionAttributes,   // SECURITY_ATTRIBUTES* in/out
    [MarshalAs(UnmanagedType.LPWStr)] string LogFileName,   // LPWSTR
    uint CreateOptions,   // DWORD
    uint CommitStrength   // DWORD
);

<DllImport("ktmw32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CreateTransactionManager(
    lpTransactionAttributes As IntPtr,   ' SECURITY_ATTRIBUTES* in/out
    <MarshalAs(UnmanagedType.LPWStr)> LogFileName As String,   ' LPWSTR
    CreateOptions As UInteger,   ' DWORD
    CommitStrength As UInteger   ' DWORD
) As IntPtr
End Function

' lpTransactionAttributes : SECURITY_ATTRIBUTES* in/out
' LogFileName : LPWSTR
' CreateOptions : DWORD
' CommitStrength : DWORD
Declare PtrSafe Function CreateTransactionManager Lib "ktmw32" ( _
    ByVal lpTransactionAttributes As LongPtr, _
    ByVal LogFileName As LongPtr, _
    ByVal CreateOptions As Long, _
    ByVal CommitStrength As Long) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

CreateTransactionManager = ctypes.windll.ktmw32.CreateTransactionManager
CreateTransactionManager.restype = ctypes.c_void_p
CreateTransactionManager.argtypes = [
    ctypes.c_void_p,  # lpTransactionAttributes : SECURITY_ATTRIBUTES* in/out
    wintypes.LPCWSTR,  # LogFileName : LPWSTR
    wintypes.DWORD,  # CreateOptions : DWORD
    wintypes.DWORD,  # CommitStrength : DWORD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ktmw32.dll')
CreateTransactionManager = Fiddle::Function.new(
  lib['CreateTransactionManager'],
  [
    Fiddle::TYPE_VOIDP,  # lpTransactionAttributes : SECURITY_ATTRIBUTES* in/out
    Fiddle::TYPE_VOIDP,  # LogFileName : LPWSTR
    -Fiddle::TYPE_INT,  # CreateOptions : DWORD
    -Fiddle::TYPE_INT,  # CommitStrength : DWORD
  ],
  Fiddle::TYPE_VOIDP)

#[link(name = "ktmw32")]
extern "system" {
    fn CreateTransactionManager(
        lpTransactionAttributes: *mut SECURITY_ATTRIBUTES,  // SECURITY_ATTRIBUTES* in/out
        LogFileName: *mut u16,  // LPWSTR
        CreateOptions: u32,  // DWORD
        CommitStrength: u32  // DWORD
    ) -> *mut core::ffi::c_void;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("ktmw32.dll", SetLastError = true)]
public static extern IntPtr CreateTransactionManager(IntPtr lpTransactionAttributes, [MarshalAs(UnmanagedType.LPWStr)] string LogFileName, uint CreateOptions, uint CommitStrength);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ktmw32_CreateTransactionManager' -Namespace Win32 -PassThru
# $api::CreateTransactionManager(lpTransactionAttributes, LogFileName, CreateOptions, CommitStrength)

#uselib "ktmw32.dll"
#func global CreateTransactionManager "CreateTransactionManager" sptr, sptr, sptr, sptr
; CreateTransactionManager varptr(lpTransactionAttributes), LogFileName, CreateOptions, CommitStrength   ; 戻り値は stat
; lpTransactionAttributes : SECURITY_ATTRIBUTES* in/out -> "sptr"
; LogFileName : LPWSTR -> "sptr"
; CreateOptions : DWORD -> "sptr"
; CommitStrength : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "ktmw32.dll"
#cfunc global CreateTransactionManager "CreateTransactionManager" var, wstr, int, int
; res = CreateTransactionManager(lpTransactionAttributes, LogFileName, CreateOptions, CommitStrength)
; lpTransactionAttributes : SECURITY_ATTRIBUTES* in/out -> "var"
; LogFileName : LPWSTR -> "wstr"
; CreateOptions : DWORD -> "int"
; CommitStrength : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "ktmw32.dll"
#cfunc global CreateTransactionManager "CreateTransactionManager" sptr, wstr, int, int
; res = CreateTransactionManager(varptr(lpTransactionAttributes), LogFileName, CreateOptions, CommitStrength)
; lpTransactionAttributes : SECURITY_ATTRIBUTES* in/out -> "sptr"
; LogFileName : LPWSTR -> "wstr"
; CreateOptions : DWORD -> "int"
; CommitStrength : DWORD -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。