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

SetEnlistmentRecoveryInformation

関数
KTMエンリストメントに回復情報を設定する。
DLLktmw32.dll呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

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

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

パラメーター

名前方向説明
EnlistmentHandleHANDLEinエンリストメントへのハンドル。
BufferSizeDWORDinBuffer のサイズ(バイト単位)。
Buffervoid*inoutリカバリー情報。

戻り値の型: 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 SetEnlistmentRecoveryInformation(
    HANDLE EnlistmentHandle,
    DWORD BufferSize,
    void* Buffer
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ktmw32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool SetEnlistmentRecoveryInformation(
    IntPtr EnlistmentHandle,   // HANDLE
    uint BufferSize,   // DWORD
    IntPtr Buffer   // void* in/out
);
<DllImport("ktmw32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SetEnlistmentRecoveryInformation(
    EnlistmentHandle As IntPtr,   ' HANDLE
    BufferSize As UInteger,   ' DWORD
    Buffer As IntPtr   ' void* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' EnlistmentHandle : HANDLE
' BufferSize : DWORD
' Buffer : void* in/out
Declare PtrSafe Function SetEnlistmentRecoveryInformation Lib "ktmw32" ( _
    ByVal EnlistmentHandle As LongPtr, _
    ByVal BufferSize As Long, _
    ByVal Buffer As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

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

lib = Fiddle.dlopen('ktmw32.dll')
SetEnlistmentRecoveryInformation = Fiddle::Function.new(
  lib['SetEnlistmentRecoveryInformation'],
  [
    Fiddle::TYPE_VOIDP,  # EnlistmentHandle : HANDLE
    -Fiddle::TYPE_INT,  # BufferSize : DWORD
    Fiddle::TYPE_VOIDP,  # Buffer : void* in/out
  ],
  Fiddle::TYPE_INT)
#[link(name = "ktmw32")]
extern "system" {
    fn SetEnlistmentRecoveryInformation(
        EnlistmentHandle: *mut core::ffi::c_void,  // HANDLE
        BufferSize: u32,  // DWORD
        Buffer: *mut ()  // void* 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 SetEnlistmentRecoveryInformation(IntPtr EnlistmentHandle, uint BufferSize, IntPtr Buffer);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ktmw32_SetEnlistmentRecoveryInformation' -Namespace Win32 -PassThru
# $api::SetEnlistmentRecoveryInformation(EnlistmentHandle, BufferSize, Buffer)
#uselib "ktmw32.dll"
#func global SetEnlistmentRecoveryInformation "SetEnlistmentRecoveryInformation" sptr, sptr, sptr
; SetEnlistmentRecoveryInformation EnlistmentHandle, BufferSize, Buffer   ; 戻り値は stat
; EnlistmentHandle : HANDLE -> "sptr"
; BufferSize : DWORD -> "sptr"
; Buffer : void* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "ktmw32.dll"
#cfunc global SetEnlistmentRecoveryInformation "SetEnlistmentRecoveryInformation" sptr, int, sptr
; res = SetEnlistmentRecoveryInformation(EnlistmentHandle, BufferSize, Buffer)
; EnlistmentHandle : HANDLE -> "sptr"
; BufferSize : DWORD -> "int"
; Buffer : void* in/out -> "sptr"
; BOOL SetEnlistmentRecoveryInformation(HANDLE EnlistmentHandle, DWORD BufferSize, void* Buffer)
#uselib "ktmw32.dll"
#cfunc global SetEnlistmentRecoveryInformation "SetEnlistmentRecoveryInformation" intptr, int, intptr
; res = SetEnlistmentRecoveryInformation(EnlistmentHandle, BufferSize, Buffer)
; EnlistmentHandle : HANDLE -> "intptr"
; BufferSize : DWORD -> "int"
; Buffer : void* in/out -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	ktmw32 = windows.NewLazySystemDLL("ktmw32.dll")
	procSetEnlistmentRecoveryInformation = ktmw32.NewProc("SetEnlistmentRecoveryInformation")
)

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

extern "ktmw32" fn SetEnlistmentRecoveryInformation(
    EnlistmentHandle: ?*anyopaque, // HANDLE
    BufferSize: u32, // DWORD
    Buffer: ?*anyopaque // void* in/out
) callconv(std.os.windows.WINAPI) i32;
proc SetEnlistmentRecoveryInformation(
    EnlistmentHandle: pointer,  # HANDLE
    BufferSize: uint32,  # DWORD
    Buffer: pointer  # void* in/out
): int32 {.importc: "SetEnlistmentRecoveryInformation", stdcall, dynlib: "ktmw32.dll".}
pragma(lib, "ktmw32");
extern(Windows)
int SetEnlistmentRecoveryInformation(
    void* EnlistmentHandle,   // HANDLE
    uint BufferSize,   // DWORD
    void* Buffer   // void* in/out
);
ccall((:SetEnlistmentRecoveryInformation, "ktmw32.dll"), stdcall, Int32,
      (Ptr{Cvoid}, UInt32, Ptr{Cvoid}),
      EnlistmentHandle, BufferSize, Buffer)
# EnlistmentHandle : HANDLE -> Ptr{Cvoid}
# BufferSize : DWORD -> UInt32
# Buffer : void* in/out -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t SetEnlistmentRecoveryInformation(
    void* EnlistmentHandle,
    uint32_t BufferSize,
    void* Buffer);
]]
local ktmw32 = ffi.load("ktmw32")
-- ktmw32.SetEnlistmentRecoveryInformation(EnlistmentHandle, BufferSize, Buffer)
-- EnlistmentHandle : HANDLE
-- BufferSize : DWORD
-- Buffer : void* in/out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('ktmw32.dll');
const SetEnlistmentRecoveryInformation = lib.func('__stdcall', 'SetEnlistmentRecoveryInformation', 'int32_t', ['void *', 'uint32_t', 'void *']);
// SetEnlistmentRecoveryInformation(EnlistmentHandle, BufferSize, Buffer)
// EnlistmentHandle : HANDLE -> 'void *'
// BufferSize : DWORD -> 'uint32_t'
// Buffer : void* in/out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("ktmw32.dll", {
  SetEnlistmentRecoveryInformation: { parameters: ["pointer", "u32", "pointer"], result: "i32" },
});
// lib.symbols.SetEnlistmentRecoveryInformation(EnlistmentHandle, BufferSize, Buffer)
// EnlistmentHandle : HANDLE -> "pointer"
// BufferSize : DWORD -> "u32"
// Buffer : void* in/out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t SetEnlistmentRecoveryInformation(
    void* EnlistmentHandle,
    uint32_t BufferSize,
    void* Buffer);
C, "ktmw32.dll");
// $ffi->SetEnlistmentRecoveryInformation(EnlistmentHandle, BufferSize, Buffer);
// EnlistmentHandle : HANDLE
// BufferSize : DWORD
// Buffer : void* 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 SetEnlistmentRecoveryInformation(
        Pointer EnlistmentHandle,   // HANDLE
        int BufferSize,   // DWORD
        Pointer Buffer   // void* in/out
    );
}
@[Link("ktmw32")]
lib Libktmw32
  fun SetEnlistmentRecoveryInformation = SetEnlistmentRecoveryInformation(
    EnlistmentHandle : Void*,   # HANDLE
    BufferSize : UInt32,   # DWORD
    Buffer : Void*   # void* 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 SetEnlistmentRecoveryInformationNative = Int32 Function(Pointer<Void>, Uint32, Pointer<Void>);
typedef SetEnlistmentRecoveryInformationDart = int Function(Pointer<Void>, int, Pointer<Void>);
final SetEnlistmentRecoveryInformation = DynamicLibrary.open('ktmw32.dll')
    .lookupFunction<SetEnlistmentRecoveryInformationNative, SetEnlistmentRecoveryInformationDart>('SetEnlistmentRecoveryInformation');
// EnlistmentHandle : HANDLE -> Pointer<Void>
// BufferSize : DWORD -> Uint32
// Buffer : void* in/out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SetEnlistmentRecoveryInformation(
  EnlistmentHandle: THandle;   // HANDLE
  BufferSize: DWORD;   // DWORD
  Buffer: Pointer   // void* in/out
): BOOL; stdcall;
  external 'ktmw32.dll' name 'SetEnlistmentRecoveryInformation';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

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

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

関連項目

公式の関連項目