ホーム › Storage.FileSystem › ReadLogRecord

ReadLogRecord

関数

CLFSログから指定LSNのレコードを読み取る。

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

シグネチャ

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

BOOL ReadLogRecord(
    void* pvMarshal,
    CLS_LSN* plsnFirst,
    CLFS_CONTEXT_MODE eContextMode,
    void** ppvReadBuffer,
    DWORD* pcbReadBuffer,
    BYTE* peRecordType,
    CLS_LSN* plsnUndoNext,
    CLS_LSN* plsnPrevious,
    void** ppvReadContext,
    OVERLAPPED* pOverlapped
);

パラメーター

名前

型

方向

説明

pvMarshal

void*

inout

CreateLogMarshallingArea 関数を使用して割り当てられたマーシャリングコンテキストへのポインターです。

plsnFirst

CLS_LSN*

inout

読み取り操作を開始するレコードのログシーケンス番号 (LSN) を指定する CLFS_LSN 構造体へのポインターです。

この値は、ログのアクティブ範囲内にある有効なレコードの LSN でなければなりません。

eContextMode

CLFS_CONTEXT_MODE

*ppvReadContext で返される読み取りコンテキストのモードです。

次の表に、相互排他的な 3 つの読み取りモードを示します。

Value	Meaning
ClfsContextPrevious	plsnPrevious でリンクされたレコードを読み取ります。
ClfsContextUndoNext	plsnUndoNext でリンクされたレコードチェーンを読み取ります。
ClfsContextForward	読み取りコンテキスト内の現在の LSN の直後に続く LSN を持つレコードを読み取ります。

ppvReadBuffer

void**

inout

ログ I/O ブロック内の対象レコードへのポインターを受け取る変数へのポインターです。

pcbReadBuffer

DWORD*

inout

*ppvReadBuffer で返されるデータのサイズ (バイト単位) を受け取る変数へのポインターです。

peRecordType

BYTE*

inout

読み取ったレコードの種類を受け取る変数へのポインターです。

このパラメーターは CLFS_RECORD_TYPE Constants のいずれかです。

plsnUndoNext

CLS_LSN*

inout

アンドゥレコードチェーン内の次のレコードの LSN を受け取る CLFS_LSN 構造体へのポインターです。

plsnPrevious

CLS_LSN*

inout

前のレコードチェーン内の次のレコードの LSN を受け取る CLFS_LSN 構造体へのポインターです。

ppvReadContext

void**

inout

読み取りが成功したときに、システムが割り当てた読み取りコンテキストへのポインターを受け取る変数へのポインターです。

関数が操作の完了を延期する場合、有効な読み取りコンテキストポインターと ERROR_IO_PENDING のエラーステータスを返します。それ以外のすべてのエラーでは、読み取りコンテキストポインターは NULL になります。この関数の延期完了の処理の詳細については、このトピックの「解説」セクションを参照してください。

要求したすべてのログレコードを取得した後、クライアントは関連付けられたメモリを解放するために、読み取りコンテキストを TerminateReadLog に渡す必要があります。これを行わないとメモリリークが発生します。

Note Common Log File System (CLFS) の読み取りコンテキストはスレッドセーフではありません。複数のスレッドで同時に使用したり、複数の非同期読み取りに同時に渡したりしないでください。

pOverlapped

OVERLAPPED*

inout

非同期操作に必要な OVERLAPPED 構造体へのポインターです。

非同期操作を使用しない場合、このパラメーターは NULL にできます。

戻り値の型: BOOL

公式ドキュメント

指定したログシーケンス番号 (LSN) からの一連の読み取りを 3 つのモードのいずれかで開始し、指定したログレコードのうち最初のものと読み取りコンテキストを返します。

戻り値

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

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

次の一覧に、発生し得るエラーコードを示します。

解説(Remarks)

CreateLogMarshallingArea で指定したログブロックサイズが、完全なログブロックを保持するのに十分な大きさでない場合、エラーメッセージ ERROR_LOG_BLOCK_INCOMPLETE が返されます。

有効な pOverlapped 構造体を指定して ReadLogRecord を呼び出し、かつログハンドルがオーバーラップオプションで作成されている場合、この関数の呼び出しが ERROR_IO_PENDING のエラーコードで失敗すると、有効な読み取りコンテキストへのポインターが ppvReadContext パラメーターが指す変数に格納されます。

CreateLogMarshallingArea への以前の呼び出しで指定したバッファー数を超える読み取りコンテキストを開こうとすると、ERROR_LOG_BLOCK_EXHAUSTED が返されます。

ログレコードのコピーを完了するには、クライアントはまず GetOverlappedResult または Wait Functions のいずれかを使用して、オーバーラップ I/O 操作の延期完了と自身の実行を同期させる必要があります。詳細については、Synchronization and Overlapped Input and Output を参照してください。

ReadLogRecord が非同期に完了した後、要求されたレコードはディスクから読み取られますが、*ppvReadBuffer 内のポインターには解決されていません。

要求された読み取りを完了し、ログレコードへの有効なポインターを取得するには、クライアントは ReadLogRecord が返す読み取りコンテキストポインターを渡して ReadNextLogRecord を呼び出す必要があります。

Note Common Log File System (CLFS) の読み取りコンテキストはスレッドセーフではありません。複数のスレッドで同時に使用しないでください。

CLFS の読み取りコンテキストを複数の非同期読み取りに同時に渡さないでください。渡した場合、関数は ERROR_BUSY で失敗します。

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

各言語での呼び出し定義

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

BOOL ReadLogRecord(
    void* pvMarshal,
    CLS_LSN* plsnFirst,
    CLFS_CONTEXT_MODE eContextMode,
    void** ppvReadBuffer,
    DWORD* pcbReadBuffer,
    BYTE* peRecordType,
    CLS_LSN* plsnUndoNext,
    CLS_LSN* plsnPrevious,
    void** ppvReadContext,
    OVERLAPPED* pOverlapped
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("clfsw32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool ReadLogRecord(
    IntPtr pvMarshal,   // void* in/out
    IntPtr plsnFirst,   // CLS_LSN* in/out
    int eContextMode,   // CLFS_CONTEXT_MODE
    IntPtr ppvReadBuffer,   // void** in/out
    ref uint pcbReadBuffer,   // DWORD* in/out
    IntPtr peRecordType,   // BYTE* in/out
    IntPtr plsnUndoNext,   // CLS_LSN* in/out
    IntPtr plsnPrevious,   // CLS_LSN* in/out
    IntPtr ppvReadContext,   // void** in/out
    IntPtr pOverlapped   // OVERLAPPED* in/out
);

<DllImport("clfsw32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function ReadLogRecord(
    pvMarshal As IntPtr,   ' void* in/out
    plsnFirst As IntPtr,   ' CLS_LSN* in/out
    eContextMode As Integer,   ' CLFS_CONTEXT_MODE
    ppvReadBuffer As IntPtr,   ' void** in/out
    ByRef pcbReadBuffer As UInteger,   ' DWORD* in/out
    peRecordType As IntPtr,   ' BYTE* in/out
    plsnUndoNext As IntPtr,   ' CLS_LSN* in/out
    plsnPrevious As IntPtr,   ' CLS_LSN* in/out
    ppvReadContext As IntPtr,   ' void** in/out
    pOverlapped As IntPtr   ' OVERLAPPED* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' pvMarshal : void* in/out
' plsnFirst : CLS_LSN* in/out
' eContextMode : CLFS_CONTEXT_MODE
' ppvReadBuffer : void** in/out
' pcbReadBuffer : DWORD* in/out
' peRecordType : BYTE* in/out
' plsnUndoNext : CLS_LSN* in/out
' plsnPrevious : CLS_LSN* in/out
' ppvReadContext : void** in/out
' pOverlapped : OVERLAPPED* in/out
Declare PtrSafe Function ReadLogRecord Lib "clfsw32" ( _
    ByVal pvMarshal As LongPtr, _
    ByVal plsnFirst As LongPtr, _
    ByVal eContextMode As Long, _
    ByVal ppvReadBuffer As LongPtr, _
    ByRef pcbReadBuffer As Long, _
    ByVal peRecordType As LongPtr, _
    ByVal plsnUndoNext As LongPtr, _
    ByVal plsnPrevious As LongPtr, _
    ByVal ppvReadContext As LongPtr, _
    ByVal pOverlapped As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

ReadLogRecord = ctypes.windll.clfsw32.ReadLogRecord
ReadLogRecord.restype = wintypes.BOOL
ReadLogRecord.argtypes = [
    ctypes.POINTER(None),  # pvMarshal : void* in/out
    ctypes.c_void_p,  # plsnFirst : CLS_LSN* in/out
    ctypes.c_int,  # eContextMode : CLFS_CONTEXT_MODE
    ctypes.c_void_p,  # ppvReadBuffer : void** in/out
    ctypes.POINTER(wintypes.DWORD),  # pcbReadBuffer : DWORD* in/out
    ctypes.POINTER(ctypes.c_ubyte),  # peRecordType : BYTE* in/out
    ctypes.c_void_p,  # plsnUndoNext : CLS_LSN* in/out
    ctypes.c_void_p,  # plsnPrevious : CLS_LSN* in/out
    ctypes.c_void_p,  # ppvReadContext : void** in/out
    ctypes.c_void_p,  # pOverlapped : OVERLAPPED* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('clfsw32.dll')
ReadLogRecord = Fiddle::Function.new(
  lib['ReadLogRecord'],
  [
    Fiddle::TYPE_VOIDP,  # pvMarshal : void* in/out
    Fiddle::TYPE_VOIDP,  # plsnFirst : CLS_LSN* in/out
    Fiddle::TYPE_INT,  # eContextMode : CLFS_CONTEXT_MODE
    Fiddle::TYPE_VOIDP,  # ppvReadBuffer : void** in/out
    Fiddle::TYPE_VOIDP,  # pcbReadBuffer : DWORD* in/out
    Fiddle::TYPE_VOIDP,  # peRecordType : BYTE* in/out
    Fiddle::TYPE_VOIDP,  # plsnUndoNext : CLS_LSN* in/out
    Fiddle::TYPE_VOIDP,  # plsnPrevious : CLS_LSN* in/out
    Fiddle::TYPE_VOIDP,  # ppvReadContext : void** in/out
    Fiddle::TYPE_VOIDP,  # pOverlapped : OVERLAPPED* in/out
  ],
  Fiddle::TYPE_INT)

#[link(name = "clfsw32")]
extern "system" {
    fn ReadLogRecord(
        pvMarshal: *mut (),  // void* in/out
        plsnFirst: *mut CLS_LSN,  // CLS_LSN* in/out
        eContextMode: i32,  // CLFS_CONTEXT_MODE
        ppvReadBuffer: *mut *mut (),  // void** in/out
        pcbReadBuffer: *mut u32,  // DWORD* in/out
        peRecordType: *mut u8,  // BYTE* in/out
        plsnUndoNext: *mut CLS_LSN,  // CLS_LSN* in/out
        plsnPrevious: *mut CLS_LSN,  // CLS_LSN* in/out
        ppvReadContext: *mut *mut (),  // void** in/out
        pOverlapped: *mut OVERLAPPED  // OVERLAPPED* in/out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("clfsw32.dll", SetLastError = true)]
public static extern bool ReadLogRecord(IntPtr pvMarshal, IntPtr plsnFirst, int eContextMode, IntPtr ppvReadBuffer, ref uint pcbReadBuffer, IntPtr peRecordType, IntPtr plsnUndoNext, IntPtr plsnPrevious, IntPtr ppvReadContext, IntPtr pOverlapped);
"@
$api = Add-Type -MemberDefinition $sig -Name 'clfsw32_ReadLogRecord' -Namespace Win32 -PassThru
# $api::ReadLogRecord(pvMarshal, plsnFirst, eContextMode, ppvReadBuffer, pcbReadBuffer, peRecordType, plsnUndoNext, plsnPrevious, ppvReadContext, pOverlapped)

#uselib "clfsw32.dll"
#func global ReadLogRecord "ReadLogRecord" sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr
; ReadLogRecord pvMarshal, varptr(plsnFirst), eContextMode, ppvReadBuffer, varptr(pcbReadBuffer), varptr(peRecordType), varptr(plsnUndoNext), varptr(plsnPrevious), ppvReadContext, varptr(pOverlapped)   ; 戻り値は stat
; pvMarshal : void* in/out -> "sptr"
; plsnFirst : CLS_LSN* in/out -> "sptr"
; eContextMode : CLFS_CONTEXT_MODE -> "sptr"
; ppvReadBuffer : void** in/out -> "sptr"
; pcbReadBuffer : DWORD* in/out -> "sptr"
; peRecordType : BYTE* in/out -> "sptr"
; plsnUndoNext : CLS_LSN* in/out -> "sptr"
; plsnPrevious : CLS_LSN* in/out -> "sptr"
; ppvReadContext : void** in/out -> "sptr"
; pOverlapped : OVERLAPPED* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "clfsw32.dll"
#cfunc global ReadLogRecord "ReadLogRecord" sptr, var, int, sptr, var, var, var, var, sptr, var
; res = ReadLogRecord(pvMarshal, plsnFirst, eContextMode, ppvReadBuffer, pcbReadBuffer, peRecordType, plsnUndoNext, plsnPrevious, ppvReadContext, pOverlapped)
; pvMarshal : void* in/out -> "sptr"
; plsnFirst : CLS_LSN* in/out -> "var"
; eContextMode : CLFS_CONTEXT_MODE -> "int"
; ppvReadBuffer : void** in/out -> "sptr"
; pcbReadBuffer : DWORD* in/out -> "var"
; peRecordType : BYTE* in/out -> "var"
; plsnUndoNext : CLS_LSN* in/out -> "var"
; plsnPrevious : CLS_LSN* in/out -> "var"
; ppvReadContext : void** in/out -> "sptr"
; pOverlapped : OVERLAPPED* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "clfsw32.dll"
#cfunc global ReadLogRecord "ReadLogRecord" sptr, sptr, int, sptr, sptr, sptr, sptr, sptr, sptr, sptr
; res = ReadLogRecord(pvMarshal, varptr(plsnFirst), eContextMode, ppvReadBuffer, varptr(pcbReadBuffer), varptr(peRecordType), varptr(plsnUndoNext), varptr(plsnPrevious), ppvReadContext, varptr(pOverlapped))
; pvMarshal : void* in/out -> "sptr"
; plsnFirst : CLS_LSN* in/out -> "sptr"
; eContextMode : CLFS_CONTEXT_MODE -> "int"
; ppvReadBuffer : void** in/out -> "sptr"
; pcbReadBuffer : DWORD* in/out -> "sptr"
; peRecordType : BYTE* in/out -> "sptr"
; plsnUndoNext : CLS_LSN* in/out -> "sptr"
; plsnPrevious : CLS_LSN* in/out -> "sptr"
; ppvReadContext : void** in/out -> "sptr"
; pOverlapped : OVERLAPPED* in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。

出力引数:

; BOOL ReadLogRecord(void* pvMarshal, CLS_LSN* plsnFirst, CLFS_CONTEXT_MODE eContextMode, void** ppvReadBuffer, DWORD* pcbReadBuffer, BYTE* peRecordType, CLS_LSN* plsnUndoNext, CLS_LSN* plsnPrevious, void** ppvReadContext, OVERLAPPED* pOverlapped)
#uselib "clfsw32.dll"
#cfunc global ReadLogRecord "ReadLogRecord" intptr, var, int, intptr, var, var, var, var, intptr, var
; res = ReadLogRecord(pvMarshal, plsnFirst, eContextMode, ppvReadBuffer, pcbReadBuffer, peRecordType, plsnUndoNext, plsnPrevious, ppvReadContext, pOverlapped)
; pvMarshal : void* in/out -> "intptr"
; plsnFirst : CLS_LSN* in/out -> "var"
; eContextMode : CLFS_CONTEXT_MODE -> "int"
; ppvReadBuffer : void** in/out -> "intptr"
; pcbReadBuffer : DWORD* in/out -> "var"
; peRecordType : BYTE* in/out -> "var"
; plsnUndoNext : CLS_LSN* in/out -> "var"
; plsnPrevious : CLS_LSN* in/out -> "var"
; ppvReadContext : void** in/out -> "intptr"
; pOverlapped : OVERLAPPED* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; BOOL ReadLogRecord(void* pvMarshal, CLS_LSN* plsnFirst, CLFS_CONTEXT_MODE eContextMode, void** ppvReadBuffer, DWORD* pcbReadBuffer, BYTE* peRecordType, CLS_LSN* plsnUndoNext, CLS_LSN* plsnPrevious, void** ppvReadContext, OVERLAPPED* pOverlapped)
#uselib "clfsw32.dll"
#cfunc global ReadLogRecord "ReadLogRecord" intptr, intptr, int, intptr, intptr, intptr, intptr, intptr, intptr, intptr
; res = ReadLogRecord(pvMarshal, varptr(plsnFirst), eContextMode, ppvReadBuffer, varptr(pcbReadBuffer), varptr(peRecordType), varptr(plsnUndoNext), varptr(plsnPrevious), ppvReadContext, varptr(pOverlapped))
; pvMarshal : void* in/out -> "intptr"
; plsnFirst : CLS_LSN* in/out -> "intptr"
; eContextMode : CLFS_CONTEXT_MODE -> "int"
; ppvReadBuffer : void** in/out -> "intptr"
; pcbReadBuffer : DWORD* in/out -> "intptr"
; peRecordType : BYTE* in/out -> "intptr"
; plsnUndoNext : CLS_LSN* in/out -> "intptr"
; plsnPrevious : CLS_LSN* in/out -> "intptr"
; ppvReadContext : void** in/out -> "intptr"
; pOverlapped : OVERLAPPED* in/out -> "intptr"
; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。

import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	clfsw32 = windows.NewLazySystemDLL("clfsw32.dll")
	procReadLogRecord = clfsw32.NewProc("ReadLogRecord")
)

// pvMarshal (void* in/out), plsnFirst (CLS_LSN* in/out), eContextMode (CLFS_CONTEXT_MODE), ppvReadBuffer (void** in/out), pcbReadBuffer (DWORD* in/out), peRecordType (BYTE* in/out), plsnUndoNext (CLS_LSN* in/out), plsnPrevious (CLS_LSN* in/out), ppvReadContext (void** in/out), pOverlapped (OVERLAPPED* in/out)
r1, _, err := procReadLogRecord.Call(
	uintptr(pvMarshal),
	uintptr(plsnFirst),
	uintptr(eContextMode),
	uintptr(ppvReadBuffer),
	uintptr(pcbReadBuffer),
	uintptr(peRecordType),
	uintptr(plsnUndoNext),
	uintptr(plsnPrevious),
	uintptr(ppvReadContext),
	uintptr(pOverlapped),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL

function ReadLogRecord(
  pvMarshal: Pointer;   // void* in/out
  plsnFirst: Pointer;   // CLS_LSN* in/out
  eContextMode: Integer;   // CLFS_CONTEXT_MODE
  ppvReadBuffer: Pointer;   // void** in/out
  pcbReadBuffer: Pointer;   // DWORD* in/out
  peRecordType: Pointer;   // BYTE* in/out
  plsnUndoNext: Pointer;   // CLS_LSN* in/out
  plsnPrevious: Pointer;   // CLS_LSN* in/out
  ppvReadContext: Pointer;   // void** in/out
  pOverlapped: Pointer   // OVERLAPPED* in/out
): BOOL; stdcall;
  external 'clfsw32.dll' name 'ReadLogRecord';

result := DllCall("clfsw32\ReadLogRecord"
    , "Ptr", pvMarshal   ; void* in/out
    , "Ptr", plsnFirst   ; CLS_LSN* in/out
    , "Int", eContextMode   ; CLFS_CONTEXT_MODE
    , "Ptr", ppvReadBuffer   ; void** in/out
    , "Ptr", pcbReadBuffer   ; DWORD* in/out
    , "Ptr", peRecordType   ; BYTE* in/out
    , "Ptr", plsnUndoNext   ; CLS_LSN* in/out
    , "Ptr", plsnPrevious   ; CLS_LSN* in/out
    , "Ptr", ppvReadContext   ; void** in/out
    , "Ptr", pOverlapped   ; OVERLAPPED* in/out
    , "Int")   ; return: BOOL

●ReadLogRecord(pvMarshal, plsnFirst, eContextMode, ppvReadBuffer, pcbReadBuffer, peRecordType, plsnUndoNext, plsnPrevious, ppvReadContext, pOverlapped) = DLL("clfsw32.dll", "bool ReadLogRecord(void*, void*, int, void*, void*, void*, void*, void*, void*, void*)")
# 呼び出し: ReadLogRecord(pvMarshal, plsnFirst, eContextMode, ppvReadBuffer, pcbReadBuffer, peRecordType, plsnUndoNext, plsnPrevious, ppvReadContext, pOverlapped)
# pvMarshal : void* in/out -> "void*"
# plsnFirst : CLS_LSN* in/out -> "void*"
# eContextMode : CLFS_CONTEXT_MODE -> "int"
# ppvReadBuffer : void** in/out -> "void*"
# pcbReadBuffer : DWORD* in/out -> "void*"
# peRecordType : BYTE* in/out -> "void*"
# plsnUndoNext : CLS_LSN* in/out -> "void*"
# plsnPrevious : CLS_LSN* in/out -> "void*"
# ppvReadContext : void** in/out -> "void*"
# pOverlapped : OVERLAPPED* in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。

const std = @import("std");

extern "clfsw32" fn ReadLogRecord(
    pvMarshal: ?*anyopaque, // void* in/out
    plsnFirst: [*c]CLS_LSN, // CLS_LSN* in/out
    eContextMode: i32, // CLFS_CONTEXT_MODE
    ppvReadBuffer: ?*anyopaque, // void** in/out
    pcbReadBuffer: [*c]u32, // DWORD* in/out
    peRecordType: [*c]u8, // BYTE* in/out
    plsnUndoNext: [*c]CLS_LSN, // CLS_LSN* in/out
    plsnPrevious: [*c]CLS_LSN, // CLS_LSN* in/out
    ppvReadContext: ?*anyopaque, // void** in/out
    pOverlapped: [*c]OVERLAPPED // OVERLAPPED* in/out
) callconv(std.os.windows.WINAPI) i32;

proc ReadLogRecord(
    pvMarshal: pointer,  # void* in/out
    plsnFirst: ptr CLS_LSN,  # CLS_LSN* in/out
    eContextMode: int32,  # CLFS_CONTEXT_MODE
    ppvReadBuffer: pointer,  # void** in/out
    pcbReadBuffer: ptr uint32,  # DWORD* in/out
    peRecordType: ptr uint8,  # BYTE* in/out
    plsnUndoNext: ptr CLS_LSN,  # CLS_LSN* in/out
    plsnPrevious: ptr CLS_LSN,  # CLS_LSN* in/out
    ppvReadContext: pointer,  # void** in/out
    pOverlapped: ptr OVERLAPPED  # OVERLAPPED* in/out
): int32 {.importc: "ReadLogRecord", stdcall, dynlib: "clfsw32.dll".}

pragma(lib, "clfsw32");
extern(Windows)
int ReadLogRecord(
    void* pvMarshal,   // void* in/out
    CLS_LSN* plsnFirst,   // CLS_LSN* in/out
    int eContextMode,   // CLFS_CONTEXT_MODE
    void** ppvReadBuffer,   // void** in/out
    uint* pcbReadBuffer,   // DWORD* in/out
    ubyte* peRecordType,   // BYTE* in/out
    CLS_LSN* plsnUndoNext,   // CLS_LSN* in/out
    CLS_LSN* plsnPrevious,   // CLS_LSN* in/out
    void** ppvReadContext,   // void** in/out
    OVERLAPPED* pOverlapped   // OVERLAPPED* in/out
);

ccall((:ReadLogRecord, "clfsw32.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Ptr{CLS_LSN}, Int32, Ptr{Cvoid}, Ptr{UInt32}, Ptr{UInt8}, Ptr{CLS_LSN}, Ptr{CLS_LSN}, Ptr{Cvoid}, Ptr{OVERLAPPED}),
      pvMarshal, plsnFirst, eContextMode, ppvReadBuffer, pcbReadBuffer, peRecordType, plsnUndoNext, plsnPrevious, ppvReadContext, pOverlapped)
# pvMarshal : void* in/out -> Ptr{Cvoid}
# plsnFirst : CLS_LSN* in/out -> Ptr{CLS_LSN}
# eContextMode : CLFS_CONTEXT_MODE -> Int32
# ppvReadBuffer : void** in/out -> Ptr{Cvoid}
# pcbReadBuffer : DWORD* in/out -> Ptr{UInt32}
# peRecordType : BYTE* in/out -> Ptr{UInt8}
# plsnUndoNext : CLS_LSN* in/out -> Ptr{CLS_LSN}
# plsnPrevious : CLS_LSN* in/out -> Ptr{CLS_LSN}
# ppvReadContext : void** in/out -> Ptr{Cvoid}
# pOverlapped : OVERLAPPED* in/out -> Ptr{OVERLAPPED}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。

local ffi = require("ffi")
ffi.cdef[[
int32_t ReadLogRecord(
    void* pvMarshal,
    void* plsnFirst,
    int32_t eContextMode,
    void** ppvReadBuffer,
    uint32_t* pcbReadBuffer,
    uint8_t* peRecordType,
    void* plsnUndoNext,
    void* plsnPrevious,
    void** ppvReadContext,
    void* pOverlapped);
]]
local clfsw32 = ffi.load("clfsw32")
-- clfsw32.ReadLogRecord(pvMarshal, plsnFirst, eContextMode, ppvReadBuffer, pcbReadBuffer, peRecordType, plsnUndoNext, plsnPrevious, ppvReadContext, pOverlapped)
-- pvMarshal : void* in/out
-- plsnFirst : CLS_LSN* in/out
-- eContextMode : CLFS_CONTEXT_MODE
-- ppvReadBuffer : void** in/out
-- pcbReadBuffer : DWORD* in/out
-- peRecordType : BYTE* in/out
-- plsnUndoNext : CLS_LSN* in/out
-- plsnPrevious : CLS_LSN* in/out
-- ppvReadContext : void** in/out
-- pOverlapped : OVERLAPPED* in/out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。

const koffi = require('koffi');
const lib = koffi.load('clfsw32.dll');
const ReadLogRecord = lib.func('__stdcall', 'ReadLogRecord', 'int32_t', ['void *', 'void *', 'int32_t', 'void *', 'uint32_t *', 'uint8_t *', 'void *', 'void *', 'void *', 'void *']);
// ReadLogRecord(pvMarshal, plsnFirst, eContextMode, ppvReadBuffer, pcbReadBuffer, peRecordType, plsnUndoNext, plsnPrevious, ppvReadContext, pOverlapped)
// pvMarshal : void* in/out -> 'void *'
// plsnFirst : CLS_LSN* in/out -> 'void *'
// eContextMode : CLFS_CONTEXT_MODE -> 'int32_t'
// ppvReadBuffer : void** in/out -> 'void *'
// pcbReadBuffer : DWORD* in/out -> 'uint32_t *'
// peRecordType : BYTE* in/out -> 'uint8_t *'
// plsnUndoNext : CLS_LSN* in/out -> 'void *'
// plsnPrevious : CLS_LSN* in/out -> 'void *'
// ppvReadContext : void** in/out -> 'void *'
// pOverlapped : OVERLAPPED* in/out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。

const lib = Deno.dlopen("clfsw32.dll", {
  ReadLogRecord: { parameters: ["pointer", "pointer", "i32", "pointer", "pointer", "pointer", "pointer", "pointer", "pointer", "pointer"], result: "i32" },
});
// lib.symbols.ReadLogRecord(pvMarshal, plsnFirst, eContextMode, ppvReadBuffer, pcbReadBuffer, peRecordType, plsnUndoNext, plsnPrevious, ppvReadContext, pOverlapped)
// pvMarshal : void* in/out -> "pointer"
// plsnFirst : CLS_LSN* in/out -> "pointer"
// eContextMode : CLFS_CONTEXT_MODE -> "i32"
// ppvReadBuffer : void** in/out -> "pointer"
// pcbReadBuffer : DWORD* in/out -> "pointer"
// peRecordType : BYTE* in/out -> "pointer"
// plsnUndoNext : CLS_LSN* in/out -> "pointer"
// plsnPrevious : CLS_LSN* in/out -> "pointer"
// ppvReadContext : void** in/out -> "pointer"
// pOverlapped : OVERLAPPED* in/out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。

<?php
$ffi = FFI::cdef(<<<C
int32_t ReadLogRecord(
    void* pvMarshal,
    void* plsnFirst,
    int32_t eContextMode,
    void** ppvReadBuffer,
    uint32_t* pcbReadBuffer,
    uint8_t* peRecordType,
    void* plsnUndoNext,
    void* plsnPrevious,
    void** ppvReadContext,
    void* pOverlapped);
C, "clfsw32.dll");
// $ffi->ReadLogRecord(pvMarshal, plsnFirst, eContextMode, ppvReadBuffer, pcbReadBuffer, peRecordType, plsnUndoNext, plsnPrevious, ppvReadContext, pOverlapped);
// pvMarshal : void* in/out
// plsnFirst : CLS_LSN* in/out
// eContextMode : CLFS_CONTEXT_MODE
// ppvReadBuffer : void** in/out
// pcbReadBuffer : DWORD* in/out
// peRecordType : BYTE* in/out
// plsnUndoNext : CLS_LSN* in/out
// plsnPrevious : CLS_LSN* in/out
// ppvReadContext : void** in/out
// pOverlapped : OVERLAPPED* 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 Clfsw32 extends StdCallLibrary {
    Clfsw32 INSTANCE = Native.load("clfsw32", Clfsw32.class);
    boolean ReadLogRecord(
        Pointer pvMarshal,   // void* in/out
        Pointer plsnFirst,   // CLS_LSN* in/out
        int eContextMode,   // CLFS_CONTEXT_MODE
        Pointer ppvReadBuffer,   // void** in/out
        IntByReference pcbReadBuffer,   // DWORD* in/out
        byte[] peRecordType,   // BYTE* in/out
        Pointer plsnUndoNext,   // CLS_LSN* in/out
        Pointer plsnPrevious,   // CLS_LSN* in/out
        Pointer ppvReadContext,   // void** in/out
        Pointer pOverlapped   // OVERLAPPED* in/out
    );
}

@[Link("clfsw32")]
lib Libclfsw32
  fun ReadLogRecord = ReadLogRecord(
    pvMarshal : Void*,   # void* in/out
    plsnFirst : CLS_LSN*,   # CLS_LSN* in/out
    eContextMode : Int32,   # CLFS_CONTEXT_MODE
    ppvReadBuffer : Void**,   # void** in/out
    pcbReadBuffer : UInt32*,   # DWORD* in/out
    peRecordType : UInt8*,   # BYTE* in/out
    plsnUndoNext : CLS_LSN*,   # CLS_LSN* in/out
    plsnPrevious : CLS_LSN*,   # CLS_LSN* in/out
    ppvReadContext : Void**,   # void** in/out
    pOverlapped : OVERLAPPED*   # OVERLAPPED* 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 ReadLogRecordNative = Int32 Function(Pointer<Void>, Pointer<Void>, Int32, Pointer<Void>, Pointer<Uint32>, Pointer<Uint8>, Pointer<Void>, Pointer<Void>, Pointer<Void>, Pointer<Void>);
typedef ReadLogRecordDart = int Function(Pointer<Void>, Pointer<Void>, int, Pointer<Void>, Pointer<Uint32>, Pointer<Uint8>, Pointer<Void>, Pointer<Void>, Pointer<Void>, Pointer<Void>);
final ReadLogRecord = DynamicLibrary.open('clfsw32.dll')
    .lookupFunction<ReadLogRecordNative, ReadLogRecordDart>('ReadLogRecord');
// pvMarshal : void* in/out -> Pointer<Void>
// plsnFirst : CLS_LSN* in/out -> Pointer<Void>
// eContextMode : CLFS_CONTEXT_MODE -> Int32
// ppvReadBuffer : void** in/out -> Pointer<Void>
// pcbReadBuffer : DWORD* in/out -> Pointer<Uint32>
// peRecordType : BYTE* in/out -> Pointer<Uint8>
// plsnUndoNext : CLS_LSN* in/out -> Pointer<Void>
// plsnPrevious : CLS_LSN* in/out -> Pointer<Void>
// ppvReadContext : void** in/out -> Pointer<Void>
// pOverlapped : OVERLAPPED* in/out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。

{$mode objfpc}{$H+}
function ReadLogRecord(
  pvMarshal: Pointer;   // void* in/out
  plsnFirst: Pointer;   // CLS_LSN* in/out
  eContextMode: Integer;   // CLFS_CONTEXT_MODE
  ppvReadBuffer: Pointer;   // void** in/out
  pcbReadBuffer: Pointer;   // DWORD* in/out
  peRecordType: Pointer;   // BYTE* in/out
  plsnUndoNext: Pointer;   // CLS_LSN* in/out
  plsnPrevious: Pointer;   // CLS_LSN* in/out
  ppvReadContext: Pointer;   // void** in/out
  pOverlapped: Pointer   // OVERLAPPED* in/out
): BOOL; stdcall;
  external 'clfsw32.dll' name 'ReadLogRecord';

import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "ReadLogRecord"
  c_ReadLogRecord :: Ptr () -> Ptr () -> Int32 -> Ptr () -> Ptr Word32 -> Ptr Word8 -> Ptr () -> Ptr () -> Ptr () -> Ptr () -> IO CInt
-- pvMarshal : void* in/out -> Ptr ()
-- plsnFirst : CLS_LSN* in/out -> Ptr ()
-- eContextMode : CLFS_CONTEXT_MODE -> Int32
-- ppvReadBuffer : void** in/out -> Ptr ()
-- pcbReadBuffer : DWORD* in/out -> Ptr Word32
-- peRecordType : BYTE* in/out -> Ptr Word8
-- plsnUndoNext : CLS_LSN* in/out -> Ptr ()
-- plsnPrevious : CLS_LSN* in/out -> Ptr ()
-- ppvReadContext : void** in/out -> Ptr ()
-- pOverlapped : OVERLAPPED* in/out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。

open Ctypes
open Foreign

let readlogrecord =
  foreign "ReadLogRecord"
    ((ptr void) @-> (ptr void) @-> int32_t @-> (ptr void) @-> (ptr uint32_t) @-> (ptr uint8_t) @-> (ptr void) @-> (ptr void) @-> (ptr void) @-> (ptr void) @-> returning int32_t)
(* pvMarshal : void* in/out -> (ptr void) *)
(* plsnFirst : CLS_LSN* in/out -> (ptr void) *)
(* eContextMode : CLFS_CONTEXT_MODE -> int32_t *)
(* ppvReadBuffer : void** in/out -> (ptr void) *)
(* pcbReadBuffer : DWORD* in/out -> (ptr uint32_t) *)
(* peRecordType : BYTE* in/out -> (ptr uint8_t) *)
(* plsnUndoNext : CLS_LSN* in/out -> (ptr void) *)
(* plsnPrevious : CLS_LSN* in/out -> (ptr void) *)
(* ppvReadContext : void** in/out -> (ptr void) *)
(* pOverlapped : OVERLAPPED* in/out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)

(cffi:define-foreign-library clfsw32 (t "clfsw32.dll"))
(cffi:use-foreign-library clfsw32)

(cffi:defcfun ("ReadLogRecord" read-log-record :convention :stdcall) :int32
  (pv-marshal :pointer)   ; void* in/out
  (plsn-first :pointer)   ; CLS_LSN* in/out
  (e-context-mode :int32)   ; CLFS_CONTEXT_MODE
  (ppv-read-buffer :pointer)   ; void** in/out
  (pcb-read-buffer :pointer)   ; DWORD* in/out
  (pe-record-type :pointer)   ; BYTE* in/out
  (plsn-undo-next :pointer)   ; CLS_LSN* in/out
  (plsn-previous :pointer)   ; CLS_LSN* in/out
  (ppv-read-context :pointer)   ; void** in/out
  (p-overlapped :pointer))   ; OVERLAPPED* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。

use Win32::API;
my $ReadLogRecord = Win32::API::More->new('clfsw32',
    'BOOL ReadLogRecord(LPVOID pvMarshal, LPVOID plsnFirst, int eContextMode, LPVOID ppvReadBuffer, LPVOID pcbReadBuffer, LPVOID peRecordType, LPVOID plsnUndoNext, LPVOID plsnPrevious, LPVOID ppvReadContext, LPVOID pOverlapped)');
# my $ret = $ReadLogRecord->Call($pvMarshal, $plsnFirst, $eContextMode, $ppvReadBuffer, $pcbReadBuffer, $peRecordType, $plsnUndoNext, $plsnPrevious, $ppvReadContext, $pOverlapped);
# pvMarshal : void* in/out -> LPVOID
# plsnFirst : CLS_LSN* in/out -> LPVOID
# eContextMode : CLFS_CONTEXT_MODE -> int
# ppvReadBuffer : void** in/out -> LPVOID
# pcbReadBuffer : DWORD* in/out -> LPVOID
# peRecordType : BYTE* in/out -> LPVOID
# plsnUndoNext : CLS_LSN* in/out -> LPVOID
# plsnPrevious : CLS_LSN* in/out -> LPVOID
# ppvReadContext : void** in/out -> LPVOID
# pOverlapped : OVERLAPPED* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

ReadLogRecord

シグネチャ

パラメーター

公式ドキュメント

戻り値

解説(Remarks)

各言語での呼び出し定義

関連項目