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

TxfLogReadRecords

関数
TxFログからレコードをバッファへ読み取る。
DLLtxfw32.dll呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

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

BOOL TxfLogReadRecords(
    void* TxfLogContext,
    DWORD BufferLength,
    void* Buffer,
    DWORD* BytesUsed,
    DWORD* RecordCount
);

パラメーター

名前方向
TxfLogContextvoid*in
BufferLengthDWORDin
Buffervoid*out
BytesUsedDWORD*out
RecordCountDWORD*out

戻り値の型: BOOL

各言語での呼び出し定義

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

BOOL TxfLogReadRecords(
    void* TxfLogContext,
    DWORD BufferLength,
    void* Buffer,
    DWORD* BytesUsed,
    DWORD* RecordCount
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("txfw32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool TxfLogReadRecords(
    IntPtr TxfLogContext,   // void*
    uint BufferLength,   // DWORD
    IntPtr Buffer,   // void* out
    out uint BytesUsed,   // DWORD* out
    out uint RecordCount   // DWORD* out
);
<DllImport("txfw32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function TxfLogReadRecords(
    TxfLogContext As IntPtr,   ' void*
    BufferLength As UInteger,   ' DWORD
    Buffer As IntPtr,   ' void* out
    <Out> ByRef BytesUsed As UInteger,   ' DWORD* out
    <Out> ByRef RecordCount As UInteger   ' DWORD* out
) As Boolean
End Function
' TxfLogContext : void*
' BufferLength : DWORD
' Buffer : void* out
' BytesUsed : DWORD* out
' RecordCount : DWORD* out
Declare PtrSafe Function TxfLogReadRecords Lib "txfw32" ( _
    ByVal TxfLogContext As LongPtr, _
    ByVal BufferLength As Long, _
    ByVal Buffer As LongPtr, _
    ByRef BytesUsed As Long, _
    ByRef RecordCount As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

TxfLogReadRecords = ctypes.windll.txfw32.TxfLogReadRecords
TxfLogReadRecords.restype = wintypes.BOOL
TxfLogReadRecords.argtypes = [
    ctypes.POINTER(None),  # TxfLogContext : void*
    wintypes.DWORD,  # BufferLength : DWORD
    ctypes.POINTER(None),  # Buffer : void* out
    ctypes.POINTER(wintypes.DWORD),  # BytesUsed : DWORD* out
    ctypes.POINTER(wintypes.DWORD),  # RecordCount : DWORD* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

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

var (
	txfw32 = windows.NewLazySystemDLL("txfw32.dll")
	procTxfLogReadRecords = txfw32.NewProc("TxfLogReadRecords")
)

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