ホーム › Storage.FileSystem › WriteLogRestartArea

WriteLogRestartArea

関数

CLFSログにリスタート領域を書き込む。

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

シグネチャ

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

BOOL WriteLogRestartArea(
    void* pvMarshal,
    void* pvRestartBuffer,
    DWORD cbRestartBuffer,
    CLS_LSN* plsnBase,
    CLFS_FLAG fFlags,
    DWORD* pcbWritten,
    CLS_LSN* plsnNext,
    OVERLAPPED* pOverlapped
);

パラメーター

名前

型

方向

説明

pvMarshal

void*

inout

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

pvRestartBuffer

void*

inout

再開データを格納するバッファーへのポインターです。

cbRestartBuffer

DWORD

pvRestartBuffer のサイズ(バイト単位)です。

plsnBase

CLS_LSN*

inout

再開領域の書き込みに成功した後のログの新しいベース LSN を指定する CLFS_LSN 構造体へのポインターです。

この値はアクティブログの範囲外にすることはできません。現在のベース LSN の値以上で、かつ ReserveAndAppendLog への直近の呼び出しで lastLSN パラメーターに返された LSN 以下である必要があります。このオプションのパラメーターを省略した場合、ベース LSN は変更されません。

fFlags

CLFS_FLAG

この関数の動作を指定するフラグです。

次の値を 1 つ以上組み合わせて指定できます。

Value	Meaning
CLFS_FLAG_NO_FLAGS	フラグを割り当てません。
CLFS_FLAG_USE_RESERVATION	マーシャリング領域で予約された領域を使用して、現在のレコードを追加します。

pcbWritten

DWORD*

inout

操作の完了時に書き込まれたバイト数を受け取る変数へのポインターです。

plsnNext

CLS_LSN*

inout

書き込まれた再開領域の LSN を指定する CLFS_LSN 構造体へのポインターです。

pOverlapped

OVERLAPPED*

inout

OVERLAPPED 構造体へのポインターです。

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

戻り値の型: BOOL

公式ドキュメント

新しいクライアント再開領域(restart area)をログに追加し、必要に応じてログのベースログシーケンス番号(LSN)を進めます。

戻り値

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

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

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

解説(Remarks)

WriteLogRestartArea は、現在バッファーされているすべてのログレコードのフラッシュと、ログメタデータのフラッシュの両方を発生させます。

クライアントが、非同期操作をサポートするために作成されたログ(たとえば、ログの作成時に CreateLogFile の fFlagsAndAttributes パラメーターが FILE_FLAG_OVERLAPPED に設定されている場合)に対して WriteLogRestartArea を呼び出す場合、クライアントは WriteLogRestartArea の pOverlapped パラメーターに有効な OVERLAPPED 構造体へのポインターを指定する必要があります。

その場合、WriteLogRestartArea が ERROR_IO_PENDING エラーで失敗すると、ppvReadContext パラメーターが指す変数に、有効な読み取りコンテキストへのポインターが格納されます。

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

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

各言語での呼び出し定義

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

BOOL WriteLogRestartArea(
    void* pvMarshal,
    void* pvRestartBuffer,
    DWORD cbRestartBuffer,
    CLS_LSN* plsnBase,
    CLFS_FLAG fFlags,
    DWORD* pcbWritten,
    CLS_LSN* plsnNext,
    OVERLAPPED* pOverlapped
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("clfsw32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool WriteLogRestartArea(
    IntPtr pvMarshal,   // void* in/out
    IntPtr pvRestartBuffer,   // void* in/out
    uint cbRestartBuffer,   // DWORD
    IntPtr plsnBase,   // CLS_LSN* in/out
    uint fFlags,   // CLFS_FLAG
    ref uint pcbWritten,   // DWORD* in/out
    IntPtr plsnNext,   // CLS_LSN* in/out
    IntPtr pOverlapped   // OVERLAPPED* in/out
);

<DllImport("clfsw32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function WriteLogRestartArea(
    pvMarshal As IntPtr,   ' void* in/out
    pvRestartBuffer As IntPtr,   ' void* in/out
    cbRestartBuffer As UInteger,   ' DWORD
    plsnBase As IntPtr,   ' CLS_LSN* in/out
    fFlags As UInteger,   ' CLFS_FLAG
    ByRef pcbWritten As UInteger,   ' DWORD* in/out
    plsnNext As IntPtr,   ' CLS_LSN* in/out
    pOverlapped As IntPtr   ' OVERLAPPED* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' pvMarshal : void* in/out
' pvRestartBuffer : void* in/out
' cbRestartBuffer : DWORD
' plsnBase : CLS_LSN* in/out
' fFlags : CLFS_FLAG
' pcbWritten : DWORD* in/out
' plsnNext : CLS_LSN* in/out
' pOverlapped : OVERLAPPED* in/out
Declare PtrSafe Function WriteLogRestartArea Lib "clfsw32" ( _
    ByVal pvMarshal As LongPtr, _
    ByVal pvRestartBuffer As LongPtr, _
    ByVal cbRestartBuffer As Long, _
    ByVal plsnBase As LongPtr, _
    ByVal fFlags As Long, _
    ByRef pcbWritten As Long, _
    ByVal plsnNext 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

WriteLogRestartArea = ctypes.windll.clfsw32.WriteLogRestartArea
WriteLogRestartArea.restype = wintypes.BOOL
WriteLogRestartArea.argtypes = [
    ctypes.POINTER(None),  # pvMarshal : void* in/out
    ctypes.POINTER(None),  # pvRestartBuffer : void* in/out
    wintypes.DWORD,  # cbRestartBuffer : DWORD
    ctypes.c_void_p,  # plsnBase : CLS_LSN* in/out
    wintypes.DWORD,  # fFlags : CLFS_FLAG
    ctypes.POINTER(wintypes.DWORD),  # pcbWritten : DWORD* in/out
    ctypes.c_void_p,  # plsnNext : 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')
WriteLogRestartArea = Fiddle::Function.new(
  lib['WriteLogRestartArea'],
  [
    Fiddle::TYPE_VOIDP,  # pvMarshal : void* in/out
    Fiddle::TYPE_VOIDP,  # pvRestartBuffer : void* in/out
    -Fiddle::TYPE_INT,  # cbRestartBuffer : DWORD
    Fiddle::TYPE_VOIDP,  # plsnBase : CLS_LSN* in/out
    -Fiddle::TYPE_INT,  # fFlags : CLFS_FLAG
    Fiddle::TYPE_VOIDP,  # pcbWritten : DWORD* in/out
    Fiddle::TYPE_VOIDP,  # plsnNext : CLS_LSN* in/out
    Fiddle::TYPE_VOIDP,  # pOverlapped : OVERLAPPED* in/out
  ],
  Fiddle::TYPE_INT)

#[link(name = "clfsw32")]
extern "system" {
    fn WriteLogRestartArea(
        pvMarshal: *mut (),  // void* in/out
        pvRestartBuffer: *mut (),  // void* in/out
        cbRestartBuffer: u32,  // DWORD
        plsnBase: *mut CLS_LSN,  // CLS_LSN* in/out
        fFlags: u32,  // CLFS_FLAG
        pcbWritten: *mut u32,  // DWORD* in/out
        plsnNext: *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 WriteLogRestartArea(IntPtr pvMarshal, IntPtr pvRestartBuffer, uint cbRestartBuffer, IntPtr plsnBase, uint fFlags, ref uint pcbWritten, IntPtr plsnNext, IntPtr pOverlapped);
"@
$api = Add-Type -MemberDefinition $sig -Name 'clfsw32_WriteLogRestartArea' -Namespace Win32 -PassThru
# $api::WriteLogRestartArea(pvMarshal, pvRestartBuffer, cbRestartBuffer, plsnBase, fFlags, pcbWritten, plsnNext, pOverlapped)

#uselib "clfsw32.dll"
#func global WriteLogRestartArea "WriteLogRestartArea" sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr
; WriteLogRestartArea pvMarshal, pvRestartBuffer, cbRestartBuffer, varptr(plsnBase), fFlags, varptr(pcbWritten), varptr(plsnNext), varptr(pOverlapped)   ; 戻り値は stat
; pvMarshal : void* in/out -> "sptr"
; pvRestartBuffer : void* in/out -> "sptr"
; cbRestartBuffer : DWORD -> "sptr"
; plsnBase : CLS_LSN* in/out -> "sptr"
; fFlags : CLFS_FLAG -> "sptr"
; pcbWritten : DWORD* in/out -> "sptr"
; plsnNext : CLS_LSN* in/out -> "sptr"
; pOverlapped : OVERLAPPED* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "clfsw32.dll"
#cfunc global WriteLogRestartArea "WriteLogRestartArea" sptr, sptr, int, var, int, var, var, var
; res = WriteLogRestartArea(pvMarshal, pvRestartBuffer, cbRestartBuffer, plsnBase, fFlags, pcbWritten, plsnNext, pOverlapped)
; pvMarshal : void* in/out -> "sptr"
; pvRestartBuffer : void* in/out -> "sptr"
; cbRestartBuffer : DWORD -> "int"
; plsnBase : CLS_LSN* in/out -> "var"
; fFlags : CLFS_FLAG -> "int"
; pcbWritten : DWORD* in/out -> "var"
; plsnNext : CLS_LSN* in/out -> "var"
; pOverlapped : OVERLAPPED* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "clfsw32.dll"
#cfunc global WriteLogRestartArea "WriteLogRestartArea" sptr, sptr, int, sptr, int, sptr, sptr, sptr
; res = WriteLogRestartArea(pvMarshal, pvRestartBuffer, cbRestartBuffer, varptr(plsnBase), fFlags, varptr(pcbWritten), varptr(plsnNext), varptr(pOverlapped))
; pvMarshal : void* in/out -> "sptr"
; pvRestartBuffer : void* in/out -> "sptr"
; cbRestartBuffer : DWORD -> "int"
; plsnBase : CLS_LSN* in/out -> "sptr"
; fFlags : CLFS_FLAG -> "int"
; pcbWritten : DWORD* in/out -> "sptr"
; plsnNext : CLS_LSN* in/out -> "sptr"
; pOverlapped : OVERLAPPED* in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。

出力引数:

; BOOL WriteLogRestartArea(void* pvMarshal, void* pvRestartBuffer, DWORD cbRestartBuffer, CLS_LSN* plsnBase, CLFS_FLAG fFlags, DWORD* pcbWritten, CLS_LSN* plsnNext, OVERLAPPED* pOverlapped)
#uselib "clfsw32.dll"
#cfunc global WriteLogRestartArea "WriteLogRestartArea" intptr, intptr, int, var, int, var, var, var
; res = WriteLogRestartArea(pvMarshal, pvRestartBuffer, cbRestartBuffer, plsnBase, fFlags, pcbWritten, plsnNext, pOverlapped)
; pvMarshal : void* in/out -> "intptr"
; pvRestartBuffer : void* in/out -> "intptr"
; cbRestartBuffer : DWORD -> "int"
; plsnBase : CLS_LSN* in/out -> "var"
; fFlags : CLFS_FLAG -> "int"
; pcbWritten : DWORD* in/out -> "var"
; plsnNext : CLS_LSN* in/out -> "var"
; pOverlapped : OVERLAPPED* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; BOOL WriteLogRestartArea(void* pvMarshal, void* pvRestartBuffer, DWORD cbRestartBuffer, CLS_LSN* plsnBase, CLFS_FLAG fFlags, DWORD* pcbWritten, CLS_LSN* plsnNext, OVERLAPPED* pOverlapped)
#uselib "clfsw32.dll"
#cfunc global WriteLogRestartArea "WriteLogRestartArea" intptr, intptr, int, intptr, int, intptr, intptr, intptr
; res = WriteLogRestartArea(pvMarshal, pvRestartBuffer, cbRestartBuffer, varptr(plsnBase), fFlags, varptr(pcbWritten), varptr(plsnNext), varptr(pOverlapped))
; pvMarshal : void* in/out -> "intptr"
; pvRestartBuffer : void* in/out -> "intptr"
; cbRestartBuffer : DWORD -> "int"
; plsnBase : CLS_LSN* in/out -> "intptr"
; fFlags : CLFS_FLAG -> "int"
; pcbWritten : DWORD* in/out -> "intptr"
; plsnNext : 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")
	procWriteLogRestartArea = clfsw32.NewProc("WriteLogRestartArea")
)

// pvMarshal (void* in/out), pvRestartBuffer (void* in/out), cbRestartBuffer (DWORD), plsnBase (CLS_LSN* in/out), fFlags (CLFS_FLAG), pcbWritten (DWORD* in/out), plsnNext (CLS_LSN* in/out), pOverlapped (OVERLAPPED* in/out)
r1, _, err := procWriteLogRestartArea.Call(
	uintptr(pvMarshal),
	uintptr(pvRestartBuffer),
	uintptr(cbRestartBuffer),
	uintptr(plsnBase),
	uintptr(fFlags),
	uintptr(pcbWritten),
	uintptr(plsnNext),
	uintptr(pOverlapped),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL

function WriteLogRestartArea(
  pvMarshal: Pointer;   // void* in/out
  pvRestartBuffer: Pointer;   // void* in/out
  cbRestartBuffer: DWORD;   // DWORD
  plsnBase: Pointer;   // CLS_LSN* in/out
  fFlags: DWORD;   // CLFS_FLAG
  pcbWritten: Pointer;   // DWORD* in/out
  plsnNext: Pointer;   // CLS_LSN* in/out
  pOverlapped: Pointer   // OVERLAPPED* in/out
): BOOL; stdcall;
  external 'clfsw32.dll' name 'WriteLogRestartArea';

result := DllCall("clfsw32\WriteLogRestartArea"
    , "Ptr", pvMarshal   ; void* in/out
    , "Ptr", pvRestartBuffer   ; void* in/out
    , "UInt", cbRestartBuffer   ; DWORD
    , "Ptr", plsnBase   ; CLS_LSN* in/out
    , "UInt", fFlags   ; CLFS_FLAG
    , "Ptr", pcbWritten   ; DWORD* in/out
    , "Ptr", plsnNext   ; CLS_LSN* in/out
    , "Ptr", pOverlapped   ; OVERLAPPED* in/out
    , "Int")   ; return: BOOL

●WriteLogRestartArea(pvMarshal, pvRestartBuffer, cbRestartBuffer, plsnBase, fFlags, pcbWritten, plsnNext, pOverlapped) = DLL("clfsw32.dll", "bool WriteLogRestartArea(void*, void*, dword, void*, dword, void*, void*, void*)")
# 呼び出し: WriteLogRestartArea(pvMarshal, pvRestartBuffer, cbRestartBuffer, plsnBase, fFlags, pcbWritten, plsnNext, pOverlapped)
# pvMarshal : void* in/out -> "void*"
# pvRestartBuffer : void* in/out -> "void*"
# cbRestartBuffer : DWORD -> "dword"
# plsnBase : CLS_LSN* in/out -> "void*"
# fFlags : CLFS_FLAG -> "dword"
# pcbWritten : DWORD* in/out -> "void*"
# plsnNext : 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 WriteLogRestartArea(
    pvMarshal: ?*anyopaque, // void* in/out
    pvRestartBuffer: ?*anyopaque, // void* in/out
    cbRestartBuffer: u32, // DWORD
    plsnBase: [*c]CLS_LSN, // CLS_LSN* in/out
    fFlags: u32, // CLFS_FLAG
    pcbWritten: [*c]u32, // DWORD* in/out
    plsnNext: [*c]CLS_LSN, // CLS_LSN* in/out
    pOverlapped: [*c]OVERLAPPED // OVERLAPPED* in/out
) callconv(std.os.windows.WINAPI) i32;

proc WriteLogRestartArea(
    pvMarshal: pointer,  # void* in/out
    pvRestartBuffer: pointer,  # void* in/out
    cbRestartBuffer: uint32,  # DWORD
    plsnBase: ptr CLS_LSN,  # CLS_LSN* in/out
    fFlags: uint32,  # CLFS_FLAG
    pcbWritten: ptr uint32,  # DWORD* in/out
    plsnNext: ptr CLS_LSN,  # CLS_LSN* in/out
    pOverlapped: ptr OVERLAPPED  # OVERLAPPED* in/out
): int32 {.importc: "WriteLogRestartArea", stdcall, dynlib: "clfsw32.dll".}

pragma(lib, "clfsw32");
extern(Windows)
int WriteLogRestartArea(
    void* pvMarshal,   // void* in/out
    void* pvRestartBuffer,   // void* in/out
    uint cbRestartBuffer,   // DWORD
    CLS_LSN* plsnBase,   // CLS_LSN* in/out
    uint fFlags,   // CLFS_FLAG
    uint* pcbWritten,   // DWORD* in/out
    CLS_LSN* plsnNext,   // CLS_LSN* in/out
    OVERLAPPED* pOverlapped   // OVERLAPPED* in/out
);

ccall((:WriteLogRestartArea, "clfsw32.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Ptr{Cvoid}, UInt32, Ptr{CLS_LSN}, UInt32, Ptr{UInt32}, Ptr{CLS_LSN}, Ptr{OVERLAPPED}),
      pvMarshal, pvRestartBuffer, cbRestartBuffer, plsnBase, fFlags, pcbWritten, plsnNext, pOverlapped)
# pvMarshal : void* in/out -> Ptr{Cvoid}
# pvRestartBuffer : void* in/out -> Ptr{Cvoid}
# cbRestartBuffer : DWORD -> UInt32
# plsnBase : CLS_LSN* in/out -> Ptr{CLS_LSN}
# fFlags : CLFS_FLAG -> UInt32
# pcbWritten : DWORD* in/out -> Ptr{UInt32}
# plsnNext : CLS_LSN* in/out -> Ptr{CLS_LSN}
# pOverlapped : OVERLAPPED* in/out -> Ptr{OVERLAPPED}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。

local ffi = require("ffi")
ffi.cdef[[
int32_t WriteLogRestartArea(
    void* pvMarshal,
    void* pvRestartBuffer,
    uint32_t cbRestartBuffer,
    void* plsnBase,
    uint32_t fFlags,
    uint32_t* pcbWritten,
    void* plsnNext,
    void* pOverlapped);
]]
local clfsw32 = ffi.load("clfsw32")
-- clfsw32.WriteLogRestartArea(pvMarshal, pvRestartBuffer, cbRestartBuffer, plsnBase, fFlags, pcbWritten, plsnNext, pOverlapped)
-- pvMarshal : void* in/out
-- pvRestartBuffer : void* in/out
-- cbRestartBuffer : DWORD
-- plsnBase : CLS_LSN* in/out
-- fFlags : CLFS_FLAG
-- pcbWritten : DWORD* in/out
-- plsnNext : 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 WriteLogRestartArea = lib.func('__stdcall', 'WriteLogRestartArea', 'int32_t', ['void *', 'void *', 'uint32_t', 'void *', 'uint32_t', 'uint32_t *', 'void *', 'void *']);
// WriteLogRestartArea(pvMarshal, pvRestartBuffer, cbRestartBuffer, plsnBase, fFlags, pcbWritten, plsnNext, pOverlapped)
// pvMarshal : void* in/out -> 'void *'
// pvRestartBuffer : void* in/out -> 'void *'
// cbRestartBuffer : DWORD -> 'uint32_t'
// plsnBase : CLS_LSN* in/out -> 'void *'
// fFlags : CLFS_FLAG -> 'uint32_t'
// pcbWritten : DWORD* in/out -> 'uint32_t *'
// plsnNext : CLS_LSN* in/out -> 'void *'
// pOverlapped : OVERLAPPED* in/out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。

const lib = Deno.dlopen("clfsw32.dll", {
  WriteLogRestartArea: { parameters: ["pointer", "pointer", "u32", "pointer", "u32", "pointer", "pointer", "pointer"], result: "i32" },
});
// lib.symbols.WriteLogRestartArea(pvMarshal, pvRestartBuffer, cbRestartBuffer, plsnBase, fFlags, pcbWritten, plsnNext, pOverlapped)
// pvMarshal : void* in/out -> "pointer"
// pvRestartBuffer : void* in/out -> "pointer"
// cbRestartBuffer : DWORD -> "u32"
// plsnBase : CLS_LSN* in/out -> "pointer"
// fFlags : CLFS_FLAG -> "u32"
// pcbWritten : DWORD* in/out -> "pointer"
// plsnNext : CLS_LSN* in/out -> "pointer"
// pOverlapped : OVERLAPPED* in/out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。

<?php
$ffi = FFI::cdef(<<<C
int32_t WriteLogRestartArea(
    void* pvMarshal,
    void* pvRestartBuffer,
    uint32_t cbRestartBuffer,
    void* plsnBase,
    uint32_t fFlags,
    uint32_t* pcbWritten,
    void* plsnNext,
    void* pOverlapped);
C, "clfsw32.dll");
// $ffi->WriteLogRestartArea(pvMarshal, pvRestartBuffer, cbRestartBuffer, plsnBase, fFlags, pcbWritten, plsnNext, pOverlapped);
// pvMarshal : void* in/out
// pvRestartBuffer : void* in/out
// cbRestartBuffer : DWORD
// plsnBase : CLS_LSN* in/out
// fFlags : CLFS_FLAG
// pcbWritten : DWORD* in/out
// plsnNext : 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 WriteLogRestartArea(
        Pointer pvMarshal,   // void* in/out
        Pointer pvRestartBuffer,   // void* in/out
        int cbRestartBuffer,   // DWORD
        Pointer plsnBase,   // CLS_LSN* in/out
        int fFlags,   // CLFS_FLAG
        IntByReference pcbWritten,   // DWORD* in/out
        Pointer plsnNext,   // CLS_LSN* in/out
        Pointer pOverlapped   // OVERLAPPED* in/out
    );
}

@[Link("clfsw32")]
lib Libclfsw32
  fun WriteLogRestartArea = WriteLogRestartArea(
    pvMarshal : Void*,   # void* in/out
    pvRestartBuffer : Void*,   # void* in/out
    cbRestartBuffer : UInt32,   # DWORD
    plsnBase : CLS_LSN*,   # CLS_LSN* in/out
    fFlags : UInt32,   # CLFS_FLAG
    pcbWritten : UInt32*,   # DWORD* in/out
    plsnNext : 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 WriteLogRestartAreaNative = Int32 Function(Pointer<Void>, Pointer<Void>, Uint32, Pointer<Void>, Uint32, Pointer<Uint32>, Pointer<Void>, Pointer<Void>);
typedef WriteLogRestartAreaDart = int Function(Pointer<Void>, Pointer<Void>, int, Pointer<Void>, int, Pointer<Uint32>, Pointer<Void>, Pointer<Void>);
final WriteLogRestartArea = DynamicLibrary.open('clfsw32.dll')
    .lookupFunction<WriteLogRestartAreaNative, WriteLogRestartAreaDart>('WriteLogRestartArea');
// pvMarshal : void* in/out -> Pointer<Void>
// pvRestartBuffer : void* in/out -> Pointer<Void>
// cbRestartBuffer : DWORD -> Uint32
// plsnBase : CLS_LSN* in/out -> Pointer<Void>
// fFlags : CLFS_FLAG -> Uint32
// pcbWritten : DWORD* in/out -> Pointer<Uint32>
// plsnNext : CLS_LSN* in/out -> Pointer<Void>
// pOverlapped : OVERLAPPED* in/out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。

{$mode objfpc}{$H+}
function WriteLogRestartArea(
  pvMarshal: Pointer;   // void* in/out
  pvRestartBuffer: Pointer;   // void* in/out
  cbRestartBuffer: DWORD;   // DWORD
  plsnBase: Pointer;   // CLS_LSN* in/out
  fFlags: DWORD;   // CLFS_FLAG
  pcbWritten: Pointer;   // DWORD* in/out
  plsnNext: Pointer;   // CLS_LSN* in/out
  pOverlapped: Pointer   // OVERLAPPED* in/out
): BOOL; stdcall;
  external 'clfsw32.dll' name 'WriteLogRestartArea';

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

foreign import stdcall safe "WriteLogRestartArea"
  c_WriteLogRestartArea :: Ptr () -> Ptr () -> Word32 -> Ptr () -> Word32 -> Ptr Word32 -> Ptr () -> Ptr () -> IO CInt
-- pvMarshal : void* in/out -> Ptr ()
-- pvRestartBuffer : void* in/out -> Ptr ()
-- cbRestartBuffer : DWORD -> Word32
-- plsnBase : CLS_LSN* in/out -> Ptr ()
-- fFlags : CLFS_FLAG -> Word32
-- pcbWritten : DWORD* in/out -> Ptr Word32
-- plsnNext : CLS_LSN* in/out -> Ptr ()
-- pOverlapped : OVERLAPPED* in/out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。

open Ctypes
open Foreign

let writelogrestartarea =
  foreign "WriteLogRestartArea"
    ((ptr void) @-> (ptr void) @-> uint32_t @-> (ptr void) @-> uint32_t @-> (ptr uint32_t) @-> (ptr void) @-> (ptr void) @-> returning int32_t)
(* pvMarshal : void* in/out -> (ptr void) *)
(* pvRestartBuffer : void* in/out -> (ptr void) *)
(* cbRestartBuffer : DWORD -> uint32_t *)
(* plsnBase : CLS_LSN* in/out -> (ptr void) *)
(* fFlags : CLFS_FLAG -> uint32_t *)
(* pcbWritten : DWORD* in/out -> (ptr uint32_t) *)
(* plsnNext : 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 ("WriteLogRestartArea" write-log-restart-area :convention :stdcall) :int32
  (pv-marshal :pointer)   ; void* in/out
  (pv-restart-buffer :pointer)   ; void* in/out
  (cb-restart-buffer :uint32)   ; DWORD
  (plsn-base :pointer)   ; CLS_LSN* in/out
  (f-flags :uint32)   ; CLFS_FLAG
  (pcb-written :pointer)   ; DWORD* in/out
  (plsn-next :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 $WriteLogRestartArea = Win32::API::More->new('clfsw32',
    'BOOL WriteLogRestartArea(LPVOID pvMarshal, LPVOID pvRestartBuffer, DWORD cbRestartBuffer, LPVOID plsnBase, DWORD fFlags, LPVOID pcbWritten, LPVOID plsnNext, LPVOID pOverlapped)');
# my $ret = $WriteLogRestartArea->Call($pvMarshal, $pvRestartBuffer, $cbRestartBuffer, $plsnBase, $fFlags, $pcbWritten, $plsnNext, $pOverlapped);
# pvMarshal : void* in/out -> LPVOID
# pvRestartBuffer : void* in/out -> LPVOID
# cbRestartBuffer : DWORD -> DWORD
# plsnBase : CLS_LSN* in/out -> LPVOID
# fFlags : CLFS_FLAG -> DWORD
# pcbWritten : DWORD* in/out -> LPVOID
# plsnNext : CLS_LSN* in/out -> LPVOID
# pOverlapped : OVERLAPPED* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

WriteLogRestartArea

シグネチャ

パラメーター

公式ドキュメント

戻り値

解説(Remarks)

各言語での呼び出し定義

関連項目