ホーム › Storage.FileSystem › FlushLogBuffers

FlushLogBuffers

関数

CLFSログのバッファをディスクへフラッシュする。

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

シグネチャ

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

BOOL FlushLogBuffers(
    void* pvMarshal,
    OVERLAPPED* pOverlapped   // optional
);

パラメーター

名前	型	方向	説明
pvMarshal	void*	in	CreateLogMarshallingArea 関数を使用して割り当てられたマーシャリングコンテキストへのポインターです。
pOverlapped	OVERLAPPED*	inoutoptional	非同期操作に必要な OVERLAPPED 構造体へのポインターです。非同期操作を使用しない場合、このパラメーターは NULL にできます。

名前

型

方向

説明

pvMarshal

void*

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

pOverlapped

OVERLAPPED*

inoutoptional

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

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

戻り値の型: BOOL

公式ドキュメント

このマーシャリング領域に追加されたすべてのレコードを、強制的にディスクへフラッシュします。

戻り値

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

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

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

各言語での呼び出し定義

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

BOOL FlushLogBuffers(
    void* pvMarshal,
    OVERLAPPED* pOverlapped   // optional
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("clfsw32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool FlushLogBuffers(
    IntPtr pvMarshal,   // void*
    IntPtr pOverlapped   // OVERLAPPED* optional, in/out
);

<DllImport("clfsw32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function FlushLogBuffers(
    pvMarshal As IntPtr,   ' void*
    pOverlapped As IntPtr   ' OVERLAPPED* optional, in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' pvMarshal : void*
' pOverlapped : OVERLAPPED* optional, in/out
Declare PtrSafe Function FlushLogBuffers Lib "clfsw32" ( _
    ByVal pvMarshal 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

FlushLogBuffers = ctypes.windll.clfsw32.FlushLogBuffers
FlushLogBuffers.restype = wintypes.BOOL
FlushLogBuffers.argtypes = [
    ctypes.POINTER(None),  # pvMarshal : void*
    ctypes.c_void_p,  # pOverlapped : OVERLAPPED* optional, in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('clfsw32.dll')
FlushLogBuffers = Fiddle::Function.new(
  lib['FlushLogBuffers'],
  [
    Fiddle::TYPE_VOIDP,  # pvMarshal : void*
    Fiddle::TYPE_VOIDP,  # pOverlapped : OVERLAPPED* optional, in/out
  ],
  Fiddle::TYPE_INT)

#[link(name = "clfsw32")]
extern "system" {
    fn FlushLogBuffers(
        pvMarshal: *mut (),  // void*
        pOverlapped: *mut OVERLAPPED  // OVERLAPPED* optional, 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 FlushLogBuffers(IntPtr pvMarshal, IntPtr pOverlapped);
"@
$api = Add-Type -MemberDefinition $sig -Name 'clfsw32_FlushLogBuffers' -Namespace Win32 -PassThru
# $api::FlushLogBuffers(pvMarshal, pOverlapped)

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

出力引数:

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