ホーム › Storage.FileSystem › GetTransactionInformation

GetTransactionInformation

関数

KTMトランザクションの結果や分離レベル等の情報を取得する。

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

シグネチャ

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

BOOL GetTransactionInformation(
    HANDLE TransactionHandle,
    DWORD* Outcome,
    DWORD* IsolationLevel,
    DWORD* IsolationFlags,
    DWORD* Timeout,
    DWORD BufferLength,
    LPWSTR Description   // optional
);

パラメーター

名前	型	方向	説明
TransactionHandle	HANDLE	in	トランザクションへのハンドル。情報を取得するには、このハンドルに TRANSACTION_QUERY_INFORMATION 権限が必要です。
Outcome	DWORD*	inout	トランザクションの現在の結果を受け取るバッファーへのポインター。GetTransactionInformation 関数の呼び出しが成功した場合、この値は TRANSACTION_OUTCOME 列挙体の値のいずれかになります。
IsolationLevel	DWORD*	inout	予約されています。
IsolationFlags	DWORD*	inout	予約されています。
Timeout	DWORD*	inout	このトランザクションのタイムアウト値(ミリ秒単位)を受け取る変数へのポインター。
BufferLength	DWORD	in	Description パラメーターのサイズ(バイト単位)。バッファー長の値は MAX_TRANSACTION_DESCRIPTION_LENGTH の値を超えることはできません。
Description	LPWSTR	outoptional	トランザクションのユーザー定義の説明を受け取るバッファーへのポインター。

戻り値の型: 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 GetTransactionInformation(
    HANDLE TransactionHandle,
    DWORD* Outcome,
    DWORD* IsolationLevel,
    DWORD* IsolationFlags,
    DWORD* Timeout,
    DWORD BufferLength,
    LPWSTR Description   // optional
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ktmw32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool GetTransactionInformation(
    IntPtr TransactionHandle,   // HANDLE
    ref uint Outcome,   // DWORD* in/out
    ref uint IsolationLevel,   // DWORD* in/out
    ref uint IsolationFlags,   // DWORD* in/out
    ref uint Timeout,   // DWORD* in/out
    uint BufferLength,   // DWORD
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder Description   // LPWSTR optional, out
);

<DllImport("ktmw32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetTransactionInformation(
    TransactionHandle As IntPtr,   ' HANDLE
    ByRef Outcome As UInteger,   ' DWORD* in/out
    ByRef IsolationLevel As UInteger,   ' DWORD* in/out
    ByRef IsolationFlags As UInteger,   ' DWORD* in/out
    ByRef Timeout As UInteger,   ' DWORD* in/out
    BufferLength As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPWStr)> Description As System.Text.StringBuilder   ' LPWSTR optional, out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' TransactionHandle : HANDLE
' Outcome : DWORD* in/out
' IsolationLevel : DWORD* in/out
' IsolationFlags : DWORD* in/out
' Timeout : DWORD* in/out
' BufferLength : DWORD
' Description : LPWSTR optional, out
Declare PtrSafe Function GetTransactionInformation Lib "ktmw32" ( _
    ByVal TransactionHandle As LongPtr, _
    ByRef Outcome As Long, _
    ByRef IsolationLevel As Long, _
    ByRef IsolationFlags As Long, _
    ByRef Timeout As Long, _
    ByVal BufferLength As Long, _
    ByVal Description As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetTransactionInformation = ctypes.windll.ktmw32.GetTransactionInformation
GetTransactionInformation.restype = wintypes.BOOL
GetTransactionInformation.argtypes = [
    wintypes.HANDLE,  # TransactionHandle : HANDLE
    ctypes.POINTER(wintypes.DWORD),  # Outcome : DWORD* in/out
    ctypes.POINTER(wintypes.DWORD),  # IsolationLevel : DWORD* in/out
    ctypes.POINTER(wintypes.DWORD),  # IsolationFlags : DWORD* in/out
    ctypes.POINTER(wintypes.DWORD),  # Timeout : DWORD* in/out
    wintypes.DWORD,  # BufferLength : DWORD
    wintypes.LPWSTR,  # Description : LPWSTR optional, out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ktmw32.dll')
GetTransactionInformation = Fiddle::Function.new(
  lib['GetTransactionInformation'],
  [
    Fiddle::TYPE_VOIDP,  # TransactionHandle : HANDLE
    Fiddle::TYPE_VOIDP,  # Outcome : DWORD* in/out
    Fiddle::TYPE_VOIDP,  # IsolationLevel : DWORD* in/out
    Fiddle::TYPE_VOIDP,  # IsolationFlags : DWORD* in/out
    Fiddle::TYPE_VOIDP,  # Timeout : DWORD* in/out
    -Fiddle::TYPE_INT,  # BufferLength : DWORD
    Fiddle::TYPE_VOIDP,  # Description : LPWSTR optional, out
  ],
  Fiddle::TYPE_INT)

#[link(name = "ktmw32")]
extern "system" {
    fn GetTransactionInformation(
        TransactionHandle: *mut core::ffi::c_void,  // HANDLE
        Outcome: *mut u32,  // DWORD* in/out
        IsolationLevel: *mut u32,  // DWORD* in/out
        IsolationFlags: *mut u32,  // DWORD* in/out
        Timeout: *mut u32,  // DWORD* in/out
        BufferLength: u32,  // DWORD
        Description: *mut u16  // LPWSTR optional, 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 GetTransactionInformation(IntPtr TransactionHandle, ref uint Outcome, ref uint IsolationLevel, ref uint IsolationFlags, ref uint Timeout, uint BufferLength, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder Description);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ktmw32_GetTransactionInformation' -Namespace Win32 -PassThru
# $api::GetTransactionInformation(TransactionHandle, Outcome, IsolationLevel, IsolationFlags, Timeout, BufferLength, Description)

#uselib "ktmw32.dll"
#func global GetTransactionInformation "GetTransactionInformation" sptr, sptr, sptr, sptr, sptr, sptr, sptr
; GetTransactionInformation TransactionHandle, varptr(Outcome), varptr(IsolationLevel), varptr(IsolationFlags), varptr(Timeout), BufferLength, varptr(Description)   ; 戻り値は stat
; TransactionHandle : HANDLE -> "sptr"
; Outcome : DWORD* in/out -> "sptr"
; IsolationLevel : DWORD* in/out -> "sptr"
; IsolationFlags : DWORD* in/out -> "sptr"
; Timeout : DWORD* in/out -> "sptr"
; BufferLength : DWORD -> "sptr"
; Description : LPWSTR optional, out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "ktmw32.dll"
#cfunc global GetTransactionInformation "GetTransactionInformation" sptr, var, var, var, var, int, var
; res = GetTransactionInformation(TransactionHandle, Outcome, IsolationLevel, IsolationFlags, Timeout, BufferLength, Description)
; TransactionHandle : HANDLE -> "sptr"
; Outcome : DWORD* in/out -> "var"
; IsolationLevel : DWORD* in/out -> "var"
; IsolationFlags : DWORD* in/out -> "var"
; Timeout : DWORD* in/out -> "var"
; BufferLength : DWORD -> "int"
; Description : LPWSTR optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "ktmw32.dll"
#cfunc global GetTransactionInformation "GetTransactionInformation" sptr, sptr, sptr, sptr, sptr, int, sptr
; res = GetTransactionInformation(TransactionHandle, varptr(Outcome), varptr(IsolationLevel), varptr(IsolationFlags), varptr(Timeout), BufferLength, varptr(Description))
; TransactionHandle : HANDLE -> "sptr"
; Outcome : DWORD* in/out -> "sptr"
; IsolationLevel : DWORD* in/out -> "sptr"
; IsolationFlags : DWORD* in/out -> "sptr"
; Timeout : DWORD* in/out -> "sptr"
; BufferLength : DWORD -> "int"
; Description : LPWSTR optional, out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。