PrepareLogArchive
関数シグネチャ
// 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 | CreateLogFile の呼び出しが成功して取得したログへのハンドルです。 このハンドルは、専用ログまたは多重化ログのいずれのハンドルでも構いません。 |
| pszBaseLogFileName | LPWSTR | inout | ベースログの完全修飾パスを受け取る、ユーザー割り当てバッファーへのポインターです。 バッファーが十分な大きさでない場合、終了時には切り詰められたファイルパスが格納され、関数は ERROR_BUFFER_OVERFLOW ステータスコードで失敗します。 ファイルパスの長さは pcActualLength が指す変数に返されます。クライアントは、十分な大きさの名前バッファーを使用して、失敗した呼び出しを再試行できます。 |
| cLen | DWORD | in | pszBaseLogFileName バッファーのサイズ(ワイド文字単位)です。 |
| plsnLow | CLS_LSN* | inoptional | ログクライアントがログアーカイブ情報を必要とするアクティブログの範囲の下端のログシーケンス番号(LSN)を指定する CLFS_LSN 構造体へのポインターです。 このパラメーターを省略した場合、範囲の下端は既定でログアーカイブテールの LSN になります。 |
| plsnHigh | CLS_LSN* | inoptional | ログクライアントがログアーカイブ情報を必要とするアクティブログの範囲の上端の LSN を指定する CLFS_LSN 構造体へのポインターです。 このパラメーターを省略した場合、範囲の上端は既定でログに次に書き込まれる LSN になります。 |
| pcActualLength | DWORD* | outoptional | ベースログパスの名前の実際の長さ(文字単位)を受け取る変数へのポインターです。 この値が cLen より大きい場合、関数は ERROR_BUFFER_OVERFLOW ステータスを返し、切り詰められたパスが pszBaseLogFileName バッファーに格納され、その他のすべての出力パラメーターには意味のある値が設定されません。 |
| poffBaseLogFileData | ULONGLONG* | out | ベースログ内でメタデータが始まるオフセットを受け取る変数へのポインターです。 ベースログ pszBaseLogFileName 内の連続した範囲は、ログメタデータの全内容、すなわち poffBaseLogFileData から pcbBaseLogFileLength までを表します。 |
| pcbBaseLogFileLength | ULONGLONG* | out | ベースログの正確な長さ(バイト単位)を指定する変数へのポインターです。 |
| plsnBase | CLS_LSN* | out | アクティブログのベースログシーケンス番号(LSN)を受け取る CLFS_LSN 構造体へのポインターです。 |
| plsnLast | CLS_LSN* | out | アクティブログ内の有効な最大の LSN を受け取る CLFS_LSN 構造体へのポインターです。 |
| plsnCurrentArchiveTail | CLS_LSN* | out | ログのアーカイブテールの現在の LSN を受け取る CLFS_LSN 構造体へのポインターです。 |
| ppvArchiveContext | void** | out | システムが割り当てるアーカイブコンテキストへのポインターを受け取る変数へのポインターです。 アーカイブコンテキストは、アーカイブイテレーターのカーソル状態とログハンドルのコンテキストを保持します。アーカイブクライアントは、TerminateLogArchive を呼び出してコンテキストを解放する責任を負います。 |
戻り値の型: BOOL
公式ドキュメント
物理ログをアーカイブ用に準備します。
戻り値
関数が成功した場合、戻り値は 0 以外の値です。
関数が失敗した場合、戻り値は 0 です。拡張エラー情報を取得するには、GetLastError を呼び出します。発生し得るエラーコードを次の一覧に示します。
解説(Remarks)
アーカイブコンテキストを解放するために TerminateLogArchive を呼び出す必要があります。呼び出さないと、メモリリークが発生する可能性があります。
TerminateLogArchive を呼び出すまで、アーカイブ中のコンテナーは再利用できません。
CreateLogFile が返すハンドルごとに、一度に 1 つのアーカイブ操作のみ実行できます。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// 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 <MarshalAs(UnmanagedType.Bool)> 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 // BOOLfunction 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)。const std = @import("std");
extern "clfsw32" fn PrepareLogArchive(
hLog: ?*anyopaque, // HANDLE
pszBaseLogFileName: [*c]u16, // LPWSTR in/out
cLen: u32, // DWORD
plsnLow: [*c]CLS_LSN, // CLS_LSN* optional
plsnHigh: [*c]CLS_LSN, // CLS_LSN* optional
pcActualLength: [*c]u32, // DWORD* optional, out
poffBaseLogFileData: [*c]u64, // ULONGLONG* out
pcbBaseLogFileLength: [*c]u64, // ULONGLONG* out
plsnBase: [*c]CLS_LSN, // CLS_LSN* out
plsnLast: [*c]CLS_LSN, // CLS_LSN* out
plsnCurrentArchiveTail: [*c]CLS_LSN, // CLS_LSN* out
ppvArchiveContext: ?*anyopaque // void** out
) callconv(std.os.windows.WINAPI) i32;proc PrepareLogArchive(
hLog: pointer, # HANDLE
pszBaseLogFileName: ptr uint16, # LPWSTR in/out
cLen: uint32, # DWORD
plsnLow: ptr CLS_LSN, # CLS_LSN* optional
plsnHigh: ptr CLS_LSN, # CLS_LSN* optional
pcActualLength: ptr uint32, # DWORD* optional, out
poffBaseLogFileData: ptr uint64, # ULONGLONG* out
pcbBaseLogFileLength: ptr uint64, # ULONGLONG* out
plsnBase: ptr CLS_LSN, # CLS_LSN* out
plsnLast: ptr CLS_LSN, # CLS_LSN* out
plsnCurrentArchiveTail: ptr CLS_LSN, # CLS_LSN* out
ppvArchiveContext: pointer # void** out
): int32 {.importc: "PrepareLogArchive", stdcall, dynlib: "clfsw32.dll".}pragma(lib, "clfsw32");
extern(Windows)
int PrepareLogArchive(
void* hLog, // HANDLE
wchar* pszBaseLogFileName, // LPWSTR in/out
uint cLen, // DWORD
CLS_LSN* plsnLow, // CLS_LSN* optional
CLS_LSN* plsnHigh, // CLS_LSN* optional
uint* pcActualLength, // DWORD* optional, out
ulong* poffBaseLogFileData, // ULONGLONG* out
ulong* pcbBaseLogFileLength, // ULONGLONG* out
CLS_LSN* plsnBase, // CLS_LSN* out
CLS_LSN* plsnLast, // CLS_LSN* out
CLS_LSN* plsnCurrentArchiveTail, // CLS_LSN* out
void** ppvArchiveContext // void** out
);ccall((:PrepareLogArchive, "clfsw32.dll"), stdcall, Int32,
(Ptr{Cvoid}, Ptr{UInt16}, UInt32, Ptr{CLS_LSN}, Ptr{CLS_LSN}, Ptr{UInt32}, Ptr{UInt64}, Ptr{UInt64}, Ptr{CLS_LSN}, Ptr{CLS_LSN}, Ptr{CLS_LSN}, Ptr{Cvoid}),
hLog, pszBaseLogFileName, cLen, plsnLow, plsnHigh, pcActualLength, poffBaseLogFileData, pcbBaseLogFileLength, plsnBase, plsnLast, plsnCurrentArchiveTail, ppvArchiveContext)
# hLog : HANDLE -> Ptr{Cvoid}
# pszBaseLogFileName : LPWSTR in/out -> Ptr{UInt16}
# cLen : DWORD -> UInt32
# plsnLow : CLS_LSN* optional -> Ptr{CLS_LSN}
# plsnHigh : CLS_LSN* optional -> Ptr{CLS_LSN}
# pcActualLength : DWORD* optional, out -> Ptr{UInt32}
# poffBaseLogFileData : ULONGLONG* out -> Ptr{UInt64}
# pcbBaseLogFileLength : ULONGLONG* out -> Ptr{UInt64}
# plsnBase : CLS_LSN* out -> Ptr{CLS_LSN}
# plsnLast : CLS_LSN* out -> Ptr{CLS_LSN}
# plsnCurrentArchiveTail : CLS_LSN* out -> Ptr{CLS_LSN}
# ppvArchiveContext : void** out -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t PrepareLogArchive(
void* hLog,
uint16_t* pszBaseLogFileName,
uint32_t cLen,
void* plsnLow,
void* plsnHigh,
uint32_t* pcActualLength,
uint64_t* poffBaseLogFileData,
uint64_t* pcbBaseLogFileLength,
void* plsnBase,
void* plsnLast,
void* plsnCurrentArchiveTail,
void** ppvArchiveContext);
]]
local clfsw32 = ffi.load("clfsw32")
-- clfsw32.PrepareLogArchive(hLog, pszBaseLogFileName, cLen, plsnLow, plsnHigh, pcActualLength, poffBaseLogFileData, pcbBaseLogFileLength, plsnBase, plsnLast, plsnCurrentArchiveTail, ppvArchiveContext)
-- 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
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('clfsw32.dll');
const PrepareLogArchive = lib.func('__stdcall', 'PrepareLogArchive', 'int32_t', ['void *', 'uint16_t *', 'uint32_t', 'void *', 'void *', 'uint32_t *', 'uint64_t *', 'uint64_t *', 'void *', 'void *', 'void *', 'void *']);
// PrepareLogArchive(hLog, pszBaseLogFileName, cLen, plsnLow, plsnHigh, pcActualLength, poffBaseLogFileData, pcbBaseLogFileLength, plsnBase, plsnLast, plsnCurrentArchiveTail, ppvArchiveContext)
// hLog : HANDLE -> 'void *'
// pszBaseLogFileName : LPWSTR in/out -> 'uint16_t *'
// cLen : DWORD -> 'uint32_t'
// plsnLow : CLS_LSN* optional -> 'void *'
// plsnHigh : CLS_LSN* optional -> 'void *'
// pcActualLength : DWORD* optional, out -> 'uint32_t *'
// poffBaseLogFileData : ULONGLONG* out -> 'uint64_t *'
// pcbBaseLogFileLength : ULONGLONG* out -> 'uint64_t *'
// plsnBase : CLS_LSN* out -> 'void *'
// plsnLast : CLS_LSN* out -> 'void *'
// plsnCurrentArchiveTail : CLS_LSN* out -> 'void *'
// ppvArchiveContext : void** out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("clfsw32.dll", {
PrepareLogArchive: { parameters: ["pointer", "buffer", "u32", "pointer", "pointer", "pointer", "pointer", "pointer", "pointer", "pointer", "pointer", "pointer"], result: "i32" },
});
// lib.symbols.PrepareLogArchive(hLog, pszBaseLogFileName, cLen, plsnLow, plsnHigh, pcActualLength, poffBaseLogFileData, pcbBaseLogFileLength, plsnBase, plsnLast, plsnCurrentArchiveTail, ppvArchiveContext)
// hLog : HANDLE -> "pointer"
// pszBaseLogFileName : LPWSTR in/out -> "buffer"
// cLen : DWORD -> "u32"
// plsnLow : CLS_LSN* optional -> "pointer"
// plsnHigh : CLS_LSN* optional -> "pointer"
// pcActualLength : DWORD* optional, out -> "pointer"
// poffBaseLogFileData : ULONGLONG* out -> "pointer"
// pcbBaseLogFileLength : ULONGLONG* out -> "pointer"
// plsnBase : CLS_LSN* out -> "pointer"
// plsnLast : CLS_LSN* out -> "pointer"
// plsnCurrentArchiveTail : CLS_LSN* out -> "pointer"
// ppvArchiveContext : void** out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t PrepareLogArchive(
void* hLog,
uint16_t* pszBaseLogFileName,
uint32_t cLen,
void* plsnLow,
void* plsnHigh,
uint32_t* pcActualLength,
uint64_t* poffBaseLogFileData,
uint64_t* pcbBaseLogFileLength,
void* plsnBase,
void* plsnLast,
void* plsnCurrentArchiveTail,
void** ppvArchiveContext);
C, "clfsw32.dll");
// $ffi->PrepareLogArchive(hLog, pszBaseLogFileName, cLen, plsnLow, plsnHigh, pcActualLength, poffBaseLogFileData, pcbBaseLogFileLength, plsnBase, plsnLast, plsnCurrentArchiveTail, ppvArchiveContext);
// 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
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;
public interface Clfsw32 extends StdCallLibrary {
Clfsw32 INSTANCE = Native.load("clfsw32", Clfsw32.class);
boolean PrepareLogArchive(
Pointer hLog, // HANDLE
char[] pszBaseLogFileName, // LPWSTR in/out
int cLen, // DWORD
Pointer plsnLow, // CLS_LSN* optional
Pointer plsnHigh, // CLS_LSN* optional
IntByReference pcActualLength, // DWORD* optional, out
LongByReference poffBaseLogFileData, // ULONGLONG* out
LongByReference pcbBaseLogFileLength, // ULONGLONG* out
Pointer plsnBase, // CLS_LSN* out
Pointer plsnLast, // CLS_LSN* out
Pointer plsnCurrentArchiveTail, // CLS_LSN* out
Pointer ppvArchiveContext // void** out
);
}@[Link("clfsw32")]
lib Libclfsw32
fun PrepareLogArchive = PrepareLogArchive(
hLog : Void*, # HANDLE
pszBaseLogFileName : UInt16*, # LPWSTR in/out
cLen : UInt32, # DWORD
plsnLow : CLS_LSN*, # CLS_LSN* optional
plsnHigh : CLS_LSN*, # CLS_LSN* optional
pcActualLength : UInt32*, # DWORD* optional, out
poffBaseLogFileData : UInt64*, # ULONGLONG* out
pcbBaseLogFileLength : UInt64*, # ULONGLONG* out
plsnBase : CLS_LSN*, # CLS_LSN* out
plsnLast : CLS_LSN*, # CLS_LSN* out
plsnCurrentArchiveTail : CLS_LSN*, # CLS_LSN* out
ppvArchiveContext : Void** # void** out
) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef PrepareLogArchiveNative = Int32 Function(Pointer<Void>, Pointer<Utf16>, Uint32, Pointer<Void>, Pointer<Void>, Pointer<Uint32>, Pointer<Uint64>, Pointer<Uint64>, Pointer<Void>, Pointer<Void>, Pointer<Void>, Pointer<Void>);
typedef PrepareLogArchiveDart = int Function(Pointer<Void>, Pointer<Utf16>, int, Pointer<Void>, Pointer<Void>, Pointer<Uint32>, Pointer<Uint64>, Pointer<Uint64>, Pointer<Void>, Pointer<Void>, Pointer<Void>, Pointer<Void>);
final PrepareLogArchive = DynamicLibrary.open('clfsw32.dll')
.lookupFunction<PrepareLogArchiveNative, PrepareLogArchiveDart>('PrepareLogArchive');
// hLog : HANDLE -> Pointer<Void>
// pszBaseLogFileName : LPWSTR in/out -> Pointer<Utf16>
// cLen : DWORD -> Uint32
// plsnLow : CLS_LSN* optional -> Pointer<Void>
// plsnHigh : CLS_LSN* optional -> Pointer<Void>
// pcActualLength : DWORD* optional, out -> Pointer<Uint32>
// poffBaseLogFileData : ULONGLONG* out -> Pointer<Uint64>
// pcbBaseLogFileLength : ULONGLONG* out -> Pointer<Uint64>
// plsnBase : CLS_LSN* out -> Pointer<Void>
// plsnLast : CLS_LSN* out -> Pointer<Void>
// plsnCurrentArchiveTail : CLS_LSN* out -> Pointer<Void>
// ppvArchiveContext : void** out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
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';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "PrepareLogArchive"
c_PrepareLogArchive :: Ptr () -> CWString -> Word32 -> Ptr () -> Ptr () -> Ptr Word32 -> Ptr Word64 -> Ptr Word64 -> Ptr () -> Ptr () -> Ptr () -> Ptr () -> IO CInt
-- hLog : HANDLE -> Ptr ()
-- pszBaseLogFileName : LPWSTR in/out -> CWString
-- cLen : DWORD -> Word32
-- plsnLow : CLS_LSN* optional -> Ptr ()
-- plsnHigh : CLS_LSN* optional -> Ptr ()
-- pcActualLength : DWORD* optional, out -> Ptr Word32
-- poffBaseLogFileData : ULONGLONG* out -> Ptr Word64
-- pcbBaseLogFileLength : ULONGLONG* out -> Ptr Word64
-- plsnBase : CLS_LSN* out -> Ptr ()
-- plsnLast : CLS_LSN* out -> Ptr ()
-- plsnCurrentArchiveTail : CLS_LSN* out -> Ptr ()
-- ppvArchiveContext : void** out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let preparelogarchive =
foreign "PrepareLogArchive"
((ptr void) @-> (ptr uint16_t) @-> uint32_t @-> (ptr void) @-> (ptr void) @-> (ptr uint32_t) @-> (ptr uint64_t) @-> (ptr uint64_t) @-> (ptr void) @-> (ptr void) @-> (ptr void) @-> (ptr void) @-> returning int32_t)
(* hLog : HANDLE -> (ptr void) *)
(* pszBaseLogFileName : LPWSTR in/out -> (ptr uint16_t) *)
(* cLen : DWORD -> uint32_t *)
(* plsnLow : CLS_LSN* optional -> (ptr void) *)
(* plsnHigh : CLS_LSN* optional -> (ptr void) *)
(* pcActualLength : DWORD* optional, out -> (ptr uint32_t) *)
(* poffBaseLogFileData : ULONGLONG* out -> (ptr uint64_t) *)
(* pcbBaseLogFileLength : ULONGLONG* out -> (ptr uint64_t) *)
(* plsnBase : CLS_LSN* out -> (ptr void) *)
(* plsnLast : CLS_LSN* out -> (ptr void) *)
(* plsnCurrentArchiveTail : CLS_LSN* out -> (ptr void) *)
(* ppvArchiveContext : void** out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library clfsw32 (t "clfsw32.dll"))
(cffi:use-foreign-library clfsw32)
(cffi:defcfun ("PrepareLogArchive" prepare-log-archive :convention :stdcall) :int32
(h-log :pointer) ; HANDLE
(psz-base-log-file-name :pointer) ; LPWSTR in/out
(c-len :uint32) ; DWORD
(plsn-low :pointer) ; CLS_LSN* optional
(plsn-high :pointer) ; CLS_LSN* optional
(pc-actual-length :pointer) ; DWORD* optional, out
(poff-base-log-file-data :pointer) ; ULONGLONG* out
(pcb-base-log-file-length :pointer) ; ULONGLONG* out
(plsn-base :pointer) ; CLS_LSN* out
(plsn-last :pointer) ; CLS_LSN* out
(plsn-current-archive-tail :pointer) ; CLS_LSN* out
(ppv-archive-context :pointer)) ; void** out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $PrepareLogArchive = Win32::API::More->new('clfsw32',
'BOOL PrepareLogArchive(HANDLE hLog, LPWSTR pszBaseLogFileName, DWORD cLen, LPVOID plsnLow, LPVOID plsnHigh, LPVOID pcActualLength, LPVOID poffBaseLogFileData, LPVOID pcbBaseLogFileLength, LPVOID plsnBase, LPVOID plsnLast, LPVOID plsnCurrentArchiveTail, LPVOID ppvArchiveContext)');
# my $ret = $PrepareLogArchive->Call($hLog, $pszBaseLogFileName, $cLen, $plsnLow, $plsnHigh, $pcActualLength, $poffBaseLogFileData, $pcbBaseLogFileLength, $plsnBase, $plsnLast, $plsnCurrentArchiveTail, $ppvArchiveContext);
# hLog : HANDLE -> HANDLE
# pszBaseLogFileName : LPWSTR in/out -> LPWSTR
# cLen : DWORD -> DWORD
# plsnLow : CLS_LSN* optional -> LPVOID
# plsnHigh : CLS_LSN* optional -> LPVOID
# pcActualLength : DWORD* optional, out -> LPVOID
# poffBaseLogFileData : ULONGLONG* out -> LPVOID
# pcbBaseLogFileLength : ULONGLONG* out -> LPVOID
# plsnBase : CLS_LSN* out -> LPVOID
# plsnLast : CLS_LSN* out -> LPVOID
# plsnCurrentArchiveTail : CLS_LSN* out -> LPVOID
# ppvArchiveContext : void** out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
- f GetNextLogArchiveExtent — CLFSログアーカイブの次のエクステント記述子を取得する。
- f ReadLogArchiveMetadata — CLFSログアーカイブのメタデータを読み取る。
- f TerminateLogArchive — CLFSログのアーカイブコンテキストを終了する。