ホーム › Storage.FileSystem › ReadPreviousLogRestartArea

ReadPreviousLogRestartArea

関数

CLFSログで一つ前のリスタート領域を読み取る。

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

シグネチャ

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

BOOL ReadPreviousLogRestartArea(
    void* pvReadContext,
    void** ppvRestartBuffer,
    DWORD* pcbRestartBuffer,
    CLS_LSN* plsnRestart,
    OVERLAPPED* pOverlapped
);

パラメーター

名前	型	方向	説明
pvReadContext	void*	inout	ReadLogRestartArea が返す、システムが割り当てた読み取りコンテキストへのポインターです。これらの関数が ERROR_IO_PENDING を返す場合でも、有効な読み取りコンテキストへのポインターは返されます。非同期完了については、本トピックの「解説」セクションを参照してください。
ppvRestartBuffer	void**	inout	再起動データへのポインターを受け取る変数へのポインターです。
pcbRestartBuffer	DWORD*	inout	*ppvRestartBuffer にある再起動データのサイズ(バイト単位)を受け取る変数へのポインターです。
plsnRestart	CLS_LSN*	inout	この関数が返す再起動領域のログシーケンス番号 (LSN) を受け取る CLFS_LSN 構造体へのポインターです。
pOverlapped	OVERLAPPED*	inout	非同期操作に必要な OVERLAPPED 構造体へのポインターです。非同期操作を使用しない場合、このパラメーターは NULL にできます。

戻り値の型: BOOL

公式ドキュメント

読み取りコンテキスト pvReadContext で指定された現在の再起動レコードに対する、1つ前のログ再起動領域を読み取ります。この読み取りコンテキストは、以前に ReadLogRestartArea の呼び出しによって作成されたものです。

戻り値

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

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

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

解説(Remarks)

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

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

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

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

有効なポインターを取得するには、クライアントは ReadPreviousLogRestartArea を再度呼び出す必要があります。

注 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 ReadPreviousLogRestartArea(
    void* pvReadContext,
    void** ppvRestartBuffer,
    DWORD* pcbRestartBuffer,
    CLS_LSN* plsnRestart,
    OVERLAPPED* pOverlapped
);

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

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

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

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

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

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

出力引数:

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