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

TxfReadMetadataInfo

関数
TxFファイルのトランザクションメタデータ情報を読み取る。
DLLtxfw32.dll呼出規約winapi

シグネチャ

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

BOOL TxfReadMetadataInfo(
    HANDLE FileHandle,
    TXF_ID* TxfFileId,
    CLS_LSN* LastLsn,
    DWORD* TransactionState,
    GUID* LockingTransaction
);

パラメーター

名前方向説明
FileHandleHANDLEinTxFメタデータを読み取る対象ファイルのハンドル。
TxfFileIdTXF_ID*out対象ファイルのTxFファイルIDを受け取る構造体ポインタ。
LastLsnCLS_LSN*out最後のTxF LSNを受け取る出力ポインタ。
TransactionStateDWORD*out現在のトランザクション状態を受け取る出力ポインタ。
LockingTransactionGUID*outファイルをロックしているトランザクションのGUIDを受け取る出力ポインタ。

戻り値の型: BOOL

各言語での呼び出し定義

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

BOOL TxfReadMetadataInfo(
    HANDLE FileHandle,
    TXF_ID* TxfFileId,
    CLS_LSN* LastLsn,
    DWORD* TransactionState,
    GUID* LockingTransaction
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("txfw32.dll", ExactSpelling = true)]
static extern bool TxfReadMetadataInfo(
    IntPtr FileHandle,   // HANDLE
    IntPtr TxfFileId,   // TXF_ID* out
    IntPtr LastLsn,   // CLS_LSN* out
    out uint TransactionState,   // DWORD* out
    out Guid LockingTransaction   // GUID* out
);
<DllImport("txfw32.dll", ExactSpelling:=True)>
Public Shared Function TxfReadMetadataInfo(
    FileHandle As IntPtr,   ' HANDLE
    TxfFileId As IntPtr,   ' TXF_ID* out
    LastLsn As IntPtr,   ' CLS_LSN* out
    <Out> ByRef TransactionState As UInteger,   ' DWORD* out
    <Out> ByRef LockingTransaction As Guid   ' GUID* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' FileHandle : HANDLE
' TxfFileId : TXF_ID* out
' LastLsn : CLS_LSN* out
' TransactionState : DWORD* out
' LockingTransaction : GUID* out
Declare PtrSafe Function TxfReadMetadataInfo Lib "txfw32" ( _
    ByVal FileHandle As LongPtr, _
    ByVal TxfFileId As LongPtr, _
    ByVal LastLsn As LongPtr, _
    ByRef TransactionState As Long, _
    ByVal LockingTransaction As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

TxfReadMetadataInfo = ctypes.windll.txfw32.TxfReadMetadataInfo
TxfReadMetadataInfo.restype = wintypes.BOOL
TxfReadMetadataInfo.argtypes = [
    wintypes.HANDLE,  # FileHandle : HANDLE
    ctypes.c_void_p,  # TxfFileId : TXF_ID* out
    ctypes.c_void_p,  # LastLsn : CLS_LSN* out
    ctypes.POINTER(wintypes.DWORD),  # TransactionState : DWORD* out
    ctypes.c_void_p,  # LockingTransaction : GUID* out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('txfw32.dll')
TxfReadMetadataInfo = Fiddle::Function.new(
  lib['TxfReadMetadataInfo'],
  [
    Fiddle::TYPE_VOIDP,  # FileHandle : HANDLE
    Fiddle::TYPE_VOIDP,  # TxfFileId : TXF_ID* out
    Fiddle::TYPE_VOIDP,  # LastLsn : CLS_LSN* out
    Fiddle::TYPE_VOIDP,  # TransactionState : DWORD* out
    Fiddle::TYPE_VOIDP,  # LockingTransaction : GUID* out
  ],
  Fiddle::TYPE_INT)
#[link(name = "txfw32")]
extern "system" {
    fn TxfReadMetadataInfo(
        FileHandle: *mut core::ffi::c_void,  // HANDLE
        TxfFileId: *mut TXF_ID,  // TXF_ID* out
        LastLsn: *mut CLS_LSN,  // CLS_LSN* out
        TransactionState: *mut u32,  // DWORD* out
        LockingTransaction: *mut GUID  // GUID* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("txfw32.dll")]
public static extern bool TxfReadMetadataInfo(IntPtr FileHandle, IntPtr TxfFileId, IntPtr LastLsn, out uint TransactionState, out Guid LockingTransaction);
"@
$api = Add-Type -MemberDefinition $sig -Name 'txfw32_TxfReadMetadataInfo' -Namespace Win32 -PassThru
# $api::TxfReadMetadataInfo(FileHandle, TxfFileId, LastLsn, TransactionState, LockingTransaction)
#uselib "txfw32.dll"
#func global TxfReadMetadataInfo "TxfReadMetadataInfo" sptr, sptr, sptr, sptr, sptr
; TxfReadMetadataInfo FileHandle, varptr(TxfFileId), varptr(LastLsn), varptr(TransactionState), varptr(LockingTransaction)   ; 戻り値は stat
; FileHandle : HANDLE -> "sptr"
; TxfFileId : TXF_ID* out -> "sptr"
; LastLsn : CLS_LSN* out -> "sptr"
; TransactionState : DWORD* out -> "sptr"
; LockingTransaction : GUID* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "txfw32.dll"
#cfunc global TxfReadMetadataInfo "TxfReadMetadataInfo" sptr, var, var, var, var
; res = TxfReadMetadataInfo(FileHandle, TxfFileId, LastLsn, TransactionState, LockingTransaction)
; FileHandle : HANDLE -> "sptr"
; TxfFileId : TXF_ID* out -> "var"
; LastLsn : CLS_LSN* out -> "var"
; TransactionState : DWORD* out -> "var"
; LockingTransaction : GUID* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL TxfReadMetadataInfo(HANDLE FileHandle, TXF_ID* TxfFileId, CLS_LSN* LastLsn, DWORD* TransactionState, GUID* LockingTransaction)
#uselib "txfw32.dll"
#cfunc global TxfReadMetadataInfo "TxfReadMetadataInfo" intptr, var, var, var, var
; res = TxfReadMetadataInfo(FileHandle, TxfFileId, LastLsn, TransactionState, LockingTransaction)
; FileHandle : HANDLE -> "intptr"
; TxfFileId : TXF_ID* out -> "var"
; LastLsn : CLS_LSN* out -> "var"
; TransactionState : DWORD* out -> "var"
; LockingTransaction : GUID* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	txfw32 = windows.NewLazySystemDLL("txfw32.dll")
	procTxfReadMetadataInfo = txfw32.NewProc("TxfReadMetadataInfo")
)

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

extern "txfw32" fn TxfReadMetadataInfo(
    FileHandle: ?*anyopaque, // HANDLE
    TxfFileId: [*c]TXF_ID, // TXF_ID* out
    LastLsn: [*c]CLS_LSN, // CLS_LSN* out
    TransactionState: [*c]u32, // DWORD* out
    LockingTransaction: [*c]GUID // GUID* out
) callconv(std.os.windows.WINAPI) i32;
proc TxfReadMetadataInfo(
    FileHandle: pointer,  # HANDLE
    TxfFileId: ptr TXF_ID,  # TXF_ID* out
    LastLsn: ptr CLS_LSN,  # CLS_LSN* out
    TransactionState: ptr uint32,  # DWORD* out
    LockingTransaction: ptr GUID  # GUID* out
): int32 {.importc: "TxfReadMetadataInfo", stdcall, dynlib: "txfw32.dll".}
pragma(lib, "txfw32");
extern(Windows)
int TxfReadMetadataInfo(
    void* FileHandle,   // HANDLE
    TXF_ID* TxfFileId,   // TXF_ID* out
    CLS_LSN* LastLsn,   // CLS_LSN* out
    uint* TransactionState,   // DWORD* out
    GUID* LockingTransaction   // GUID* out
);
ccall((:TxfReadMetadataInfo, "txfw32.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Ptr{TXF_ID}, Ptr{CLS_LSN}, Ptr{UInt32}, Ptr{GUID}),
      FileHandle, TxfFileId, LastLsn, TransactionState, LockingTransaction)
# FileHandle : HANDLE -> Ptr{Cvoid}
# TxfFileId : TXF_ID* out -> Ptr{TXF_ID}
# LastLsn : CLS_LSN* out -> Ptr{CLS_LSN}
# TransactionState : DWORD* out -> Ptr{UInt32}
# LockingTransaction : GUID* out -> Ptr{GUID}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t TxfReadMetadataInfo(
    void* FileHandle,
    void* TxfFileId,
    void* LastLsn,
    uint32_t* TransactionState,
    void* LockingTransaction);
]]
local txfw32 = ffi.load("txfw32")
-- txfw32.TxfReadMetadataInfo(FileHandle, TxfFileId, LastLsn, TransactionState, LockingTransaction)
-- FileHandle : HANDLE
-- TxfFileId : TXF_ID* out
-- LastLsn : CLS_LSN* out
-- TransactionState : DWORD* out
-- LockingTransaction : GUID* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('txfw32.dll');
const TxfReadMetadataInfo = lib.func('__stdcall', 'TxfReadMetadataInfo', 'int32_t', ['void *', 'void *', 'void *', 'uint32_t *', 'void *']);
// TxfReadMetadataInfo(FileHandle, TxfFileId, LastLsn, TransactionState, LockingTransaction)
// FileHandle : HANDLE -> 'void *'
// TxfFileId : TXF_ID* out -> 'void *'
// LastLsn : CLS_LSN* out -> 'void *'
// TransactionState : DWORD* out -> 'uint32_t *'
// LockingTransaction : GUID* out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("txfw32.dll", {
  TxfReadMetadataInfo: { parameters: ["pointer", "pointer", "pointer", "pointer", "pointer"], result: "i32" },
});
// lib.symbols.TxfReadMetadataInfo(FileHandle, TxfFileId, LastLsn, TransactionState, LockingTransaction)
// FileHandle : HANDLE -> "pointer"
// TxfFileId : TXF_ID* out -> "pointer"
// LastLsn : CLS_LSN* out -> "pointer"
// TransactionState : DWORD* out -> "pointer"
// LockingTransaction : GUID* out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t TxfReadMetadataInfo(
    void* FileHandle,
    void* TxfFileId,
    void* LastLsn,
    uint32_t* TransactionState,
    void* LockingTransaction);
C, "txfw32.dll");
// $ffi->TxfReadMetadataInfo(FileHandle, TxfFileId, LastLsn, TransactionState, LockingTransaction);
// FileHandle : HANDLE
// TxfFileId : TXF_ID* out
// LastLsn : CLS_LSN* out
// TransactionState : DWORD* out
// LockingTransaction : GUID* 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 Txfw32 extends StdCallLibrary {
    Txfw32 INSTANCE = Native.load("txfw32", Txfw32.class);
    boolean TxfReadMetadataInfo(
        Pointer FileHandle,   // HANDLE
        Pointer TxfFileId,   // TXF_ID* out
        Pointer LastLsn,   // CLS_LSN* out
        IntByReference TransactionState,   // DWORD* out
        Pointer LockingTransaction   // GUID* out
    );
}
@[Link("txfw32")]
lib Libtxfw32
  fun TxfReadMetadataInfo = TxfReadMetadataInfo(
    FileHandle : Void*,   # HANDLE
    TxfFileId : TXF_ID*,   # TXF_ID* out
    LastLsn : CLS_LSN*,   # CLS_LSN* out
    TransactionState : UInt32*,   # DWORD* out
    LockingTransaction : GUID*   # GUID* out
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef TxfReadMetadataInfoNative = Int32 Function(Pointer<Void>, Pointer<Void>, Pointer<Void>, Pointer<Uint32>, Pointer<Void>);
typedef TxfReadMetadataInfoDart = int Function(Pointer<Void>, Pointer<Void>, Pointer<Void>, Pointer<Uint32>, Pointer<Void>);
final TxfReadMetadataInfo = DynamicLibrary.open('txfw32.dll')
    .lookupFunction<TxfReadMetadataInfoNative, TxfReadMetadataInfoDart>('TxfReadMetadataInfo');
// FileHandle : HANDLE -> Pointer<Void>
// TxfFileId : TXF_ID* out -> Pointer<Void>
// LastLsn : CLS_LSN* out -> Pointer<Void>
// TransactionState : DWORD* out -> Pointer<Uint32>
// LockingTransaction : GUID* out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function TxfReadMetadataInfo(
  FileHandle: THandle;   // HANDLE
  TxfFileId: Pointer;   // TXF_ID* out
  LastLsn: Pointer;   // CLS_LSN* out
  TransactionState: Pointer;   // DWORD* out
  LockingTransaction: PGUID   // GUID* out
): BOOL; stdcall;
  external 'txfw32.dll' name 'TxfReadMetadataInfo';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "TxfReadMetadataInfo"
  c_TxfReadMetadataInfo :: Ptr () -> Ptr () -> Ptr () -> Ptr Word32 -> Ptr () -> IO CInt
-- FileHandle : HANDLE -> Ptr ()
-- TxfFileId : TXF_ID* out -> Ptr ()
-- LastLsn : CLS_LSN* out -> Ptr ()
-- TransactionState : DWORD* out -> Ptr Word32
-- LockingTransaction : GUID* out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let txfreadmetadatainfo =
  foreign "TxfReadMetadataInfo"
    ((ptr void) @-> (ptr void) @-> (ptr void) @-> (ptr uint32_t) @-> (ptr void) @-> returning int32_t)
(* FileHandle : HANDLE -> (ptr void) *)
(* TxfFileId : TXF_ID* out -> (ptr void) *)
(* LastLsn : CLS_LSN* out -> (ptr void) *)
(* TransactionState : DWORD* out -> (ptr uint32_t) *)
(* LockingTransaction : GUID* out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library txfw32 (t "txfw32.dll"))
(cffi:use-foreign-library txfw32)

(cffi:defcfun ("TxfReadMetadataInfo" txf-read-metadata-info :convention :stdcall) :int32
  (file-handle :pointer)   ; HANDLE
  (txf-file-id :pointer)   ; TXF_ID* out
  (last-lsn :pointer)   ; CLS_LSN* out
  (transaction-state :pointer)   ; DWORD* out
  (locking-transaction :pointer))   ; GUID* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $TxfReadMetadataInfo = Win32::API::More->new('txfw32',
    'BOOL TxfReadMetadataInfo(HANDLE FileHandle, LPVOID TxfFileId, LPVOID LastLsn, LPVOID TransactionState, LPVOID LockingTransaction)');
# my $ret = $TxfReadMetadataInfo->Call($FileHandle, $TxfFileId, $LastLsn, $TransactionState, $LockingTransaction);
# FileHandle : HANDLE -> HANDLE
# TxfFileId : TXF_ID* out -> LPVOID
# LastLsn : CLS_LSN* out -> LPVOID
# TransactionState : DWORD* out -> LPVOID
# LockingTransaction : GUID* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型