ホーム › Storage.FileSystem › CreateEnlistment

CreateEnlistment

関数

リソースマネージャーをトランザクションに加入させエンリストメントを作成する。

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

シグネチャ

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

HANDLE CreateEnlistment(
    SECURITY_ATTRIBUTES* lpEnlistmentAttributes,
    HANDLE ResourceManagerHandle,
    HANDLE TransactionHandle,
    DWORD NotificationMask,
    DWORD CreateOptions,
    void* EnlistmentKey
);

パラメーター

名前

型

方向

説明

lpEnlistmentAttributes

SECURITY_ATTRIBUTES*

inout

エンリストメントマネージャーのセキュリティ属性を含む SECURITY_ATTRIBUTES 構造体へのポインターです。既定の属性を取得するには NULL を指定します。

ResourceManagerHandle

HANDLE

エンリストする対象のリソースマネージャー (RM) へのハンドルです。

TransactionHandle

HANDLE

RM がエンリストするトランザクションへのハンドルです。

NotificationMask

DWORD

この RM が TransactionHandle パラメーターに対して要求する通知です。有効な値の一覧については、NOTIFICATION_MASK を参照してください。

CreateOptions

DWORD

任意のエンリストメント指示です。

値	意味
ENLISTMENT_SUPERIOR 1	上位トランザクションマネージャーとしてエンリストします。

EnlistmentKey

void*

inout

RM が使用するユーザー定義構造体へのポインターで、TRANSACTION_NOTIFICATION 構造体で通知が送信されるときに返されます。これは通常、この特定のトランザクションにプライベートな構造体を関連付けるために使用されます。

戻り値の型: HANDLE

公式ドキュメント

エンリストメントを作成し、その初期状態を設定して、指定されたアクセス権でエンリストメントへのハンドルを開きます。

戻り値

関数が成功した場合、戻り値はエンリストメントへのハンドルです。

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

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

解説(Remarks)

Windows Vista: 準備前 (pre-prepare) フェーズ以降にエンリストしようとすると、必ず失敗します。

通知マスクで単一フェーズコミット要求を受け入れることを指定しない場合、KTM は常に二フェーズコミット操作を実行します。

トランザクションにエンリストする際は、次の通知ルールに留意してください。

RM は常にロールバック通知を要求する必要があります。
RM が準備 (prepare) 通知を要求する場合は、コミット通知も要求する必要があります。
RM が単一フェーズコミット操作を要求する場合は、準備通知とコミット通知も指定する必要があります。
RM がコミット通知を要求する必要がないのは、少なくとも準備通知とロールバック通知の組を要求している場合のみです。

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

各言語での呼び出し定義

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

HANDLE CreateEnlistment(
    SECURITY_ATTRIBUTES* lpEnlistmentAttributes,
    HANDLE ResourceManagerHandle,
    HANDLE TransactionHandle,
    DWORD NotificationMask,
    DWORD CreateOptions,
    void* EnlistmentKey
);

[DllImport("ktmw32.dll", SetLastError = true, ExactSpelling = true)]
static extern IntPtr CreateEnlistment(
    IntPtr lpEnlistmentAttributes,   // SECURITY_ATTRIBUTES* in/out
    IntPtr ResourceManagerHandle,   // HANDLE
    IntPtr TransactionHandle,   // HANDLE
    uint NotificationMask,   // DWORD
    uint CreateOptions,   // DWORD
    IntPtr EnlistmentKey   // void* in/out
);

<DllImport("ktmw32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CreateEnlistment(
    lpEnlistmentAttributes As IntPtr,   ' SECURITY_ATTRIBUTES* in/out
    ResourceManagerHandle As IntPtr,   ' HANDLE
    TransactionHandle As IntPtr,   ' HANDLE
    NotificationMask As UInteger,   ' DWORD
    CreateOptions As UInteger,   ' DWORD
    EnlistmentKey As IntPtr   ' void* in/out
) As IntPtr
End Function

' lpEnlistmentAttributes : SECURITY_ATTRIBUTES* in/out
' ResourceManagerHandle : HANDLE
' TransactionHandle : HANDLE
' NotificationMask : DWORD
' CreateOptions : DWORD
' EnlistmentKey : void* in/out
Declare PtrSafe Function CreateEnlistment Lib "ktmw32" ( _
    ByVal lpEnlistmentAttributes As LongPtr, _
    ByVal ResourceManagerHandle As LongPtr, _
    ByVal TransactionHandle As LongPtr, _
    ByVal NotificationMask As Long, _
    ByVal CreateOptions As Long, _
    ByVal EnlistmentKey As LongPtr) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

CreateEnlistment = ctypes.windll.ktmw32.CreateEnlistment
CreateEnlistment.restype = ctypes.c_void_p
CreateEnlistment.argtypes = [
    ctypes.c_void_p,  # lpEnlistmentAttributes : SECURITY_ATTRIBUTES* in/out
    wintypes.HANDLE,  # ResourceManagerHandle : HANDLE
    wintypes.HANDLE,  # TransactionHandle : HANDLE
    wintypes.DWORD,  # NotificationMask : DWORD
    wintypes.DWORD,  # CreateOptions : DWORD
    ctypes.POINTER(None),  # EnlistmentKey : void* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ktmw32.dll')
CreateEnlistment = Fiddle::Function.new(
  lib['CreateEnlistment'],
  [
    Fiddle::TYPE_VOIDP,  # lpEnlistmentAttributes : SECURITY_ATTRIBUTES* in/out
    Fiddle::TYPE_VOIDP,  # ResourceManagerHandle : HANDLE
    Fiddle::TYPE_VOIDP,  # TransactionHandle : HANDLE
    -Fiddle::TYPE_INT,  # NotificationMask : DWORD
    -Fiddle::TYPE_INT,  # CreateOptions : DWORD
    Fiddle::TYPE_VOIDP,  # EnlistmentKey : void* in/out
  ],
  Fiddle::TYPE_VOIDP)

#[link(name = "ktmw32")]
extern "system" {
    fn CreateEnlistment(
        lpEnlistmentAttributes: *mut SECURITY_ATTRIBUTES,  // SECURITY_ATTRIBUTES* in/out
        ResourceManagerHandle: *mut core::ffi::c_void,  // HANDLE
        TransactionHandle: *mut core::ffi::c_void,  // HANDLE
        NotificationMask: u32,  // DWORD
        CreateOptions: u32,  // DWORD
        EnlistmentKey: *mut ()  // void* in/out
    ) -> *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 CreateEnlistment(IntPtr lpEnlistmentAttributes, IntPtr ResourceManagerHandle, IntPtr TransactionHandle, uint NotificationMask, uint CreateOptions, IntPtr EnlistmentKey);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ktmw32_CreateEnlistment' -Namespace Win32 -PassThru
# $api::CreateEnlistment(lpEnlistmentAttributes, ResourceManagerHandle, TransactionHandle, NotificationMask, CreateOptions, EnlistmentKey)

#uselib "ktmw32.dll"
#func global CreateEnlistment "CreateEnlistment" sptr, sptr, sptr, sptr, sptr, sptr
; CreateEnlistment varptr(lpEnlistmentAttributes), ResourceManagerHandle, TransactionHandle, NotificationMask, CreateOptions, EnlistmentKey   ; 戻り値は stat
; lpEnlistmentAttributes : SECURITY_ATTRIBUTES* in/out -> "sptr"
; ResourceManagerHandle : HANDLE -> "sptr"
; TransactionHandle : HANDLE -> "sptr"
; NotificationMask : DWORD -> "sptr"
; CreateOptions : DWORD -> "sptr"
; EnlistmentKey : void* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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