ホーム › Storage.FileSystem › ReadLogRestartArea

ReadLogRestartArea

関数

CLFSログの最新リスタート領域を読み取る。

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

シグネチャ

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

BOOL ReadLogRestartArea(
    void* pvMarshal,
    void** ppvRestartBuffer,
    DWORD* pcbRestartBuffer,
    CLS_LSN* plsn,
    void** ppvContext,
    OVERLAPPED* pOverlapped
);

パラメーター

名前	型	方向	説明
pvMarshal	void*	inout	CreateLogMarshallingArea 関数を使用して割り当てられたマーシャリングコンテキストへのポインター。
ppvRestartBuffer	void**	inout	ログ I/O ブロック内の再開データへのポインターを受け取る変数へのポインター。
pcbRestartBuffer	DWORD*	inout	再開データの量を受け取る変数へのポインター。
plsn	CLS_LSN*	inout	再開領域のログシーケンス番号 (LSN) を受け取る CLFS_LSN 構造体へのポインター。
ppvContext	void**	inout	読み取りが成功したときに、システムが割り当てた読み取りコンテキストへのポインターを受け取る変数へのポインター。関数が操作の完了を延期する場合、有効な読み取りコンテキストポインターと ERROR_IO_PENDING のエラー状態を返します。その他のすべてのエラーでは、読み取りコンテキストポインターは NULL になります。関数の延期完了の処理について詳しくは、このトピックの「解説」セクションを参照してください。要求したすべてのログレコードを取得した後、クライアントは関連付けられたメモリを解放するために、読み取りコンテキストを TerminateReadLog に渡す必要があります。これを行わないと、メモリリークが発生します。 Note Common Log File System (CLFS) の読み取りコンテキストはスレッドセーフではありません。複数のスレッドから同時に使用したり、複数の非同期読み取りに同時に渡したりしないでください。
pOverlapped	OVERLAPPED*	inout	非同期操作に必要な OVERLAPPED 構造体へのポインター。非同期操作を使用しない場合、このパラメーターは NULL にできます。

戻り値の型: BOOL

公式ドキュメント

WriteLogRestartArea のマーシャリング領域に関連付けられたログに対して、正常に書き込まれた最後の再開領域 (restart area) を返します。

戻り値

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

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

次の一覧に、考えられるエラーコードを示します。

解説(Remarks)

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

通常、ReadLogRestartArea は、クラッシュ後または正常なシャットダウン後のクライアント再開時にのみ使用されます。

ログ内に再開領域が存在しない場合、ReadLogRestartArea はコード ERROR_LOG_NO_RESTART で失敗します。

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

ログレコードのコピーを完了するには、クライアントはまず GetOverlappedResult または待機関数のいずれかを呼び出して、オーバーラップ I/O 操作の延期完了と自身の実行を同期させる必要があります。詳しくは、同期およびオーバーラップ入出力を参照してください。

ReadLogRestartArea が非同期で完了した後、要求された再開領域はディスクから読み取られますが、それへの有効なポインターは *ppvRestartBuffer には格納されません。

有効なポインターを取得するには、クライアントは ReadPreviousLogRestartArea を呼び出し、ReadLogRestartArea が返した読み取りコンテキストポインターを渡す必要があります。

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 ReadLogRestartArea(
    void* pvMarshal,
    void** ppvRestartBuffer,
    DWORD* pcbRestartBuffer,
    CLS_LSN* plsn,
    void** ppvContext,
    OVERLAPPED* pOverlapped
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("clfsw32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool ReadLogRestartArea(
    IntPtr pvMarshal,   // void* in/out
    IntPtr ppvRestartBuffer,   // void** in/out
    ref uint pcbRestartBuffer,   // DWORD* in/out
    IntPtr plsn,   // CLS_LSN* in/out
    IntPtr ppvContext,   // void** in/out
    IntPtr pOverlapped   // OVERLAPPED* in/out
);

<DllImport("clfsw32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function ReadLogRestartArea(
    pvMarshal As IntPtr,   ' void* in/out
    ppvRestartBuffer As IntPtr,   ' void** in/out
    ByRef pcbRestartBuffer As UInteger,   ' DWORD* in/out
    plsn As IntPtr,   ' CLS_LSN* in/out
    ppvContext As IntPtr,   ' void** in/out
    pOverlapped As IntPtr   ' OVERLAPPED* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' pvMarshal : void* in/out
' ppvRestartBuffer : void** in/out
' pcbRestartBuffer : DWORD* in/out
' plsn : CLS_LSN* in/out
' ppvContext : void** in/out
' pOverlapped : OVERLAPPED* in/out
Declare PtrSafe Function ReadLogRestartArea Lib "clfsw32" ( _
    ByVal pvMarshal As LongPtr, _
    ByVal ppvRestartBuffer As LongPtr, _
    ByRef pcbRestartBuffer As Long, _
    ByVal plsn As LongPtr, _
    ByVal ppvContext 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

ReadLogRestartArea = ctypes.windll.clfsw32.ReadLogRestartArea
ReadLogRestartArea.restype = wintypes.BOOL
ReadLogRestartArea.argtypes = [
    ctypes.POINTER(None),  # pvMarshal : void* in/out
    ctypes.c_void_p,  # ppvRestartBuffer : void** in/out
    ctypes.POINTER(wintypes.DWORD),  # pcbRestartBuffer : DWORD* in/out
    ctypes.c_void_p,  # plsn : CLS_LSN* in/out
    ctypes.c_void_p,  # ppvContext : 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')
ReadLogRestartArea = Fiddle::Function.new(
  lib['ReadLogRestartArea'],
  [
    Fiddle::TYPE_VOIDP,  # pvMarshal : void* in/out
    Fiddle::TYPE_VOIDP,  # ppvRestartBuffer : void** in/out
    Fiddle::TYPE_VOIDP,  # pcbRestartBuffer : DWORD* in/out
    Fiddle::TYPE_VOIDP,  # plsn : CLS_LSN* in/out
    Fiddle::TYPE_VOIDP,  # ppvContext : void** in/out
    Fiddle::TYPE_VOIDP,  # pOverlapped : OVERLAPPED* in/out
  ],
  Fiddle::TYPE_INT)

#[link(name = "clfsw32")]
extern "system" {
    fn ReadLogRestartArea(
        pvMarshal: *mut (),  // void* in/out
        ppvRestartBuffer: *mut *mut (),  // void** in/out
        pcbRestartBuffer: *mut u32,  // DWORD* in/out
        plsn: *mut CLS_LSN,  // CLS_LSN* in/out
        ppvContext: *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 ReadLogRestartArea(IntPtr pvMarshal, IntPtr ppvRestartBuffer, ref uint pcbRestartBuffer, IntPtr plsn, IntPtr ppvContext, IntPtr pOverlapped);
"@
$api = Add-Type -MemberDefinition $sig -Name 'clfsw32_ReadLogRestartArea' -Namespace Win32 -PassThru
# $api::ReadLogRestartArea(pvMarshal, ppvRestartBuffer, pcbRestartBuffer, plsn, ppvContext, pOverlapped)

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

出力引数:

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