Win32 API 日本語リファレンス
ホーム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
);

パラメーター

名前方向
lpEnlistmentAttributesSECURITY_ATTRIBUTES*inout
ResourceManagerHandleHANDLEin
TransactionHandleHANDLEin
NotificationMaskDWORDin
CreateOptionsDWORDin
EnlistmentKeyvoid*inout

戻り値の型: HANDLE

各言語での呼び出し定義

// 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 方式にも切替可。
出力引数:
; HANDLE CreateEnlistment(SECURITY_ATTRIBUTES* lpEnlistmentAttributes, HANDLE ResourceManagerHandle, HANDLE TransactionHandle, DWORD NotificationMask, DWORD CreateOptions, void* EnlistmentKey)
#uselib "ktmw32.dll"
#cfunc global CreateEnlistment "CreateEnlistment" var, intptr, intptr, int, int, intptr
; res = CreateEnlistment(lpEnlistmentAttributes, ResourceManagerHandle, TransactionHandle, NotificationMask, CreateOptions, EnlistmentKey)
; lpEnlistmentAttributes : SECURITY_ATTRIBUTES* in/out -> "var"
; ResourceManagerHandle : HANDLE -> "intptr"
; TransactionHandle : HANDLE -> "intptr"
; NotificationMask : DWORD -> "int"
; CreateOptions : DWORD -> "int"
; EnlistmentKey : void* in/out -> "intptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	ktmw32 = windows.NewLazySystemDLL("ktmw32.dll")
	procCreateEnlistment = ktmw32.NewProc("CreateEnlistment")
)

// lpEnlistmentAttributes (SECURITY_ATTRIBUTES* in/out), ResourceManagerHandle (HANDLE), TransactionHandle (HANDLE), NotificationMask (DWORD), CreateOptions (DWORD), EnlistmentKey (void* in/out)
r1, _, err := procCreateEnlistment.Call(
	uintptr(lpEnlistmentAttributes),
	uintptr(ResourceManagerHandle),
	uintptr(TransactionHandle),
	uintptr(NotificationMask),
	uintptr(CreateOptions),
	uintptr(EnlistmentKey),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HANDLE
function CreateEnlistment(
  lpEnlistmentAttributes: Pointer;   // SECURITY_ATTRIBUTES* in/out
  ResourceManagerHandle: THandle;   // HANDLE
  TransactionHandle: THandle;   // HANDLE
  NotificationMask: DWORD;   // DWORD
  CreateOptions: DWORD;   // DWORD
  EnlistmentKey: Pointer   // void* in/out
): THandle; stdcall;
  external 'ktmw32.dll' name 'CreateEnlistment';
result := DllCall("ktmw32\CreateEnlistment"
    , "Ptr", lpEnlistmentAttributes   ; SECURITY_ATTRIBUTES* in/out
    , "Ptr", ResourceManagerHandle   ; HANDLE
    , "Ptr", TransactionHandle   ; HANDLE
    , "UInt", NotificationMask   ; DWORD
    , "UInt", CreateOptions   ; DWORD
    , "Ptr", EnlistmentKey   ; void* in/out
    , "Ptr")   ; return: HANDLE
●CreateEnlistment(lpEnlistmentAttributes, ResourceManagerHandle, TransactionHandle, NotificationMask, CreateOptions, EnlistmentKey) = DLL("ktmw32.dll", "void* CreateEnlistment(void*, void*, void*, dword, dword, void*)")
# 呼び出し: CreateEnlistment(lpEnlistmentAttributes, ResourceManagerHandle, TransactionHandle, NotificationMask, CreateOptions, EnlistmentKey)
# lpEnlistmentAttributes : SECURITY_ATTRIBUTES* in/out -> "void*"
# ResourceManagerHandle : HANDLE -> "void*"
# TransactionHandle : HANDLE -> "void*"
# NotificationMask : DWORD -> "dword"
# CreateOptions : DWORD -> "dword"
# EnlistmentKey : void* in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。