Win32 API 日本語リファレンス
ホーム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
);

パラメーター

名前方向
pvArchiveContextvoid*inout
cbOffsetDWORDin
cbBytesToReadDWORDin
pbReadBufferBYTE*inout
pcbBytesReadDWORD*inout

戻り値の型: BOOL

各言語での呼び出し定義

// 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 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 方式にも切替可。
出力引数:
; BOOL ReadLogArchiveMetadata(void* pvArchiveContext, DWORD cbOffset, DWORD cbBytesToRead, BYTE* pbReadBuffer, DWORD* pcbBytesRead)
#uselib "clfsw32.dll"
#cfunc global ReadLogArchiveMetadata "ReadLogArchiveMetadata" intptr, int, int, var, var
; res = ReadLogArchiveMetadata(pvArchiveContext, cbOffset, cbBytesToRead, pbReadBuffer, pcbBytesRead)
; pvArchiveContext : void* in/out -> "intptr"
; cbOffset : DWORD -> "int"
; cbBytesToRead : DWORD -> "int"
; pbReadBuffer : BYTE* in/out -> "var"
; pcbBytesRead : DWORD* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	clfsw32 = windows.NewLazySystemDLL("clfsw32.dll")
	procReadLogArchiveMetadata = clfsw32.NewProc("ReadLogArchiveMetadata")
)

// pvArchiveContext (void* in/out), cbOffset (DWORD), cbBytesToRead (DWORD), pbReadBuffer (BYTE* in/out), pcbBytesRead (DWORD* in/out)
r1, _, err := procReadLogArchiveMetadata.Call(
	uintptr(pvArchiveContext),
	uintptr(cbOffset),
	uintptr(cbBytesToRead),
	uintptr(pbReadBuffer),
	uintptr(pcbBytesRead),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function ReadLogArchiveMetadata(
  pvArchiveContext: Pointer;   // void* in/out
  cbOffset: DWORD;   // DWORD
  cbBytesToRead: DWORD;   // DWORD
  pbReadBuffer: Pointer;   // BYTE* in/out
  pcbBytesRead: Pointer   // DWORD* in/out
): BOOL; stdcall;
  external 'clfsw32.dll' name 'ReadLogArchiveMetadata';
result := DllCall("clfsw32\ReadLogArchiveMetadata"
    , "Ptr", pvArchiveContext   ; void* in/out
    , "UInt", cbOffset   ; DWORD
    , "UInt", cbBytesToRead   ; DWORD
    , "Ptr", pbReadBuffer   ; BYTE* in/out
    , "Ptr", pcbBytesRead   ; DWORD* in/out
    , "Int")   ; return: BOOL
●ReadLogArchiveMetadata(pvArchiveContext, cbOffset, cbBytesToRead, pbReadBuffer, pcbBytesRead) = DLL("clfsw32.dll", "bool ReadLogArchiveMetadata(void*, dword, dword, void*, void*)")
# 呼び出し: ReadLogArchiveMetadata(pvArchiveContext, cbOffset, cbBytesToRead, pbReadBuffer, pcbBytesRead)
# pvArchiveContext : void* in/out -> "void*"
# cbOffset : DWORD -> "dword"
# cbBytesToRead : DWORD -> "dword"
# pbReadBuffer : BYTE* in/out -> "void*"
# pcbBytesRead : DWORD* in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。