ホーム › Storage.FileSystem › TruncateLog
TruncateLog
関数マーシャリング領域のCLFSログを指定LSNで切り詰める。
シグネチャ
// clfsw32.dll
#include <windows.h>
BOOL TruncateLog(
void* pvMarshal,
CLS_LSN* plsnEnd,
OVERLAPPED* lpOverlapped // optional
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| pvMarshal | void* | in | CreateLogMarshallingArea 関数を呼び出して割り当てた、不透明なマーシャリングコンテキストへのポインターです。 |
| plsnEnd | CLS_LSN* | in | ログの新しい終端を指定する CLFS_LSN 構造体へのポインターです。 LSN は、ログの基本ログシーケンス番号 (LSN) からログの最後の LSN までの範囲内である必要があります。 |
| lpOverlapped | OVERLAPPED* | inoutoptional | 予約済みです。 Reserved には NULL を設定してください。 |
戻り値の型: BOOL
公式ドキュメント
ログを切り詰めます。この関数はログの終端を指定した値に設定します。
戻り値
関数が成功した場合、戻り値は 0 以外の値になります。
関数が失敗した場合、戻り値は 0 になります。拡張エラー情報を取得するには、 GetLastError を呼び出します。次の一覧は、発生し得るエラーコードを示しています。
解説(Remarks)
ボリュームのセクターサイズが 512 バイトを超える場合、TruncateLog は ERROR_NOT_SUPPORTED を返します。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// clfsw32.dll
#include <windows.h>
BOOL TruncateLog(
void* pvMarshal,
CLS_LSN* plsnEnd,
OVERLAPPED* lpOverlapped // optional
);[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("clfsw32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool TruncateLog(
IntPtr pvMarshal, // void*
IntPtr plsnEnd, // CLS_LSN*
IntPtr lpOverlapped // OVERLAPPED* optional, in/out
);<DllImport("clfsw32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function TruncateLog(
pvMarshal As IntPtr, ' void*
plsnEnd As IntPtr, ' CLS_LSN*
lpOverlapped As IntPtr ' OVERLAPPED* optional, in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function' pvMarshal : void*
' plsnEnd : CLS_LSN*
' lpOverlapped : OVERLAPPED* optional, in/out
Declare PtrSafe Function TruncateLog Lib "clfsw32" ( _
ByVal pvMarshal As LongPtr, _
ByVal plsnEnd As LongPtr, _
ByVal lpOverlapped As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
TruncateLog = ctypes.windll.clfsw32.TruncateLog
TruncateLog.restype = wintypes.BOOL
TruncateLog.argtypes = [
ctypes.POINTER(None), # pvMarshal : void*
ctypes.c_void_p, # plsnEnd : CLS_LSN*
ctypes.c_void_p, # lpOverlapped : OVERLAPPED* optional, in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('clfsw32.dll')
TruncateLog = Fiddle::Function.new(
lib['TruncateLog'],
[
Fiddle::TYPE_VOIDP, # pvMarshal : void*
Fiddle::TYPE_VOIDP, # plsnEnd : CLS_LSN*
Fiddle::TYPE_VOIDP, # lpOverlapped : OVERLAPPED* optional, in/out
],
Fiddle::TYPE_INT)#[link(name = "clfsw32")]
extern "system" {
fn TruncateLog(
pvMarshal: *mut (), // void*
plsnEnd: *mut CLS_LSN, // CLS_LSN*
lpOverlapped: *mut OVERLAPPED // OVERLAPPED* optional, 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 TruncateLog(IntPtr pvMarshal, IntPtr plsnEnd, IntPtr lpOverlapped);
"@
$api = Add-Type -MemberDefinition $sig -Name 'clfsw32_TruncateLog' -Namespace Win32 -PassThru
# $api::TruncateLog(pvMarshal, plsnEnd, lpOverlapped)#uselib "clfsw32.dll"
#func global TruncateLog "TruncateLog" sptr, sptr, sptr
; TruncateLog pvMarshal, varptr(plsnEnd), varptr(lpOverlapped) ; 戻り値は stat
; pvMarshal : void* -> "sptr"
; plsnEnd : CLS_LSN* -> "sptr"
; lpOverlapped : OVERLAPPED* optional, in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。出力引数:
#uselib "clfsw32.dll" #cfunc global TruncateLog "TruncateLog" sptr, var, var ; res = TruncateLog(pvMarshal, plsnEnd, lpOverlapped) ; pvMarshal : void* -> "sptr" ; plsnEnd : CLS_LSN* -> "var" ; lpOverlapped : OVERLAPPED* optional, in/out -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "clfsw32.dll" #cfunc global TruncateLog "TruncateLog" sptr, sptr, sptr ; res = TruncateLog(pvMarshal, varptr(plsnEnd), varptr(lpOverlapped)) ; pvMarshal : void* -> "sptr" ; plsnEnd : CLS_LSN* -> "sptr" ; lpOverlapped : OVERLAPPED* optional, in/out -> "sptr" ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
出力引数:
; BOOL TruncateLog(void* pvMarshal, CLS_LSN* plsnEnd, OVERLAPPED* lpOverlapped) #uselib "clfsw32.dll" #cfunc global TruncateLog "TruncateLog" intptr, var, var ; res = TruncateLog(pvMarshal, plsnEnd, lpOverlapped) ; pvMarshal : void* -> "intptr" ; plsnEnd : CLS_LSN* -> "var" ; lpOverlapped : OVERLAPPED* optional, in/out -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; BOOL TruncateLog(void* pvMarshal, CLS_LSN* plsnEnd, OVERLAPPED* lpOverlapped) #uselib "clfsw32.dll" #cfunc global TruncateLog "TruncateLog" intptr, intptr, intptr ; res = TruncateLog(pvMarshal, varptr(plsnEnd), varptr(lpOverlapped)) ; pvMarshal : void* -> "intptr" ; plsnEnd : CLS_LSN* -> "intptr" ; lpOverlapped : OVERLAPPED* optional, in/out -> "intptr" ; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。
import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
clfsw32 = windows.NewLazySystemDLL("clfsw32.dll")
procTruncateLog = clfsw32.NewProc("TruncateLog")
)
// pvMarshal (void*), plsnEnd (CLS_LSN*), lpOverlapped (OVERLAPPED* optional, in/out)
r1, _, err := procTruncateLog.Call(
uintptr(pvMarshal),
uintptr(plsnEnd),
uintptr(lpOverlapped),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // BOOLfunction TruncateLog(
pvMarshal: Pointer; // void*
plsnEnd: Pointer; // CLS_LSN*
lpOverlapped: Pointer // OVERLAPPED* optional, in/out
): BOOL; stdcall;
external 'clfsw32.dll' name 'TruncateLog';result := DllCall("clfsw32\TruncateLog"
, "Ptr", pvMarshal ; void*
, "Ptr", plsnEnd ; CLS_LSN*
, "Ptr", lpOverlapped ; OVERLAPPED* optional, in/out
, "Int") ; return: BOOL●TruncateLog(pvMarshal, plsnEnd, lpOverlapped) = DLL("clfsw32.dll", "bool TruncateLog(void*, void*, void*)")
# 呼び出し: TruncateLog(pvMarshal, plsnEnd, lpOverlapped)
# pvMarshal : void* -> "void*"
# plsnEnd : CLS_LSN* -> "void*"
# lpOverlapped : OVERLAPPED* optional, in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "clfsw32" fn TruncateLog(
pvMarshal: ?*anyopaque, // void*
plsnEnd: [*c]CLS_LSN, // CLS_LSN*
lpOverlapped: [*c]OVERLAPPED // OVERLAPPED* optional, in/out
) callconv(std.os.windows.WINAPI) i32;proc TruncateLog(
pvMarshal: pointer, # void*
plsnEnd: ptr CLS_LSN, # CLS_LSN*
lpOverlapped: ptr OVERLAPPED # OVERLAPPED* optional, in/out
): int32 {.importc: "TruncateLog", stdcall, dynlib: "clfsw32.dll".}pragma(lib, "clfsw32");
extern(Windows)
int TruncateLog(
void* pvMarshal, // void*
CLS_LSN* plsnEnd, // CLS_LSN*
OVERLAPPED* lpOverlapped // OVERLAPPED* optional, in/out
);ccall((:TruncateLog, "clfsw32.dll"), stdcall, Int32,
(Ptr{Cvoid}, Ptr{CLS_LSN}, Ptr{OVERLAPPED}),
pvMarshal, plsnEnd, lpOverlapped)
# pvMarshal : void* -> Ptr{Cvoid}
# plsnEnd : CLS_LSN* -> Ptr{CLS_LSN}
# lpOverlapped : OVERLAPPED* optional, in/out -> Ptr{OVERLAPPED}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t TruncateLog(
void* pvMarshal,
void* plsnEnd,
void* lpOverlapped);
]]
local clfsw32 = ffi.load("clfsw32")
-- clfsw32.TruncateLog(pvMarshal, plsnEnd, lpOverlapped)
-- pvMarshal : void*
-- plsnEnd : CLS_LSN*
-- lpOverlapped : OVERLAPPED* optional, in/out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('clfsw32.dll');
const TruncateLog = lib.func('__stdcall', 'TruncateLog', 'int32_t', ['void *', 'void *', 'void *']);
// TruncateLog(pvMarshal, plsnEnd, lpOverlapped)
// pvMarshal : void* -> 'void *'
// plsnEnd : CLS_LSN* -> 'void *'
// lpOverlapped : OVERLAPPED* optional, in/out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("clfsw32.dll", {
TruncateLog: { parameters: ["pointer", "pointer", "pointer"], result: "i32" },
});
// lib.symbols.TruncateLog(pvMarshal, plsnEnd, lpOverlapped)
// pvMarshal : void* -> "pointer"
// plsnEnd : CLS_LSN* -> "pointer"
// lpOverlapped : OVERLAPPED* optional, in/out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t TruncateLog(
void* pvMarshal,
void* plsnEnd,
void* lpOverlapped);
C, "clfsw32.dll");
// $ffi->TruncateLog(pvMarshal, plsnEnd, lpOverlapped);
// pvMarshal : void*
// plsnEnd : CLS_LSN*
// lpOverlapped : OVERLAPPED* optional, in/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 TruncateLog(
Pointer pvMarshal, // void*
Pointer plsnEnd, // CLS_LSN*
Pointer lpOverlapped // OVERLAPPED* optional, in/out
);
}@[Link("clfsw32")]
lib Libclfsw32
fun TruncateLog = TruncateLog(
pvMarshal : Void*, # void*
plsnEnd : CLS_LSN*, # CLS_LSN*
lpOverlapped : OVERLAPPED* # OVERLAPPED* optional, in/out
) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef TruncateLogNative = Int32 Function(Pointer<Void>, Pointer<Void>, Pointer<Void>);
typedef TruncateLogDart = int Function(Pointer<Void>, Pointer<Void>, Pointer<Void>);
final TruncateLog = DynamicLibrary.open('clfsw32.dll')
.lookupFunction<TruncateLogNative, TruncateLogDart>('TruncateLog');
// pvMarshal : void* -> Pointer<Void>
// plsnEnd : CLS_LSN* -> Pointer<Void>
// lpOverlapped : OVERLAPPED* optional, in/out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function TruncateLog(
pvMarshal: Pointer; // void*
plsnEnd: Pointer; // CLS_LSN*
lpOverlapped: Pointer // OVERLAPPED* optional, in/out
): BOOL; stdcall;
external 'clfsw32.dll' name 'TruncateLog';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "TruncateLog"
c_TruncateLog :: Ptr () -> Ptr () -> Ptr () -> IO CInt
-- pvMarshal : void* -> Ptr ()
-- plsnEnd : CLS_LSN* -> Ptr ()
-- lpOverlapped : OVERLAPPED* optional, in/out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let truncatelog =
foreign "TruncateLog"
((ptr void) @-> (ptr void) @-> (ptr void) @-> returning int32_t)
(* pvMarshal : void* -> (ptr void) *)
(* plsnEnd : CLS_LSN* -> (ptr void) *)
(* lpOverlapped : OVERLAPPED* optional, in/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 ("TruncateLog" truncate-log :convention :stdcall) :int32
(pv-marshal :pointer) ; void*
(plsn-end :pointer) ; CLS_LSN*
(lp-overlapped :pointer)) ; OVERLAPPED* optional, in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $TruncateLog = Win32::API::More->new('clfsw32',
'BOOL TruncateLog(LPVOID pvMarshal, LPVOID plsnEnd, LPVOID lpOverlapped)');
# my $ret = $TruncateLog->Call($pvMarshal, $plsnEnd, $lpOverlapped);
# pvMarshal : void* -> LPVOID
# plsnEnd : CLS_LSN* -> LPVOID
# lpOverlapped : OVERLAPPED* optional, in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。