ホーム › Storage.FileSystem › FlushLogToLsn

FlushLogToLsn

関数

CLFSログを指定LSNまでフラッシュする。

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

シグネチャ

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

BOOL FlushLogToLsn(
    void* pvMarshalContext,
    CLS_LSN* plsnFlush,
    CLS_LSN* plsnLastFlushed,
    OVERLAPPED* pOverlapped
);

パラメーター

名前	型	方向	説明
pvMarshalContext	void*	inout	CreateLogMarshallingArea 関数を使用して割り当てられたマーシャリングコンテキストへのポインターです。
plsnFlush	CLS_LSN*	inout	フラッシュするレコードを決定するために使用される LSN を指定する CLFS_LSN 構造体へのポインターです。マーシャリング領域内のすべてのレコードをフラッシュするには、CLFS_LSN_NULL を指定します。
plsnLastFlushed	CLS_LSN*	inout	CLFS_LSN 構造体へのポインターです。返される LSN は、フラッシュされたいずれのレコードの LSN よりも大きい値になります。関数が成功した場合、この LSN の値は plsnFlush を下回ることはありません。この値は、関数が成功した場合にのみ意味を持ちます。
pOverlapped	OVERLAPPED*	inout	非同期操作に必要な OVERLAPPED 構造体へのポインターです。このパラメーターは、非同期操作の場合を除き NULL を指定できます。

戻り値の型: BOOL

公式ドキュメント

このマーシャリング領域に追加されたレコードのうち、指定したログシーケンス番号 (LSN) を持つレコードまでのすべてのレコードを、強制的にディスクへフラッシュします。この操作中に、指定した数より多くのレコードがフラッシュされる場合があります。

戻り値

関数が成功した場合、戻り値は 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 FlushLogToLsn(
    void* pvMarshalContext,
    CLS_LSN* plsnFlush,
    CLS_LSN* plsnLastFlushed,
    OVERLAPPED* pOverlapped
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("clfsw32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool FlushLogToLsn(
    IntPtr pvMarshalContext,   // void* in/out
    IntPtr plsnFlush,   // CLS_LSN* in/out
    IntPtr plsnLastFlushed,   // CLS_LSN* in/out
    IntPtr pOverlapped   // OVERLAPPED* in/out
);

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

' pvMarshalContext : void* in/out
' plsnFlush : CLS_LSN* in/out
' plsnLastFlushed : CLS_LSN* in/out
' pOverlapped : OVERLAPPED* in/out
Declare PtrSafe Function FlushLogToLsn Lib "clfsw32" ( _
    ByVal pvMarshalContext As LongPtr, _
    ByVal plsnFlush As LongPtr, _
    ByVal plsnLastFlushed 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

FlushLogToLsn = ctypes.windll.clfsw32.FlushLogToLsn
FlushLogToLsn.restype = wintypes.BOOL
FlushLogToLsn.argtypes = [
    ctypes.POINTER(None),  # pvMarshalContext : void* in/out
    ctypes.c_void_p,  # plsnFlush : CLS_LSN* in/out
    ctypes.c_void_p,  # plsnLastFlushed : 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')
FlushLogToLsn = Fiddle::Function.new(
  lib['FlushLogToLsn'],
  [
    Fiddle::TYPE_VOIDP,  # pvMarshalContext : void* in/out
    Fiddle::TYPE_VOIDP,  # plsnFlush : CLS_LSN* in/out
    Fiddle::TYPE_VOIDP,  # plsnLastFlushed : CLS_LSN* in/out
    Fiddle::TYPE_VOIDP,  # pOverlapped : OVERLAPPED* in/out
  ],
  Fiddle::TYPE_INT)

#[link(name = "clfsw32")]
extern "system" {
    fn FlushLogToLsn(
        pvMarshalContext: *mut (),  // void* in/out
        plsnFlush: *mut CLS_LSN,  // CLS_LSN* in/out
        plsnLastFlushed: *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 FlushLogToLsn(IntPtr pvMarshalContext, IntPtr plsnFlush, IntPtr plsnLastFlushed, IntPtr pOverlapped);
"@
$api = Add-Type -MemberDefinition $sig -Name 'clfsw32_FlushLogToLsn' -Namespace Win32 -PassThru
# $api::FlushLogToLsn(pvMarshalContext, plsnFlush, plsnLastFlushed, pOverlapped)

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

出力引数:

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