ホーム › 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
);

パラメーター

名前	型	方向	説明
TxfLogContext	void*	in	コンテキストへのポインター。
BufferLength	DWORD	in	出力バッファーのサイズ(バイト単位)。
Buffer	void*	out	レコードを受け取るバッファーへのポインター。詳細については、TXF_LOG_RECORD_BASE を参照してください。
BytesUsed	DWORD*	out	出力バッファーに書き込まれたバイト数。
RecordCount	DWORD*	out	出力バッファーに書き込まれたレコード数。

戻り値の型: BOOL

公式ドキュメント

ログから redo レコードを読み取ります。

戻り値

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

関数が失敗した場合、戻り値は 0 です。拡張エラー情報を取得するには、 GetLastError を呼び出します。発生し得るエラーコードには、次のものが含まれます。

戻り値	説明
ERROR_INVALID_HANDLE	レプリケーションコンテキストが無効です。
ERROR_MORE_DATA	利用可能なレコードの一部がバッファーにコピーされました。残りのレコードを取得するには、この関数を再度呼び出してください。
ERROR_INSUFFICIENT_BUFFER	バッファーが 1 レコードを格納するにも十分な大きさではありません。BytesUsed が 0 以外の場合は、TXF_LOG_RECORD_BASE 構造体をコピーするだけの十分な領域があったことを意味し、次の完全なレコードを読み取るために必要なバッファーサイズを示します。
ERROR_FILE_CORRUPT	処理対象のログファイルの形式が認識できません。

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

各言語での呼び出し定義

// 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 <MarshalAs(UnmanagedType.Bool)> 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 方式にも切替可。#uselib "txfw32.dll"
#cfunc global TxfLogReadRecords "TxfLogReadRecords" sptr, int, sptr, sptr, sptr
; res = TxfLogReadRecords(TxfLogContext, BufferLength, Buffer, varptr(BytesUsed), varptr(RecordCount))
; TxfLogContext : void* -> "sptr"
; BufferLength : DWORD -> "int"
; Buffer : void* out -> "sptr"
; BytesUsed : DWORD* out -> "sptr"
; RecordCount : DWORD* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。