Win32 API 日本語リファレンス
ホームStorage.FileSystem › RollbackEnlistment

RollbackEnlistment

関数
KTMエンリストメントのロールバックを応答する。
DLLktmw32.dll呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

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

BOOL RollbackEnlistment(
    HANDLE EnlistmentHandle,
    LONGLONG* TmVirtualClock
);

パラメーター

名前方向説明
EnlistmentHandleHANDLEinエンリストメントへのハンドル。
TmVirtualClockLONGLONG*inoutこのエンリストメントに対して受信した最新の仮想クロック値。LARGE_INTEGER を参照してください。

戻り値の型: BOOL

公式ドキュメント

エンリストメントに関連付けられた指定のトランザクションをロールバックします。この関数は読み取り専用のエンリストメントに対しては呼び出せません。

戻り値

関数が成功した場合、戻り値は 0 以外の値です。

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

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

解説(Remarks)

この関数は、RM が自身のエンリストされたトランザクションをロールバックするために使用します。トランザクションに関連付けられたすべての処理がロールバックされます。

ロールバックは、エンリストメントが準備完了通知を発行する前であればいつでも実行できます。

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

各言語での呼び出し定義

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

BOOL RollbackEnlistment(
    HANDLE EnlistmentHandle,
    LONGLONG* TmVirtualClock
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ktmw32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool RollbackEnlistment(
    IntPtr EnlistmentHandle,   // HANDLE
    ref long TmVirtualClock   // LONGLONG* in/out
);
<DllImport("ktmw32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function RollbackEnlistment(
    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 RollbackEnlistment 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

RollbackEnlistment = ctypes.windll.ktmw32.RollbackEnlistment
RollbackEnlistment.restype = wintypes.BOOL
RollbackEnlistment.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')
RollbackEnlistment = Fiddle::Function.new(
  lib['RollbackEnlistment'],
  [
    Fiddle::TYPE_VOIDP,  # EnlistmentHandle : HANDLE
    Fiddle::TYPE_VOIDP,  # TmVirtualClock : LONGLONG* in/out
  ],
  Fiddle::TYPE_INT)
#[link(name = "ktmw32")]
extern "system" {
    fn RollbackEnlistment(
        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 RollbackEnlistment(IntPtr EnlistmentHandle, ref long TmVirtualClock);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ktmw32_RollbackEnlistment' -Namespace Win32 -PassThru
# $api::RollbackEnlistment(EnlistmentHandle, TmVirtualClock)
#uselib "ktmw32.dll"
#func global RollbackEnlistment "RollbackEnlistment" sptr, sptr
; RollbackEnlistment EnlistmentHandle, varptr(TmVirtualClock)   ; 戻り値は stat
; EnlistmentHandle : HANDLE -> "sptr"
; TmVirtualClock : LONGLONG* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "ktmw32.dll"
#cfunc global RollbackEnlistment "RollbackEnlistment" sptr, var
; res = RollbackEnlistment(EnlistmentHandle, TmVirtualClock)
; EnlistmentHandle : HANDLE -> "sptr"
; TmVirtualClock : LONGLONG* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL RollbackEnlistment(HANDLE EnlistmentHandle, LONGLONG* TmVirtualClock)
#uselib "ktmw32.dll"
#cfunc global RollbackEnlistment "RollbackEnlistment" intptr, var
; res = RollbackEnlistment(EnlistmentHandle, TmVirtualClock)
; EnlistmentHandle : HANDLE -> "intptr"
; TmVirtualClock : LONGLONG* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	ktmw32 = windows.NewLazySystemDLL("ktmw32.dll")
	procRollbackEnlistment = ktmw32.NewProc("RollbackEnlistment")
)

// EnlistmentHandle (HANDLE), TmVirtualClock (LONGLONG* in/out)
r1, _, err := procRollbackEnlistment.Call(
	uintptr(EnlistmentHandle),
	uintptr(TmVirtualClock),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function RollbackEnlistment(
  EnlistmentHandle: THandle;   // HANDLE
  TmVirtualClock: Pointer   // LONGLONG* in/out
): BOOL; stdcall;
  external 'ktmw32.dll' name 'RollbackEnlistment';
result := DllCall("ktmw32\RollbackEnlistment"
    , "Ptr", EnlistmentHandle   ; HANDLE
    , "Ptr", TmVirtualClock   ; LONGLONG* in/out
    , "Int")   ; return: BOOL
●RollbackEnlistment(EnlistmentHandle, TmVirtualClock) = DLL("ktmw32.dll", "bool RollbackEnlistment(void*, void*)")
# 呼び出し: RollbackEnlistment(EnlistmentHandle, TmVirtualClock)
# EnlistmentHandle : HANDLE -> "void*"
# TmVirtualClock : LONGLONG* in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "ktmw32" fn RollbackEnlistment(
    EnlistmentHandle: ?*anyopaque, // HANDLE
    TmVirtualClock: [*c]i64 // LONGLONG* in/out
) callconv(std.os.windows.WINAPI) i32;
proc RollbackEnlistment(
    EnlistmentHandle: pointer,  # HANDLE
    TmVirtualClock: ptr int64  # LONGLONG* in/out
): int32 {.importc: "RollbackEnlistment", stdcall, dynlib: "ktmw32.dll".}
pragma(lib, "ktmw32");
extern(Windows)
int RollbackEnlistment(
    void* EnlistmentHandle,   // HANDLE
    long* TmVirtualClock   // LONGLONG* in/out
);
ccall((:RollbackEnlistment, "ktmw32.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Ptr{Int64}),
      EnlistmentHandle, TmVirtualClock)
# EnlistmentHandle : HANDLE -> Ptr{Cvoid}
# TmVirtualClock : LONGLONG* in/out -> Ptr{Int64}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t RollbackEnlistment(
    void* EnlistmentHandle,
    int64_t* TmVirtualClock);
]]
local ktmw32 = ffi.load("ktmw32")
-- ktmw32.RollbackEnlistment(EnlistmentHandle, TmVirtualClock)
-- EnlistmentHandle : HANDLE
-- TmVirtualClock : LONGLONG* in/out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('ktmw32.dll');
const RollbackEnlistment = lib.func('__stdcall', 'RollbackEnlistment', 'int32_t', ['void *', 'int64_t *']);
// RollbackEnlistment(EnlistmentHandle, TmVirtualClock)
// EnlistmentHandle : HANDLE -> 'void *'
// TmVirtualClock : LONGLONG* in/out -> 'int64_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("ktmw32.dll", {
  RollbackEnlistment: { parameters: ["pointer", "pointer"], result: "i32" },
});
// lib.symbols.RollbackEnlistment(EnlistmentHandle, TmVirtualClock)
// EnlistmentHandle : HANDLE -> "pointer"
// TmVirtualClock : LONGLONG* in/out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t RollbackEnlistment(
    void* EnlistmentHandle,
    int64_t* TmVirtualClock);
C, "ktmw32.dll");
// $ffi->RollbackEnlistment(EnlistmentHandle, TmVirtualClock);
// EnlistmentHandle : HANDLE
// TmVirtualClock : LONGLONG* in/out
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Ktmw32 extends StdCallLibrary {
    Ktmw32 INSTANCE = Native.load("ktmw32", Ktmw32.class);
    boolean RollbackEnlistment(
        Pointer EnlistmentHandle,   // HANDLE
        LongByReference TmVirtualClock   // LONGLONG* in/out
    );
}
@[Link("ktmw32")]
lib Libktmw32
  fun RollbackEnlistment = RollbackEnlistment(
    EnlistmentHandle : Void*,   # HANDLE
    TmVirtualClock : Int64*   # LONGLONG* in/out
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef RollbackEnlistmentNative = Int32 Function(Pointer<Void>, Pointer<Int64>);
typedef RollbackEnlistmentDart = int Function(Pointer<Void>, Pointer<Int64>);
final RollbackEnlistment = DynamicLibrary.open('ktmw32.dll')
    .lookupFunction<RollbackEnlistmentNative, RollbackEnlistmentDart>('RollbackEnlistment');
// EnlistmentHandle : HANDLE -> Pointer<Void>
// TmVirtualClock : LONGLONG* in/out -> Pointer<Int64>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function RollbackEnlistment(
  EnlistmentHandle: THandle;   // HANDLE
  TmVirtualClock: Pointer   // LONGLONG* in/out
): BOOL; stdcall;
  external 'ktmw32.dll' name 'RollbackEnlistment';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "RollbackEnlistment"
  c_RollbackEnlistment :: Ptr () -> Ptr Int64 -> IO CInt
-- EnlistmentHandle : HANDLE -> Ptr ()
-- TmVirtualClock : LONGLONG* in/out -> Ptr Int64
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let rollbackenlistment =
  foreign "RollbackEnlistment"
    ((ptr void) @-> (ptr int64_t) @-> returning int32_t)
(* EnlistmentHandle : HANDLE -> (ptr void) *)
(* TmVirtualClock : LONGLONG* in/out -> (ptr int64_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library ktmw32 (t "ktmw32.dll"))
(cffi:use-foreign-library ktmw32)

(cffi:defcfun ("RollbackEnlistment" rollback-enlistment :convention :stdcall) :int32
  (enlistment-handle :pointer)   ; HANDLE
  (tm-virtual-clock :pointer))   ; LONGLONG* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $RollbackEnlistment = Win32::API::More->new('ktmw32',
    'BOOL RollbackEnlistment(HANDLE EnlistmentHandle, LPVOID TmVirtualClock)');
# my $ret = $RollbackEnlistment->Call($EnlistmentHandle, $TmVirtualClock);
# EnlistmentHandle : HANDLE -> HANDLE
# TmVirtualClock : LONGLONG* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目