ホーム › Storage.FileSystem › PrepareEnlistment

PrepareEnlistment

関数

KTMエンリストメントのプリペアフェーズを応答する。

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

シグネチャ

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

BOOL PrepareEnlistment(
    HANDLE EnlistmentHandle,
    LONGLONG* TmVirtualClock
);

パラメーター

名前	型	方向	説明
EnlistmentHandle	HANDLE	in	準備操作が完了したエンリストメントへのハンドル。
TmVirtualClock	LONGLONG*	inout	このトランザクションについて受信した最新の仮想クロック値へのポインター。

戻り値の型: BOOL

公式ドキュメント

このエンリストメントハンドルに関連付けられたトランザクションを準備します。この関数は、通信リソースマネージャー(上位トランザクションマネージャーと呼ばれることもあります)によって使用されます。

戻り値

関数が成功した場合、戻り値は 0 以外になります。

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

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

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

各言語での呼び出し定義

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

BOOL PrepareEnlistment(
    HANDLE EnlistmentHandle,
    LONGLONG* TmVirtualClock
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ktmw32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool PrepareEnlistment(
    IntPtr EnlistmentHandle,   // HANDLE
    ref long TmVirtualClock   // LONGLONG* in/out
);

<DllImport("ktmw32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function PrepareEnlistment(
    EnlistmentHandle As IntPtr,   ' HANDLE
    ByRef TmVirtualClock As Long   ' LONGLONG* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' EnlistmentHandle : HANDLE
' TmVirtualClock : LONGLONG* in/out
Declare PtrSafe Function PrepareEnlistment Lib "ktmw32" ( _
    ByVal EnlistmentHandle As LongPtr, _
    ByRef TmVirtualClock As LongLong) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

PrepareEnlistment = ctypes.windll.ktmw32.PrepareEnlistment
PrepareEnlistment.restype = wintypes.BOOL
PrepareEnlistment.argtypes = [
    wintypes.HANDLE,  # EnlistmentHandle : HANDLE
    ctypes.POINTER(ctypes.c_longlong),  # TmVirtualClock : LONGLONG* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ktmw32.dll')
PrepareEnlistment = Fiddle::Function.new(
  lib['PrepareEnlistment'],
  [
    Fiddle::TYPE_VOIDP,  # EnlistmentHandle : HANDLE
    Fiddle::TYPE_VOIDP,  # TmVirtualClock : LONGLONG* in/out
  ],
  Fiddle::TYPE_INT)

#[link(name = "ktmw32")]
extern "system" {
    fn PrepareEnlistment(
        EnlistmentHandle: *mut core::ffi::c_void,  // HANDLE
        TmVirtualClock: *mut i64  // LONGLONG* in/out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ktmw32.dll", SetLastError = true)]
public static extern bool PrepareEnlistment(IntPtr EnlistmentHandle, ref long TmVirtualClock);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ktmw32_PrepareEnlistment' -Namespace Win32 -PassThru
# $api::PrepareEnlistment(EnlistmentHandle, TmVirtualClock)

#uselib "ktmw32.dll"
#func global PrepareEnlistment "PrepareEnlistment" sptr, sptr
; PrepareEnlistment EnlistmentHandle, varptr(TmVirtualClock)   ; 戻り値は stat
; EnlistmentHandle : HANDLE -> "sptr"
; TmVirtualClock : LONGLONG* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "ktmw32.dll"
#cfunc global PrepareEnlistment "PrepareEnlistment" sptr, var
; res = PrepareEnlistment(EnlistmentHandle, TmVirtualClock)
; EnlistmentHandle : HANDLE -> "sptr"
; TmVirtualClock : LONGLONG* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "ktmw32.dll"
#cfunc global PrepareEnlistment "PrepareEnlistment" sptr, sptr
; res = PrepareEnlistment(EnlistmentHandle, varptr(TmVirtualClock))
; EnlistmentHandle : HANDLE -> "sptr"
; TmVirtualClock : LONGLONG* in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。