ホーム › Storage.FileSystem › TxfLogCreateFileReadContext

TxfLogCreateFileReadContext

関数

TxFログから特定ファイルのレコード読み取りコンテキストを作成する。

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

シグネチャ

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

BOOL TxfLogCreateFileReadContext(
    LPCWSTR LogPath,
    CLS_LSN BeginningLsn,
    CLS_LSN EndingLsn,
    TXF_ID* TxfFileId,
    void** TxfLogContext
);

パラメーター

名前	型	方向	説明
LogPath	LPCWSTR	in	リソースマネージャーの .blf ファイルを識別するパス。
BeginningLsn	CLS_LSN	in	読み取る範囲の最初の LSN。
EndingLsn	CLS_LSN	in	読み取る範囲の最後の LSN。
TxfFileId	TXF_ID*	in	LSN の範囲内で検索する TxF 識別子。詳細については、TXF_ID を参照してください。
TxfLogContext	void**	out	作成されたコンテキストへのポインター。

戻り値の型: BOOL

公式ドキュメント

レプリケーションレコードの読み取りに使用するコンテキストを作成します。

戻り値

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

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

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

各言語での呼び出し定義

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

BOOL TxfLogCreateFileReadContext(
    LPCWSTR LogPath,
    CLS_LSN BeginningLsn,
    CLS_LSN EndingLsn,
    TXF_ID* TxfFileId,
    void** TxfLogContext
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("txfw32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool TxfLogCreateFileReadContext(
    [MarshalAs(UnmanagedType.LPWStr)] string LogPath,   // LPCWSTR
    CLS_LSN BeginningLsn,   // CLS_LSN
    CLS_LSN EndingLsn,   // CLS_LSN
    IntPtr TxfFileId,   // TXF_ID*
    IntPtr TxfLogContext   // void** out
);

<DllImport("txfw32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function TxfLogCreateFileReadContext(
    <MarshalAs(UnmanagedType.LPWStr)> LogPath As String,   ' LPCWSTR
    BeginningLsn As CLS_LSN,   ' CLS_LSN
    EndingLsn As CLS_LSN,   ' CLS_LSN
    TxfFileId As IntPtr,   ' TXF_ID*
    TxfLogContext As IntPtr   ' void** out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' LogPath : LPCWSTR
' BeginningLsn : CLS_LSN
' EndingLsn : CLS_LSN
' TxfFileId : TXF_ID*
' TxfLogContext : void** out
Declare PtrSafe Function TxfLogCreateFileReadContext Lib "txfw32" ( _
    ByVal LogPath As LongPtr, _
    ByVal BeginningLsn As LongPtr, _
    ByVal EndingLsn As LongPtr, _
    ByVal TxfFileId As LongPtr, _
    ByVal TxfLogContext As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

TxfLogCreateFileReadContext = ctypes.windll.txfw32.TxfLogCreateFileReadContext
TxfLogCreateFileReadContext.restype = wintypes.BOOL
TxfLogCreateFileReadContext.argtypes = [
    wintypes.LPCWSTR,  # LogPath : LPCWSTR
    CLS_LSN,  # BeginningLsn : CLS_LSN
    CLS_LSN,  # EndingLsn : CLS_LSN
    ctypes.c_void_p,  # TxfFileId : TXF_ID*
    ctypes.c_void_p,  # TxfLogContext : void** out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('txfw32.dll')
TxfLogCreateFileReadContext = Fiddle::Function.new(
  lib['TxfLogCreateFileReadContext'],
  [
    Fiddle::TYPE_VOIDP,  # LogPath : LPCWSTR
    Fiddle::TYPE_VOIDP,  # BeginningLsn : CLS_LSN
    Fiddle::TYPE_VOIDP,  # EndingLsn : CLS_LSN
    Fiddle::TYPE_VOIDP,  # TxfFileId : TXF_ID*
    Fiddle::TYPE_VOIDP,  # TxfLogContext : void** out
  ],
  Fiddle::TYPE_INT)

#[link(name = "txfw32")]
extern "system" {
    fn TxfLogCreateFileReadContext(
        LogPath: *const u16,  // LPCWSTR
        BeginningLsn: CLS_LSN,  // CLS_LSN
        EndingLsn: CLS_LSN,  // CLS_LSN
        TxfFileId: *mut TXF_ID,  // TXF_ID*
        TxfLogContext: *mut *mut ()  // void** 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 TxfLogCreateFileReadContext([MarshalAs(UnmanagedType.LPWStr)] string LogPath, CLS_LSN BeginningLsn, CLS_LSN EndingLsn, IntPtr TxfFileId, IntPtr TxfLogContext);
"@
$api = Add-Type -MemberDefinition $sig -Name 'txfw32_TxfLogCreateFileReadContext' -Namespace Win32 -PassThru
# $api::TxfLogCreateFileReadContext(LogPath, BeginningLsn, EndingLsn, TxfFileId, TxfLogContext)

#uselib "txfw32.dll"
#func global TxfLogCreateFileReadContext "TxfLogCreateFileReadContext" sptr, sptr, sptr, sptr, sptr
; TxfLogCreateFileReadContext LogPath, BeginningLsn, EndingLsn, varptr(TxfFileId), TxfLogContext   ; 戻り値は stat
; LogPath : LPCWSTR -> "sptr"
; BeginningLsn : CLS_LSN -> "sptr"
; EndingLsn : CLS_LSN -> "sptr"
; TxfFileId : TXF_ID* -> "sptr"
; TxfLogContext : void** out -> "sptr"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "txfw32.dll"
#cfunc global TxfLogCreateFileReadContext "TxfLogCreateFileReadContext" wstr, int, int, var, sptr
; res = TxfLogCreateFileReadContext(LogPath, BeginningLsn, EndingLsn, TxfFileId, TxfLogContext)
; LogPath : LPCWSTR -> "wstr"
; BeginningLsn : CLS_LSN -> "int"
; EndingLsn : CLS_LSN -> "int"
; TxfFileId : TXF_ID* -> "var"
; TxfLogContext : void** out -> "sptr"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "txfw32.dll"
#cfunc global TxfLogCreateFileReadContext "TxfLogCreateFileReadContext" wstr, int, int, sptr, sptr
; res = TxfLogCreateFileReadContext(LogPath, BeginningLsn, EndingLsn, varptr(TxfFileId), TxfLogContext)
; LogPath : LPCWSTR -> "wstr"
; BeginningLsn : CLS_LSN -> "int"
; EndingLsn : CLS_LSN -> "int"
; TxfFileId : TXF_ID* -> "sptr"
; TxfLogContext : void** out -> "sptr"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。