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