ホーム › Storage.FileSystem › ReadLogArchiveMetadata

ReadLogArchiveMetadata

関数

CLFSログアーカイブのメタデータを読み取る。

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

シグネチャ

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

BOOL ReadLogArchiveMetadata(
    void* pvArchiveContext,
    DWORD cbOffset,
    DWORD cbBytesToRead,
    BYTE* pbReadBuffer,
    DWORD* pcbBytesRead
);

パラメーター

名前	型	方向	説明
pvArchiveContext	void*	inout	PrepareLogArchive の呼び出しによって取得されるアーカイブコンテキストへのポインターです。このコンテキストはカーソルの状態を保持し、アーカイブ内のファイルエクステントのセットを反復処理できるようにします。アーカイブクライアントは、TerminateLogArchive 関数を使用してコンテキストを解放する責任があります。
cbOffset	DWORD	in	データのコピーを開始するメタデータ内のオフセットです。この関数を最初に呼び出すときは、ゼロ (0) を指定します。以降の呼び出しでは、pcbBytesRead で返された値を指定します。
cbBytesToRead	DWORD	in	pbReadBuffer にコピーするメタデータスナップショットのバイト数です。このパラメーターをゼロ (0) にすることはできません。
pbReadBuffer	BYTE*	inout	メタデータスナップショットのコピー先となるバッファーへのポインターです。
pcbBytesRead	DWORD*	inout	pbReadBuffer にコピーされたバイト数を受け取る変数へのポインターです。バイト数は常にゼロ (0) から cbBytesToRead までの間になります。

戻り値の型: 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 ReadLogArchiveMetadata(
    void* pvArchiveContext,
    DWORD cbOffset,
    DWORD cbBytesToRead,
    BYTE* pbReadBuffer,
    DWORD* pcbBytesRead
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("clfsw32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool ReadLogArchiveMetadata(
    IntPtr pvArchiveContext,   // void* in/out
    uint cbOffset,   // DWORD
    uint cbBytesToRead,   // DWORD
    IntPtr pbReadBuffer,   // BYTE* in/out
    ref uint pcbBytesRead   // DWORD* in/out
);

<DllImport("clfsw32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function ReadLogArchiveMetadata(
    pvArchiveContext As IntPtr,   ' void* in/out
    cbOffset As UInteger,   ' DWORD
    cbBytesToRead As UInteger,   ' DWORD
    pbReadBuffer As IntPtr,   ' BYTE* in/out
    ByRef pcbBytesRead As UInteger   ' DWORD* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' pvArchiveContext : void* in/out
' cbOffset : DWORD
' cbBytesToRead : DWORD
' pbReadBuffer : BYTE* in/out
' pcbBytesRead : DWORD* in/out
Declare PtrSafe Function ReadLogArchiveMetadata Lib "clfsw32" ( _
    ByVal pvArchiveContext As LongPtr, _
    ByVal cbOffset As Long, _
    ByVal cbBytesToRead As Long, _
    ByVal pbReadBuffer As LongPtr, _
    ByRef pcbBytesRead As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

ReadLogArchiveMetadata = ctypes.windll.clfsw32.ReadLogArchiveMetadata
ReadLogArchiveMetadata.restype = wintypes.BOOL
ReadLogArchiveMetadata.argtypes = [
    ctypes.POINTER(None),  # pvArchiveContext : void* in/out
    wintypes.DWORD,  # cbOffset : DWORD
    wintypes.DWORD,  # cbBytesToRead : DWORD
    ctypes.POINTER(ctypes.c_ubyte),  # pbReadBuffer : BYTE* in/out
    ctypes.POINTER(wintypes.DWORD),  # pcbBytesRead : DWORD* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('clfsw32.dll')
ReadLogArchiveMetadata = Fiddle::Function.new(
  lib['ReadLogArchiveMetadata'],
  [
    Fiddle::TYPE_VOIDP,  # pvArchiveContext : void* in/out
    -Fiddle::TYPE_INT,  # cbOffset : DWORD
    -Fiddle::TYPE_INT,  # cbBytesToRead : DWORD
    Fiddle::TYPE_VOIDP,  # pbReadBuffer : BYTE* in/out
    Fiddle::TYPE_VOIDP,  # pcbBytesRead : DWORD* in/out
  ],
  Fiddle::TYPE_INT)

#[link(name = "clfsw32")]
extern "system" {
    fn ReadLogArchiveMetadata(
        pvArchiveContext: *mut (),  // void* in/out
        cbOffset: u32,  // DWORD
        cbBytesToRead: u32,  // DWORD
        pbReadBuffer: *mut u8,  // BYTE* in/out
        pcbBytesRead: *mut u32  // DWORD* 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 ReadLogArchiveMetadata(IntPtr pvArchiveContext, uint cbOffset, uint cbBytesToRead, IntPtr pbReadBuffer, ref uint pcbBytesRead);
"@
$api = Add-Type -MemberDefinition $sig -Name 'clfsw32_ReadLogArchiveMetadata' -Namespace Win32 -PassThru
# $api::ReadLogArchiveMetadata(pvArchiveContext, cbOffset, cbBytesToRead, pbReadBuffer, pcbBytesRead)

#uselib "clfsw32.dll"
#func global ReadLogArchiveMetadata "ReadLogArchiveMetadata" sptr, sptr, sptr, sptr, sptr
; ReadLogArchiveMetadata pvArchiveContext, cbOffset, cbBytesToRead, varptr(pbReadBuffer), varptr(pcbBytesRead)   ; 戻り値は stat
; pvArchiveContext : void* in/out -> "sptr"
; cbOffset : DWORD -> "sptr"
; cbBytesToRead : DWORD -> "sptr"
; pbReadBuffer : BYTE* in/out -> "sptr"
; pcbBytesRead : DWORD* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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