ホーム › Storage.FileSystem › PrepareLogArchive

PrepareLogArchive

関数

CLFSログのアーカイブ処理を準備しコンテキストを取得する。

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

シグネチャ

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

BOOL PrepareLogArchive(
    HANDLE hLog,
    LPWSTR pszBaseLogFileName,
    DWORD cLen,
    const CLS_LSN* plsnLow,   // optional
    const CLS_LSN* plsnHigh,   // optional
    DWORD* pcActualLength,   // optional
    ULONGLONG* poffBaseLogFileData,
    ULONGLONG* pcbBaseLogFileLength,
    CLS_LSN* plsnBase,
    CLS_LSN* plsnLast,
    CLS_LSN* plsnCurrentArchiveTail,
    void** ppvArchiveContext
);

パラメーター

名前	型	方向
hLog	HANDLE	in
pszBaseLogFileName	LPWSTR	inout
cLen	DWORD	in
plsnLow	CLS_LSN*	inoptional
plsnHigh	CLS_LSN*	inoptional
pcActualLength	DWORD*	outoptional
poffBaseLogFileData	ULONGLONG*	out
pcbBaseLogFileLength	ULONGLONG*	out
plsnBase	CLS_LSN*	out
plsnLast	CLS_LSN*	out
plsnCurrentArchiveTail	CLS_LSN*	out
ppvArchiveContext	void**	out

戻り値の型: BOOL

各言語での呼び出し定義

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

BOOL PrepareLogArchive(
    HANDLE hLog,
    LPWSTR pszBaseLogFileName,
    DWORD cLen,
    const CLS_LSN* plsnLow,   // optional
    const CLS_LSN* plsnHigh,   // optional
    DWORD* pcActualLength,   // optional
    ULONGLONG* poffBaseLogFileData,
    ULONGLONG* pcbBaseLogFileLength,
    CLS_LSN* plsnBase,
    CLS_LSN* plsnLast,
    CLS_LSN* plsnCurrentArchiveTail,
    void** ppvArchiveContext
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("clfsw32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool PrepareLogArchive(
    IntPtr hLog,   // HANDLE
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder pszBaseLogFileName,   // LPWSTR in/out
    uint cLen,   // DWORD
    IntPtr plsnLow,   // CLS_LSN* optional
    IntPtr plsnHigh,   // CLS_LSN* optional
    IntPtr pcActualLength,   // DWORD* optional, out
    out ulong poffBaseLogFileData,   // ULONGLONG* out
    out ulong pcbBaseLogFileLength,   // ULONGLONG* out
    IntPtr plsnBase,   // CLS_LSN* out
    IntPtr plsnLast,   // CLS_LSN* out
    IntPtr plsnCurrentArchiveTail,   // CLS_LSN* out
    IntPtr ppvArchiveContext   // void** out
);

<DllImport("clfsw32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function PrepareLogArchive(
    hLog As IntPtr,   ' HANDLE
    <MarshalAs(UnmanagedType.LPWStr)> pszBaseLogFileName As System.Text.StringBuilder,   ' LPWSTR in/out
    cLen As UInteger,   ' DWORD
    plsnLow As IntPtr,   ' CLS_LSN* optional
    plsnHigh As IntPtr,   ' CLS_LSN* optional
    pcActualLength As IntPtr,   ' DWORD* optional, out
    <Out> ByRef poffBaseLogFileData As ULong,   ' ULONGLONG* out
    <Out> ByRef pcbBaseLogFileLength As ULong,   ' ULONGLONG* out
    plsnBase As IntPtr,   ' CLS_LSN* out
    plsnLast As IntPtr,   ' CLS_LSN* out
    plsnCurrentArchiveTail As IntPtr,   ' CLS_LSN* out
    ppvArchiveContext As IntPtr   ' void** out
) As Boolean
End Function

' hLog : HANDLE
' pszBaseLogFileName : LPWSTR in/out
' cLen : DWORD
' plsnLow : CLS_LSN* optional
' plsnHigh : CLS_LSN* optional
' pcActualLength : DWORD* optional, out
' poffBaseLogFileData : ULONGLONG* out
' pcbBaseLogFileLength : ULONGLONG* out
' plsnBase : CLS_LSN* out
' plsnLast : CLS_LSN* out
' plsnCurrentArchiveTail : CLS_LSN* out
' ppvArchiveContext : void** out
Declare PtrSafe Function PrepareLogArchive Lib "clfsw32" ( _
    ByVal hLog As LongPtr, _
    ByVal pszBaseLogFileName As LongPtr, _
    ByVal cLen As Long, _
    ByVal plsnLow As LongPtr, _
    ByVal plsnHigh As LongPtr, _
    ByVal pcActualLength As LongPtr, _
    ByRef poffBaseLogFileData As LongLong, _
    ByRef pcbBaseLogFileLength As LongLong, _
    ByVal plsnBase As LongPtr, _
    ByVal plsnLast As LongPtr, _
    ByVal plsnCurrentArchiveTail As LongPtr, _
    ByVal ppvArchiveContext As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

PrepareLogArchive = ctypes.windll.clfsw32.PrepareLogArchive
PrepareLogArchive.restype = wintypes.BOOL
PrepareLogArchive.argtypes = [
    wintypes.HANDLE,  # hLog : HANDLE
    wintypes.LPWSTR,  # pszBaseLogFileName : LPWSTR in/out
    wintypes.DWORD,  # cLen : DWORD
    ctypes.c_void_p,  # plsnLow : CLS_LSN* optional
    ctypes.c_void_p,  # plsnHigh : CLS_LSN* optional
    ctypes.POINTER(wintypes.DWORD),  # pcActualLength : DWORD* optional, out
    ctypes.POINTER(ctypes.c_ulonglong),  # poffBaseLogFileData : ULONGLONG* out
    ctypes.POINTER(ctypes.c_ulonglong),  # pcbBaseLogFileLength : ULONGLONG* out
    ctypes.c_void_p,  # plsnBase : CLS_LSN* out
    ctypes.c_void_p,  # plsnLast : CLS_LSN* out
    ctypes.c_void_p,  # plsnCurrentArchiveTail : CLS_LSN* out
    ctypes.c_void_p,  # ppvArchiveContext : void** out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('clfsw32.dll')
PrepareLogArchive = Fiddle::Function.new(
  lib['PrepareLogArchive'],
  [
    Fiddle::TYPE_VOIDP,  # hLog : HANDLE
    Fiddle::TYPE_VOIDP,  # pszBaseLogFileName : LPWSTR in/out
    -Fiddle::TYPE_INT,  # cLen : DWORD
    Fiddle::TYPE_VOIDP,  # plsnLow : CLS_LSN* optional
    Fiddle::TYPE_VOIDP,  # plsnHigh : CLS_LSN* optional
    Fiddle::TYPE_VOIDP,  # pcActualLength : DWORD* optional, out
    Fiddle::TYPE_VOIDP,  # poffBaseLogFileData : ULONGLONG* out
    Fiddle::TYPE_VOIDP,  # pcbBaseLogFileLength : ULONGLONG* out
    Fiddle::TYPE_VOIDP,  # plsnBase : CLS_LSN* out
    Fiddle::TYPE_VOIDP,  # plsnLast : CLS_LSN* out
    Fiddle::TYPE_VOIDP,  # plsnCurrentArchiveTail : CLS_LSN* out
    Fiddle::TYPE_VOIDP,  # ppvArchiveContext : void** out
  ],
  Fiddle::TYPE_INT)

#[link(name = "clfsw32")]
extern "system" {
    fn PrepareLogArchive(
        hLog: *mut core::ffi::c_void,  // HANDLE
        pszBaseLogFileName: *mut u16,  // LPWSTR in/out
        cLen: u32,  // DWORD
        plsnLow: *const CLS_LSN,  // CLS_LSN* optional
        plsnHigh: *const CLS_LSN,  // CLS_LSN* optional
        pcActualLength: *mut u32,  // DWORD* optional, out
        poffBaseLogFileData: *mut u64,  // ULONGLONG* out
        pcbBaseLogFileLength: *mut u64,  // ULONGLONG* out
        plsnBase: *mut CLS_LSN,  // CLS_LSN* out
        plsnLast: *mut CLS_LSN,  // CLS_LSN* out
        plsnCurrentArchiveTail: *mut CLS_LSN,  // CLS_LSN* out
        ppvArchiveContext: *mut *mut ()  // void** 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 PrepareLogArchive(IntPtr hLog, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder pszBaseLogFileName, uint cLen, IntPtr plsnLow, IntPtr plsnHigh, IntPtr pcActualLength, out ulong poffBaseLogFileData, out ulong pcbBaseLogFileLength, IntPtr plsnBase, IntPtr plsnLast, IntPtr plsnCurrentArchiveTail, IntPtr ppvArchiveContext);
"@
$api = Add-Type -MemberDefinition $sig -Name 'clfsw32_PrepareLogArchive' -Namespace Win32 -PassThru
# $api::PrepareLogArchive(hLog, pszBaseLogFileName, cLen, plsnLow, plsnHigh, pcActualLength, poffBaseLogFileData, pcbBaseLogFileLength, plsnBase, plsnLast, plsnCurrentArchiveTail, ppvArchiveContext)

#uselib "clfsw32.dll"
#func global PrepareLogArchive "PrepareLogArchive" sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr
; PrepareLogArchive hLog, varptr(pszBaseLogFileName), cLen, varptr(plsnLow), varptr(plsnHigh), varptr(pcActualLength), varptr(poffBaseLogFileData), varptr(pcbBaseLogFileLength), varptr(plsnBase), varptr(plsnLast), varptr(plsnCurrentArchiveTail), ppvArchiveContext   ; 戻り値は stat
; hLog : HANDLE -> "sptr"
; pszBaseLogFileName : LPWSTR in/out -> "sptr"
; cLen : DWORD -> "sptr"
; plsnLow : CLS_LSN* optional -> "sptr"
; plsnHigh : CLS_LSN* optional -> "sptr"
; pcActualLength : DWORD* optional, out -> "sptr"
; poffBaseLogFileData : ULONGLONG* out -> "sptr"
; pcbBaseLogFileLength : ULONGLONG* out -> "sptr"
; plsnBase : CLS_LSN* out -> "sptr"
; plsnLast : CLS_LSN* out -> "sptr"
; plsnCurrentArchiveTail : CLS_LSN* out -> "sptr"
; ppvArchiveContext : void** out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "clfsw32.dll"
#cfunc global PrepareLogArchive "PrepareLogArchive" sptr, var, int, var, var, var, var, var, var, var, var, sptr
; res = PrepareLogArchive(hLog, pszBaseLogFileName, cLen, plsnLow, plsnHigh, pcActualLength, poffBaseLogFileData, pcbBaseLogFileLength, plsnBase, plsnLast, plsnCurrentArchiveTail, ppvArchiveContext)
; hLog : HANDLE -> "sptr"
; pszBaseLogFileName : LPWSTR in/out -> "var"
; cLen : DWORD -> "int"
; plsnLow : CLS_LSN* optional -> "var"
; plsnHigh : CLS_LSN* optional -> "var"
; pcActualLength : DWORD* optional, out -> "var"
; poffBaseLogFileData : ULONGLONG* out -> "var"
; pcbBaseLogFileLength : ULONGLONG* out -> "var"
; plsnBase : CLS_LSN* out -> "var"
; plsnLast : CLS_LSN* out -> "var"
; plsnCurrentArchiveTail : CLS_LSN* out -> "var"
; ppvArchiveContext : void** out -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "clfsw32.dll"
#cfunc global PrepareLogArchive "PrepareLogArchive" sptr, sptr, int, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr
; res = PrepareLogArchive(hLog, varptr(pszBaseLogFileName), cLen, varptr(plsnLow), varptr(plsnHigh), varptr(pcActualLength), varptr(poffBaseLogFileData), varptr(pcbBaseLogFileLength), varptr(plsnBase), varptr(plsnLast), varptr(plsnCurrentArchiveTail), ppvArchiveContext)
; hLog : HANDLE -> "sptr"
; pszBaseLogFileName : LPWSTR in/out -> "sptr"
; cLen : DWORD -> "int"
; plsnLow : CLS_LSN* optional -> "sptr"
; plsnHigh : CLS_LSN* optional -> "sptr"
; pcActualLength : DWORD* optional, out -> "sptr"
; poffBaseLogFileData : ULONGLONG* out -> "sptr"
; pcbBaseLogFileLength : ULONGLONG* out -> "sptr"
; plsnBase : CLS_LSN* out -> "sptr"
; plsnLast : CLS_LSN* out -> "sptr"
; plsnCurrentArchiveTail : CLS_LSN* out -> "sptr"
; ppvArchiveContext : void** out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。

出力引数:

; BOOL PrepareLogArchive(HANDLE hLog, LPWSTR pszBaseLogFileName, DWORD cLen, CLS_LSN* plsnLow, CLS_LSN* plsnHigh, DWORD* pcActualLength, ULONGLONG* poffBaseLogFileData, ULONGLONG* pcbBaseLogFileLength, CLS_LSN* plsnBase, CLS_LSN* plsnLast, CLS_LSN* plsnCurrentArchiveTail, void** ppvArchiveContext)
#uselib "clfsw32.dll"
#cfunc global PrepareLogArchive "PrepareLogArchive" intptr, var, int, var, var, var, var, var, var, var, var, intptr
; res = PrepareLogArchive(hLog, pszBaseLogFileName, cLen, plsnLow, plsnHigh, pcActualLength, poffBaseLogFileData, pcbBaseLogFileLength, plsnBase, plsnLast, plsnCurrentArchiveTail, ppvArchiveContext)
; hLog : HANDLE -> "intptr"
; pszBaseLogFileName : LPWSTR in/out -> "var"
; cLen : DWORD -> "int"
; plsnLow : CLS_LSN* optional -> "var"
; plsnHigh : CLS_LSN* optional -> "var"
; pcActualLength : DWORD* optional, out -> "var"
; poffBaseLogFileData : ULONGLONG* out -> "var"
; pcbBaseLogFileLength : ULONGLONG* out -> "var"
; plsnBase : CLS_LSN* out -> "var"
; plsnLast : CLS_LSN* out -> "var"
; plsnCurrentArchiveTail : CLS_LSN* out -> "var"
; ppvArchiveContext : void** out -> "intptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; BOOL PrepareLogArchive(HANDLE hLog, LPWSTR pszBaseLogFileName, DWORD cLen, CLS_LSN* plsnLow, CLS_LSN* plsnHigh, DWORD* pcActualLength, ULONGLONG* poffBaseLogFileData, ULONGLONG* pcbBaseLogFileLength, CLS_LSN* plsnBase, CLS_LSN* plsnLast, CLS_LSN* plsnCurrentArchiveTail, void** ppvArchiveContext)
#uselib "clfsw32.dll"
#cfunc global PrepareLogArchive "PrepareLogArchive" intptr, intptr, int, intptr, intptr, intptr, intptr, intptr, intptr, intptr, intptr, intptr
; res = PrepareLogArchive(hLog, varptr(pszBaseLogFileName), cLen, varptr(plsnLow), varptr(plsnHigh), varptr(pcActualLength), varptr(poffBaseLogFileData), varptr(pcbBaseLogFileLength), varptr(plsnBase), varptr(plsnLast), varptr(plsnCurrentArchiveTail), ppvArchiveContext)
; hLog : HANDLE -> "intptr"
; pszBaseLogFileName : LPWSTR in/out -> "intptr"
; cLen : DWORD -> "int"
; plsnLow : CLS_LSN* optional -> "intptr"
; plsnHigh : CLS_LSN* optional -> "intptr"
; pcActualLength : DWORD* optional, out -> "intptr"
; poffBaseLogFileData : ULONGLONG* out -> "intptr"
; pcbBaseLogFileLength : ULONGLONG* out -> "intptr"
; plsnBase : CLS_LSN* out -> "intptr"
; plsnLast : CLS_LSN* out -> "intptr"
; plsnCurrentArchiveTail : CLS_LSN* out -> "intptr"
; ppvArchiveContext : void** out -> "intptr"
; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。

import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	clfsw32 = windows.NewLazySystemDLL("clfsw32.dll")
	procPrepareLogArchive = clfsw32.NewProc("PrepareLogArchive")
)

// hLog (HANDLE), pszBaseLogFileName (LPWSTR in/out), cLen (DWORD), plsnLow (CLS_LSN* optional), plsnHigh (CLS_LSN* optional), pcActualLength (DWORD* optional, out), poffBaseLogFileData (ULONGLONG* out), pcbBaseLogFileLength (ULONGLONG* out), plsnBase (CLS_LSN* out), plsnLast (CLS_LSN* out), plsnCurrentArchiveTail (CLS_LSN* out), ppvArchiveContext (void** out)
r1, _, err := procPrepareLogArchive.Call(
	uintptr(hLog),
	uintptr(pszBaseLogFileName),
	uintptr(cLen),
	uintptr(plsnLow),
	uintptr(plsnHigh),
	uintptr(pcActualLength),
	uintptr(poffBaseLogFileData),
	uintptr(pcbBaseLogFileLength),
	uintptr(plsnBase),
	uintptr(plsnLast),
	uintptr(plsnCurrentArchiveTail),
	uintptr(ppvArchiveContext),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL

function PrepareLogArchive(
  hLog: THandle;   // HANDLE
  pszBaseLogFileName: PWideChar;   // LPWSTR in/out
  cLen: DWORD;   // DWORD
  plsnLow: Pointer;   // CLS_LSN* optional
  plsnHigh: Pointer;   // CLS_LSN* optional
  pcActualLength: Pointer;   // DWORD* optional, out
  poffBaseLogFileData: Pointer;   // ULONGLONG* out
  pcbBaseLogFileLength: Pointer;   // ULONGLONG* out
  plsnBase: Pointer;   // CLS_LSN* out
  plsnLast: Pointer;   // CLS_LSN* out
  plsnCurrentArchiveTail: Pointer;   // CLS_LSN* out
  ppvArchiveContext: Pointer   // void** out
): BOOL; stdcall;
  external 'clfsw32.dll' name 'PrepareLogArchive';

result := DllCall("clfsw32\PrepareLogArchive"
    , "Ptr", hLog   ; HANDLE
    , "Ptr", pszBaseLogFileName   ; LPWSTR in/out
    , "UInt", cLen   ; DWORD
    , "Ptr", plsnLow   ; CLS_LSN* optional
    , "Ptr", plsnHigh   ; CLS_LSN* optional
    , "Ptr", pcActualLength   ; DWORD* optional, out
    , "Ptr", poffBaseLogFileData   ; ULONGLONG* out
    , "Ptr", pcbBaseLogFileLength   ; ULONGLONG* out
    , "Ptr", plsnBase   ; CLS_LSN* out
    , "Ptr", plsnLast   ; CLS_LSN* out
    , "Ptr", plsnCurrentArchiveTail   ; CLS_LSN* out
    , "Ptr", ppvArchiveContext   ; void** out
    , "Int")   ; return: BOOL

●PrepareLogArchive(hLog, pszBaseLogFileName, cLen, plsnLow, plsnHigh, pcActualLength, poffBaseLogFileData, pcbBaseLogFileLength, plsnBase, plsnLast, plsnCurrentArchiveTail, ppvArchiveContext) = DLL("clfsw32.dll", "bool PrepareLogArchive(void*, char*, dword, void*, void*, void*, void*, void*, void*, void*, void*, void*)")
# 呼び出し: PrepareLogArchive(hLog, pszBaseLogFileName, cLen, plsnLow, plsnHigh, pcActualLength, poffBaseLogFileData, pcbBaseLogFileLength, plsnBase, plsnLast, plsnCurrentArchiveTail, ppvArchiveContext)
# hLog : HANDLE -> "void*"
# pszBaseLogFileName : LPWSTR in/out -> "char*"
# cLen : DWORD -> "dword"
# plsnLow : CLS_LSN* optional -> "void*"
# plsnHigh : CLS_LSN* optional -> "void*"
# pcActualLength : DWORD* optional, out -> "void*"
# poffBaseLogFileData : ULONGLONG* out -> "void*"
# pcbBaseLogFileLength : ULONGLONG* out -> "void*"
# plsnBase : CLS_LSN* out -> "void*"
# plsnLast : CLS_LSN* out -> "void*"
# plsnCurrentArchiveTail : CLS_LSN* out -> "void*"
# ppvArchiveContext : void** out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。