ホーム › Storage.FileSystem › GetEnlistmentRecoveryInformation

GetEnlistmentRecoveryInformation

関数

KTMエンリストメントの回復情報を取得する。

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

シグネチャ

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

BOOL GetEnlistmentRecoveryInformation(
    HANDLE EnlistmentHandle,
    DWORD BufferSize,
    void* Buffer,
    DWORD* BufferUsed
);

パラメーター

名前	型	方向	説明
EnlistmentHandle	HANDLE	in	エンリストメントへのハンドル。
BufferSize	DWORD	in	Buffer パラメーターのサイズ(バイト単位)。
Buffer	void*	inout	エンリストメントの回復情報を受け取るバッファーへのポインター。
BufferUsed	DWORD*	inout	Buffer パラメーターに返された実際のバイト数を受け取る変数へのポインター。

戻り値の型: BOOL

公式ドキュメント

KTM から回復データの不透明な構造体を取得します。

戻り値

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

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

次の一覧は、発生し得るエラーコードを示します。

解説(Remarks)

この呼び出しは、揮発性トランザクションマネージャーでは使用できません。

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

各言語での呼び出し定義

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

BOOL GetEnlistmentRecoveryInformation(
    HANDLE EnlistmentHandle,
    DWORD BufferSize,
    void* Buffer,
    DWORD* BufferUsed
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ktmw32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool GetEnlistmentRecoveryInformation(
    IntPtr EnlistmentHandle,   // HANDLE
    uint BufferSize,   // DWORD
    IntPtr Buffer,   // void* in/out
    ref uint BufferUsed   // DWORD* in/out
);

<DllImport("ktmw32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetEnlistmentRecoveryInformation(
    EnlistmentHandle As IntPtr,   ' HANDLE
    BufferSize As UInteger,   ' DWORD
    Buffer As IntPtr,   ' void* in/out
    ByRef BufferUsed As UInteger   ' DWORD* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

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

import ctypes
from ctypes import wintypes

GetEnlistmentRecoveryInformation = ctypes.windll.ktmw32.GetEnlistmentRecoveryInformation
GetEnlistmentRecoveryInformation.restype = wintypes.BOOL
GetEnlistmentRecoveryInformation.argtypes = [
    wintypes.HANDLE,  # EnlistmentHandle : HANDLE
    wintypes.DWORD,  # BufferSize : DWORD
    ctypes.POINTER(None),  # Buffer : void* in/out
    ctypes.POINTER(wintypes.DWORD),  # BufferUsed : DWORD* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ktmw32.dll')
GetEnlistmentRecoveryInformation = Fiddle::Function.new(
  lib['GetEnlistmentRecoveryInformation'],
  [
    Fiddle::TYPE_VOIDP,  # EnlistmentHandle : HANDLE
    -Fiddle::TYPE_INT,  # BufferSize : DWORD
    Fiddle::TYPE_VOIDP,  # Buffer : void* in/out
    Fiddle::TYPE_VOIDP,  # BufferUsed : DWORD* in/out
  ],
  Fiddle::TYPE_INT)

#[link(name = "ktmw32")]
extern "system" {
    fn GetEnlistmentRecoveryInformation(
        EnlistmentHandle: *mut core::ffi::c_void,  // HANDLE
        BufferSize: u32,  // DWORD
        Buffer: *mut (),  // void* in/out
        BufferUsed: *mut u32  // DWORD* 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 GetEnlistmentRecoveryInformation(IntPtr EnlistmentHandle, uint BufferSize, IntPtr Buffer, ref uint BufferUsed);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ktmw32_GetEnlistmentRecoveryInformation' -Namespace Win32 -PassThru
# $api::GetEnlistmentRecoveryInformation(EnlistmentHandle, BufferSize, Buffer, BufferUsed)

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

出力引数:

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