ホーム › Storage.FileSystem › ReadNextLogRecord

ReadNextLogRecord

関数

CLFSログの読み取りコンテキストで次のレコードを取得する。

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

シグネチャ

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

BOOL ReadNextLogRecord(
    void* pvReadContext,
    void** ppvBuffer,
    DWORD* pcbBuffer,
    BYTE* peRecordType,
    CLS_LSN* plsnUser,
    CLS_LSN* plsnUndoNext,
    CLS_LSN* plsnPrevious,
    CLS_LSN* plsnRecord,
    OVERLAPPED* pOverlapped
);

パラメーター

名前

型

方向

説明

pvReadContext

void*

inout

ReadLogRecord または ReadLogRestartArea の呼び出しが成功した際に、システムが割り当てて作成する読み取りコンテキストへのポインターです。

関数が操作の完了を遅延させる場合、有効な読み取りコンテキストへのポインターと、エラー状態 ERROR_IO_PENDING を返します。非同期完了の処理については、本トピックの「解説」セクションを参照してください。

ppvBuffer

void**

inout

読み取ったデータへのポインターを受け取る変数へのポインターです。

pcbBuffer

DWORD*

inout

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

peRecordType

BYTE*

inout

入力時には次に読み取るレコードのレコード型フィルターを指定し、出力時には返されたレコード型を指定するポインターです。

クライアントは以下のいずれかのレコード型を指定できます。

値	意味
ClfsDataRecord	ユーザーデータレコードのみが読み取られます。
ClfsRestartRecord	再開レコードのみが読み取られます。
ClfsClientRecord	すべての再開レコードおよびデータレコードが読み取られます。

plsnUser

CLS_LSN*

inout

次のレコードへ進む読み取り、前の LSN の読み取り、または次の undo LSN の読み取りを行う代わりに、ログクライアントがこのログシーケンス番号(LSN)を次の LSN として読み取ることを指定する CLFS_LSN 構造体へのポインターです。

このパラメーターにより、ログクライアントはクライアントバッファー内のユーザー定義 LSN チェーンをカーソルで移動できます。このパラメーターと読み取りコンテキストが保持する現在の LSN との関係は、ReadLogRecord のエントリポイントで指定されるコンテキストモード ecxMode と一致している必要があります。一致しない場合、エラーコード ERROR_INVALID_PARAMETER が返されます。

plsnUndoNext

CLS_LSN*

inout

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

plsnPrevious

CLS_LSN*

inout

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

plsnRecord

CLS_LSN*

inout

読み取りコンテキストに読み込まれた現在のレコードの LSN を受け取る CLFS_LSN 構造体へのポインターです。

pOverlapped

OVERLAPPED*

inout

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

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

戻り値の型: BOOL

公式ドキュメント

ReadLogRecord または ReadLogRestartArea の呼び出しによって開始されたシーケンス内の次のレコードを読み取ります。

戻り値

関数が成功すると、戻り値は 0 以外になります。

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

以下のリストは、発生し得るエラーコードを示しています。

解説(Remarks)

ReadNextLogRecord が状態コード ERROR_IO_PENDING を返した場合、クライアントは GetOverlappedResult、または待機関数のいずれかを使用して、オーバーラップ I/O 操作の遅延完了と自身の実行を同期する必要があります。詳細については、同期とオーバーラップ入出力を参照してください。

ReadNextLogRecord が非同期に完了した後、要求されたレコードはディスクから読み取られますが、*ppvReadBuffer 内のポインターには解決されません。レコードへの有効なポインターを取得するには、クライアントは ReadNextLogRecord をもう一度呼び出す必要があります。

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

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

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

各言語での呼び出し定義

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

BOOL ReadNextLogRecord(
    void* pvReadContext,
    void** ppvBuffer,
    DWORD* pcbBuffer,
    BYTE* peRecordType,
    CLS_LSN* plsnUser,
    CLS_LSN* plsnUndoNext,
    CLS_LSN* plsnPrevious,
    CLS_LSN* plsnRecord,
    OVERLAPPED* pOverlapped
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("clfsw32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool ReadNextLogRecord(
    IntPtr pvReadContext,   // void* in/out
    IntPtr ppvBuffer,   // void** in/out
    ref uint pcbBuffer,   // DWORD* in/out
    IntPtr peRecordType,   // BYTE* in/out
    IntPtr plsnUser,   // CLS_LSN* in/out
    IntPtr plsnUndoNext,   // CLS_LSN* in/out
    IntPtr plsnPrevious,   // CLS_LSN* in/out
    IntPtr plsnRecord,   // CLS_LSN* in/out
    IntPtr pOverlapped   // OVERLAPPED* in/out
);

<DllImport("clfsw32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function ReadNextLogRecord(
    pvReadContext As IntPtr,   ' void* in/out
    ppvBuffer As IntPtr,   ' void** in/out
    ByRef pcbBuffer As UInteger,   ' DWORD* in/out
    peRecordType As IntPtr,   ' BYTE* in/out
    plsnUser As IntPtr,   ' CLS_LSN* in/out
    plsnUndoNext As IntPtr,   ' CLS_LSN* in/out
    plsnPrevious As IntPtr,   ' CLS_LSN* in/out
    plsnRecord As IntPtr,   ' CLS_LSN* in/out
    pOverlapped As IntPtr   ' OVERLAPPED* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' pvReadContext : void* in/out
' ppvBuffer : void** in/out
' pcbBuffer : DWORD* in/out
' peRecordType : BYTE* in/out
' plsnUser : CLS_LSN* in/out
' plsnUndoNext : CLS_LSN* in/out
' plsnPrevious : CLS_LSN* in/out
' plsnRecord : CLS_LSN* in/out
' pOverlapped : OVERLAPPED* in/out
Declare PtrSafe Function ReadNextLogRecord Lib "clfsw32" ( _
    ByVal pvReadContext As LongPtr, _
    ByVal ppvBuffer As LongPtr, _
    ByRef pcbBuffer As Long, _
    ByVal peRecordType As LongPtr, _
    ByVal plsnUser As LongPtr, _
    ByVal plsnUndoNext As LongPtr, _
    ByVal plsnPrevious As LongPtr, _
    ByVal plsnRecord 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

ReadNextLogRecord = ctypes.windll.clfsw32.ReadNextLogRecord
ReadNextLogRecord.restype = wintypes.BOOL
ReadNextLogRecord.argtypes = [
    ctypes.POINTER(None),  # pvReadContext : void* in/out
    ctypes.c_void_p,  # ppvBuffer : void** in/out
    ctypes.POINTER(wintypes.DWORD),  # pcbBuffer : DWORD* in/out
    ctypes.POINTER(ctypes.c_ubyte),  # peRecordType : BYTE* in/out
    ctypes.c_void_p,  # plsnUser : CLS_LSN* in/out
    ctypes.c_void_p,  # plsnUndoNext : CLS_LSN* in/out
    ctypes.c_void_p,  # plsnPrevious : CLS_LSN* in/out
    ctypes.c_void_p,  # plsnRecord : CLS_LSN* 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')
ReadNextLogRecord = Fiddle::Function.new(
  lib['ReadNextLogRecord'],
  [
    Fiddle::TYPE_VOIDP,  # pvReadContext : void* in/out
    Fiddle::TYPE_VOIDP,  # ppvBuffer : void** in/out
    Fiddle::TYPE_VOIDP,  # pcbBuffer : DWORD* in/out
    Fiddle::TYPE_VOIDP,  # peRecordType : BYTE* in/out
    Fiddle::TYPE_VOIDP,  # plsnUser : CLS_LSN* in/out
    Fiddle::TYPE_VOIDP,  # plsnUndoNext : CLS_LSN* in/out
    Fiddle::TYPE_VOIDP,  # plsnPrevious : CLS_LSN* in/out
    Fiddle::TYPE_VOIDP,  # plsnRecord : CLS_LSN* in/out
    Fiddle::TYPE_VOIDP,  # pOverlapped : OVERLAPPED* in/out
  ],
  Fiddle::TYPE_INT)

#[link(name = "clfsw32")]
extern "system" {
    fn ReadNextLogRecord(
        pvReadContext: *mut (),  // void* in/out
        ppvBuffer: *mut *mut (),  // void** in/out
        pcbBuffer: *mut u32,  // DWORD* in/out
        peRecordType: *mut u8,  // BYTE* in/out
        plsnUser: *mut CLS_LSN,  // CLS_LSN* in/out
        plsnUndoNext: *mut CLS_LSN,  // CLS_LSN* in/out
        plsnPrevious: *mut CLS_LSN,  // CLS_LSN* in/out
        plsnRecord: *mut CLS_LSN,  // CLS_LSN* 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 ReadNextLogRecord(IntPtr pvReadContext, IntPtr ppvBuffer, ref uint pcbBuffer, IntPtr peRecordType, IntPtr plsnUser, IntPtr plsnUndoNext, IntPtr plsnPrevious, IntPtr plsnRecord, IntPtr pOverlapped);
"@
$api = Add-Type -MemberDefinition $sig -Name 'clfsw32_ReadNextLogRecord' -Namespace Win32 -PassThru
# $api::ReadNextLogRecord(pvReadContext, ppvBuffer, pcbBuffer, peRecordType, plsnUser, plsnUndoNext, plsnPrevious, plsnRecord, pOverlapped)

#uselib "clfsw32.dll"
#func global ReadNextLogRecord "ReadNextLogRecord" sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr
; ReadNextLogRecord pvReadContext, ppvBuffer, varptr(pcbBuffer), varptr(peRecordType), varptr(plsnUser), varptr(plsnUndoNext), varptr(plsnPrevious), varptr(plsnRecord), varptr(pOverlapped)   ; 戻り値は stat
; pvReadContext : void* in/out -> "sptr"
; ppvBuffer : void** in/out -> "sptr"
; pcbBuffer : DWORD* in/out -> "sptr"
; peRecordType : BYTE* in/out -> "sptr"
; plsnUser : CLS_LSN* in/out -> "sptr"
; plsnUndoNext : CLS_LSN* in/out -> "sptr"
; plsnPrevious : CLS_LSN* in/out -> "sptr"
; plsnRecord : CLS_LSN* in/out -> "sptr"
; pOverlapped : OVERLAPPED* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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

出力引数:

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

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

var (
	clfsw32 = windows.NewLazySystemDLL("clfsw32.dll")
	procReadNextLogRecord = clfsw32.NewProc("ReadNextLogRecord")
)

// pvReadContext (void* in/out), ppvBuffer (void** in/out), pcbBuffer (DWORD* in/out), peRecordType (BYTE* in/out), plsnUser (CLS_LSN* in/out), plsnUndoNext (CLS_LSN* in/out), plsnPrevious (CLS_LSN* in/out), plsnRecord (CLS_LSN* in/out), pOverlapped (OVERLAPPED* in/out)
r1, _, err := procReadNextLogRecord.Call(
	uintptr(pvReadContext),
	uintptr(ppvBuffer),
	uintptr(pcbBuffer),
	uintptr(peRecordType),
	uintptr(plsnUser),
	uintptr(plsnUndoNext),
	uintptr(plsnPrevious),
	uintptr(plsnRecord),
	uintptr(pOverlapped),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL

function ReadNextLogRecord(
  pvReadContext: Pointer;   // void* in/out
  ppvBuffer: Pointer;   // void** in/out
  pcbBuffer: Pointer;   // DWORD* in/out
  peRecordType: Pointer;   // BYTE* in/out
  plsnUser: Pointer;   // CLS_LSN* in/out
  plsnUndoNext: Pointer;   // CLS_LSN* in/out
  plsnPrevious: Pointer;   // CLS_LSN* in/out
  plsnRecord: Pointer;   // CLS_LSN* in/out
  pOverlapped: Pointer   // OVERLAPPED* in/out
): BOOL; stdcall;
  external 'clfsw32.dll' name 'ReadNextLogRecord';

result := DllCall("clfsw32\ReadNextLogRecord"
    , "Ptr", pvReadContext   ; void* in/out
    , "Ptr", ppvBuffer   ; void** in/out
    , "Ptr", pcbBuffer   ; DWORD* in/out
    , "Ptr", peRecordType   ; BYTE* in/out
    , "Ptr", plsnUser   ; CLS_LSN* in/out
    , "Ptr", plsnUndoNext   ; CLS_LSN* in/out
    , "Ptr", plsnPrevious   ; CLS_LSN* in/out
    , "Ptr", plsnRecord   ; CLS_LSN* in/out
    , "Ptr", pOverlapped   ; OVERLAPPED* in/out
    , "Int")   ; return: BOOL

●ReadNextLogRecord(pvReadContext, ppvBuffer, pcbBuffer, peRecordType, plsnUser, plsnUndoNext, plsnPrevious, plsnRecord, pOverlapped) = DLL("clfsw32.dll", "bool ReadNextLogRecord(void*, void*, void*, void*, void*, void*, void*, void*, void*)")
# 呼び出し: ReadNextLogRecord(pvReadContext, ppvBuffer, pcbBuffer, peRecordType, plsnUser, plsnUndoNext, plsnPrevious, plsnRecord, pOverlapped)
# pvReadContext : void* in/out -> "void*"
# ppvBuffer : void** in/out -> "void*"
# pcbBuffer : DWORD* in/out -> "void*"
# peRecordType : BYTE* in/out -> "void*"
# plsnUser : CLS_LSN* in/out -> "void*"
# plsnUndoNext : CLS_LSN* in/out -> "void*"
# plsnPrevious : CLS_LSN* in/out -> "void*"
# plsnRecord : CLS_LSN* in/out -> "void*"
# pOverlapped : OVERLAPPED* in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。

const std = @import("std");

extern "clfsw32" fn ReadNextLogRecord(
    pvReadContext: ?*anyopaque, // void* in/out
    ppvBuffer: ?*anyopaque, // void** in/out
    pcbBuffer: [*c]u32, // DWORD* in/out
    peRecordType: [*c]u8, // BYTE* in/out
    plsnUser: [*c]CLS_LSN, // CLS_LSN* in/out
    plsnUndoNext: [*c]CLS_LSN, // CLS_LSN* in/out
    plsnPrevious: [*c]CLS_LSN, // CLS_LSN* in/out
    plsnRecord: [*c]CLS_LSN, // CLS_LSN* in/out
    pOverlapped: [*c]OVERLAPPED // OVERLAPPED* in/out
) callconv(std.os.windows.WINAPI) i32;

proc ReadNextLogRecord(
    pvReadContext: pointer,  # void* in/out
    ppvBuffer: pointer,  # void** in/out
    pcbBuffer: ptr uint32,  # DWORD* in/out
    peRecordType: ptr uint8,  # BYTE* in/out
    plsnUser: ptr CLS_LSN,  # CLS_LSN* in/out
    plsnUndoNext: ptr CLS_LSN,  # CLS_LSN* in/out
    plsnPrevious: ptr CLS_LSN,  # CLS_LSN* in/out
    plsnRecord: ptr CLS_LSN,  # CLS_LSN* in/out
    pOverlapped: ptr OVERLAPPED  # OVERLAPPED* in/out
): int32 {.importc: "ReadNextLogRecord", stdcall, dynlib: "clfsw32.dll".}

pragma(lib, "clfsw32");
extern(Windows)
int ReadNextLogRecord(
    void* pvReadContext,   // void* in/out
    void** ppvBuffer,   // void** in/out
    uint* pcbBuffer,   // DWORD* in/out
    ubyte* peRecordType,   // BYTE* in/out
    CLS_LSN* plsnUser,   // CLS_LSN* in/out
    CLS_LSN* plsnUndoNext,   // CLS_LSN* in/out
    CLS_LSN* plsnPrevious,   // CLS_LSN* in/out
    CLS_LSN* plsnRecord,   // CLS_LSN* in/out
    OVERLAPPED* pOverlapped   // OVERLAPPED* in/out
);

ccall((:ReadNextLogRecord, "clfsw32.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Ptr{Cvoid}, Ptr{UInt32}, Ptr{UInt8}, Ptr{CLS_LSN}, Ptr{CLS_LSN}, Ptr{CLS_LSN}, Ptr{CLS_LSN}, Ptr{OVERLAPPED}),
      pvReadContext, ppvBuffer, pcbBuffer, peRecordType, plsnUser, plsnUndoNext, plsnPrevious, plsnRecord, pOverlapped)
# pvReadContext : void* in/out -> Ptr{Cvoid}
# ppvBuffer : void** in/out -> Ptr{Cvoid}
# pcbBuffer : DWORD* in/out -> Ptr{UInt32}
# peRecordType : BYTE* in/out -> Ptr{UInt8}
# plsnUser : CLS_LSN* in/out -> Ptr{CLS_LSN}
# plsnUndoNext : CLS_LSN* in/out -> Ptr{CLS_LSN}
# plsnPrevious : CLS_LSN* in/out -> Ptr{CLS_LSN}
# plsnRecord : CLS_LSN* in/out -> Ptr{CLS_LSN}
# pOverlapped : OVERLAPPED* in/out -> Ptr{OVERLAPPED}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。

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

const koffi = require('koffi');
const lib = koffi.load('clfsw32.dll');
const ReadNextLogRecord = lib.func('__stdcall', 'ReadNextLogRecord', 'int32_t', ['void *', 'void *', 'uint32_t *', 'uint8_t *', 'void *', 'void *', 'void *', 'void *', 'void *']);
// ReadNextLogRecord(pvReadContext, ppvBuffer, pcbBuffer, peRecordType, plsnUser, plsnUndoNext, plsnPrevious, plsnRecord, pOverlapped)
// pvReadContext : void* in/out -> 'void *'
// ppvBuffer : void** in/out -> 'void *'
// pcbBuffer : DWORD* in/out -> 'uint32_t *'
// peRecordType : BYTE* in/out -> 'uint8_t *'
// plsnUser : CLS_LSN* in/out -> 'void *'
// plsnUndoNext : CLS_LSN* in/out -> 'void *'
// plsnPrevious : CLS_LSN* in/out -> 'void *'
// plsnRecord : CLS_LSN* in/out -> 'void *'
// pOverlapped : OVERLAPPED* in/out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。

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

<?php
$ffi = FFI::cdef(<<<C
int32_t ReadNextLogRecord(
    void* pvReadContext,
    void** ppvBuffer,
    uint32_t* pcbBuffer,
    uint8_t* peRecordType,
    void* plsnUser,
    void* plsnUndoNext,
    void* plsnPrevious,
    void* plsnRecord,
    void* pOverlapped);
C, "clfsw32.dll");
// $ffi->ReadNextLogRecord(pvReadContext, ppvBuffer, pcbBuffer, peRecordType, plsnUser, plsnUndoNext, plsnPrevious, plsnRecord, pOverlapped);
// pvReadContext : void* in/out
// ppvBuffer : void** in/out
// pcbBuffer : DWORD* in/out
// peRecordType : BYTE* in/out
// plsnUser : CLS_LSN* in/out
// plsnUndoNext : CLS_LSN* in/out
// plsnPrevious : CLS_LSN* in/out
// plsnRecord : CLS_LSN* 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 ReadNextLogRecord(
        Pointer pvReadContext,   // void* in/out
        Pointer ppvBuffer,   // void** in/out
        IntByReference pcbBuffer,   // DWORD* in/out
        byte[] peRecordType,   // BYTE* in/out
        Pointer plsnUser,   // CLS_LSN* in/out
        Pointer plsnUndoNext,   // CLS_LSN* in/out
        Pointer plsnPrevious,   // CLS_LSN* in/out
        Pointer plsnRecord,   // CLS_LSN* in/out
        Pointer pOverlapped   // OVERLAPPED* in/out
    );
}

@[Link("clfsw32")]
lib Libclfsw32
  fun ReadNextLogRecord = ReadNextLogRecord(
    pvReadContext : Void*,   # void* in/out
    ppvBuffer : Void**,   # void** in/out
    pcbBuffer : UInt32*,   # DWORD* in/out
    peRecordType : UInt8*,   # BYTE* in/out
    plsnUser : CLS_LSN*,   # CLS_LSN* in/out
    plsnUndoNext : CLS_LSN*,   # CLS_LSN* in/out
    plsnPrevious : CLS_LSN*,   # CLS_LSN* in/out
    plsnRecord : CLS_LSN*,   # CLS_LSN* 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 ReadNextLogRecordNative = Int32 Function(Pointer<Void>, Pointer<Void>, Pointer<Uint32>, Pointer<Uint8>, Pointer<Void>, Pointer<Void>, Pointer<Void>, Pointer<Void>, Pointer<Void>);
typedef ReadNextLogRecordDart = int Function(Pointer<Void>, Pointer<Void>, Pointer<Uint32>, Pointer<Uint8>, Pointer<Void>, Pointer<Void>, Pointer<Void>, Pointer<Void>, Pointer<Void>);
final ReadNextLogRecord = DynamicLibrary.open('clfsw32.dll')
    .lookupFunction<ReadNextLogRecordNative, ReadNextLogRecordDart>('ReadNextLogRecord');
// pvReadContext : void* in/out -> Pointer<Void>
// ppvBuffer : void** in/out -> Pointer<Void>
// pcbBuffer : DWORD* in/out -> Pointer<Uint32>
// peRecordType : BYTE* in/out -> Pointer<Uint8>
// plsnUser : CLS_LSN* in/out -> Pointer<Void>
// plsnUndoNext : CLS_LSN* in/out -> Pointer<Void>
// plsnPrevious : CLS_LSN* in/out -> Pointer<Void>
// plsnRecord : CLS_LSN* in/out -> Pointer<Void>
// pOverlapped : OVERLAPPED* in/out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。

{$mode objfpc}{$H+}
function ReadNextLogRecord(
  pvReadContext: Pointer;   // void* in/out
  ppvBuffer: Pointer;   // void** in/out
  pcbBuffer: Pointer;   // DWORD* in/out
  peRecordType: Pointer;   // BYTE* in/out
  plsnUser: Pointer;   // CLS_LSN* in/out
  plsnUndoNext: Pointer;   // CLS_LSN* in/out
  plsnPrevious: Pointer;   // CLS_LSN* in/out
  plsnRecord: Pointer;   // CLS_LSN* in/out
  pOverlapped: Pointer   // OVERLAPPED* in/out
): BOOL; stdcall;
  external 'clfsw32.dll' name 'ReadNextLogRecord';

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

foreign import stdcall safe "ReadNextLogRecord"
  c_ReadNextLogRecord :: Ptr () -> Ptr () -> Ptr Word32 -> Ptr Word8 -> Ptr () -> Ptr () -> Ptr () -> Ptr () -> Ptr () -> IO CInt
-- pvReadContext : void* in/out -> Ptr ()
-- ppvBuffer : void** in/out -> Ptr ()
-- pcbBuffer : DWORD* in/out -> Ptr Word32
-- peRecordType : BYTE* in/out -> Ptr Word8
-- plsnUser : CLS_LSN* in/out -> Ptr ()
-- plsnUndoNext : CLS_LSN* in/out -> Ptr ()
-- plsnPrevious : CLS_LSN* in/out -> Ptr ()
-- plsnRecord : CLS_LSN* in/out -> Ptr ()
-- pOverlapped : OVERLAPPED* in/out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。

open Ctypes
open Foreign

let readnextlogrecord =
  foreign "ReadNextLogRecord"
    ((ptr void) @-> (ptr void) @-> (ptr uint32_t) @-> (ptr uint8_t) @-> (ptr void) @-> (ptr void) @-> (ptr void) @-> (ptr void) @-> (ptr void) @-> returning int32_t)
(* pvReadContext : void* in/out -> (ptr void) *)
(* ppvBuffer : void** in/out -> (ptr void) *)
(* pcbBuffer : DWORD* in/out -> (ptr uint32_t) *)
(* peRecordType : BYTE* in/out -> (ptr uint8_t) *)
(* plsnUser : CLS_LSN* in/out -> (ptr void) *)
(* plsnUndoNext : CLS_LSN* in/out -> (ptr void) *)
(* plsnPrevious : CLS_LSN* in/out -> (ptr void) *)
(* plsnRecord : CLS_LSN* 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 ("ReadNextLogRecord" read-next-log-record :convention :stdcall) :int32
  (pv-read-context :pointer)   ; void* in/out
  (ppv-buffer :pointer)   ; void** in/out
  (pcb-buffer :pointer)   ; DWORD* in/out
  (pe-record-type :pointer)   ; BYTE* in/out
  (plsn-user :pointer)   ; CLS_LSN* in/out
  (plsn-undo-next :pointer)   ; CLS_LSN* in/out
  (plsn-previous :pointer)   ; CLS_LSN* in/out
  (plsn-record :pointer)   ; CLS_LSN* in/out
  (p-overlapped :pointer))   ; OVERLAPPED* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。

use Win32::API;
my $ReadNextLogRecord = Win32::API::More->new('clfsw32',
    'BOOL ReadNextLogRecord(LPVOID pvReadContext, LPVOID ppvBuffer, LPVOID pcbBuffer, LPVOID peRecordType, LPVOID plsnUser, LPVOID plsnUndoNext, LPVOID plsnPrevious, LPVOID plsnRecord, LPVOID pOverlapped)');
# my $ret = $ReadNextLogRecord->Call($pvReadContext, $ppvBuffer, $pcbBuffer, $peRecordType, $plsnUser, $plsnUndoNext, $plsnPrevious, $plsnRecord, $pOverlapped);
# pvReadContext : void* in/out -> LPVOID
# ppvBuffer : void** in/out -> LPVOID
# pcbBuffer : DWORD* in/out -> LPVOID
# peRecordType : BYTE* in/out -> LPVOID
# plsnUser : CLS_LSN* in/out -> LPVOID
# plsnUndoNext : CLS_LSN* in/out -> LPVOID
# plsnPrevious : CLS_LSN* in/out -> LPVOID
# plsnRecord : CLS_LSN* in/out -> LPVOID
# pOverlapped : OVERLAPPED* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

ReadNextLogRecord

シグネチャ

パラメーター

公式ドキュメント

戻り値

解説(Remarks)

各言語での呼び出し定義

関連項目