ホーム › Storage.FileSystem › TerminateLogArchive
TerminateLogArchive
関数CLFSログのアーカイブコンテキストを終了する。
シグネチャ
// clfsw32.dll
#include <windows.h>
BOOL TerminateLogArchive(
void* pvArchiveContext
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| pvArchiveContext | void* | inout | PrepareLogArchive から取得したアーカイブ コンテキスト。 |
戻り値の型: BOOL
公式ドキュメント
PrepareLogArchive によってログ アーカイブ コンテキスト用に元々割り当てられたシステム リソースを解放します。
戻り値
この関数が成功すると、戻り値は 0 以外になります。
この関数が失敗すると、戻り値は 0 になります。拡張エラー情報を取得するには、 GetLastError を呼び出します。次のエラー コードが返される可能性があります。
解説(Remarks)
アーカイブの完了後にこの関数を呼び出さないと、リソース リークが発生します。
出典・ライセンス: 上記「公式ドキュメント」の内容は 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 TerminateLogArchive(
void* pvArchiveContext
);[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("clfsw32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool TerminateLogArchive(
IntPtr pvArchiveContext // void* in/out
);<DllImport("clfsw32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function TerminateLogArchive(
pvArchiveContext As IntPtr ' void* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function' pvArchiveContext : void* in/out
Declare PtrSafe Function TerminateLogArchive Lib "clfsw32" ( _
ByVal pvArchiveContext As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
TerminateLogArchive = ctypes.windll.clfsw32.TerminateLogArchive
TerminateLogArchive.restype = wintypes.BOOL
TerminateLogArchive.argtypes = [
ctypes.POINTER(None), # pvArchiveContext : void* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('clfsw32.dll')
TerminateLogArchive = Fiddle::Function.new(
lib['TerminateLogArchive'],
[
Fiddle::TYPE_VOIDP, # pvArchiveContext : void* in/out
],
Fiddle::TYPE_INT)#[link(name = "clfsw32")]
extern "system" {
fn TerminateLogArchive(
pvArchiveContext: *mut () // void* 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 TerminateLogArchive(IntPtr pvArchiveContext);
"@
$api = Add-Type -MemberDefinition $sig -Name 'clfsw32_TerminateLogArchive' -Namespace Win32 -PassThru
# $api::TerminateLogArchive(pvArchiveContext)#uselib "clfsw32.dll"
#func global TerminateLogArchive "TerminateLogArchive" sptr
; TerminateLogArchive pvArchiveContext ; 戻り値は stat
; pvArchiveContext : void* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "clfsw32.dll"
#cfunc global TerminateLogArchive "TerminateLogArchive" sptr
; res = TerminateLogArchive(pvArchiveContext)
; pvArchiveContext : void* in/out -> "sptr"; BOOL TerminateLogArchive(void* pvArchiveContext)
#uselib "clfsw32.dll"
#cfunc global TerminateLogArchive "TerminateLogArchive" intptr
; res = TerminateLogArchive(pvArchiveContext)
; pvArchiveContext : void* in/out -> "intptr"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
clfsw32 = windows.NewLazySystemDLL("clfsw32.dll")
procTerminateLogArchive = clfsw32.NewProc("TerminateLogArchive")
)
// pvArchiveContext (void* in/out)
r1, _, err := procTerminateLogArchive.Call(
uintptr(pvArchiveContext),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // BOOLfunction TerminateLogArchive(
pvArchiveContext: Pointer // void* in/out
): BOOL; stdcall;
external 'clfsw32.dll' name 'TerminateLogArchive';result := DllCall("clfsw32\TerminateLogArchive"
, "Ptr", pvArchiveContext ; void* in/out
, "Int") ; return: BOOL●TerminateLogArchive(pvArchiveContext) = DLL("clfsw32.dll", "bool TerminateLogArchive(void*)")
# 呼び出し: TerminateLogArchive(pvArchiveContext)
# pvArchiveContext : void* in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "clfsw32" fn TerminateLogArchive(
pvArchiveContext: ?*anyopaque // void* in/out
) callconv(std.os.windows.WINAPI) i32;proc TerminateLogArchive(
pvArchiveContext: pointer # void* in/out
): int32 {.importc: "TerminateLogArchive", stdcall, dynlib: "clfsw32.dll".}pragma(lib, "clfsw32");
extern(Windows)
int TerminateLogArchive(
void* pvArchiveContext // void* in/out
);ccall((:TerminateLogArchive, "clfsw32.dll"), stdcall, Int32,
(Ptr{Cvoid},),
pvArchiveContext)
# pvArchiveContext : void* in/out -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t TerminateLogArchive(
void* pvArchiveContext);
]]
local clfsw32 = ffi.load("clfsw32")
-- clfsw32.TerminateLogArchive(pvArchiveContext)
-- pvArchiveContext : void* in/out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('clfsw32.dll');
const TerminateLogArchive = lib.func('__stdcall', 'TerminateLogArchive', 'int32_t', ['void *']);
// TerminateLogArchive(pvArchiveContext)
// pvArchiveContext : void* in/out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("clfsw32.dll", {
TerminateLogArchive: { parameters: ["pointer"], result: "i32" },
});
// lib.symbols.TerminateLogArchive(pvArchiveContext)
// pvArchiveContext : void* in/out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t TerminateLogArchive(
void* pvArchiveContext);
C, "clfsw32.dll");
// $ffi->TerminateLogArchive(pvArchiveContext);
// pvArchiveContext : void* 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 TerminateLogArchive(
Pointer pvArchiveContext // void* in/out
);
}@[Link("clfsw32")]
lib Libclfsw32
fun TerminateLogArchive = TerminateLogArchive(
pvArchiveContext : Void* # void* 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 TerminateLogArchiveNative = Int32 Function(Pointer<Void>);
typedef TerminateLogArchiveDart = int Function(Pointer<Void>);
final TerminateLogArchive = DynamicLibrary.open('clfsw32.dll')
.lookupFunction<TerminateLogArchiveNative, TerminateLogArchiveDart>('TerminateLogArchive');
// pvArchiveContext : void* in/out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function TerminateLogArchive(
pvArchiveContext: Pointer // void* in/out
): BOOL; stdcall;
external 'clfsw32.dll' name 'TerminateLogArchive';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "TerminateLogArchive"
c_TerminateLogArchive :: Ptr () -> IO CInt
-- pvArchiveContext : void* in/out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let terminatelogarchive =
foreign "TerminateLogArchive"
((ptr void) @-> returning int32_t)
(* pvArchiveContext : void* 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 ("TerminateLogArchive" terminate-log-archive :convention :stdcall) :int32
(pv-archive-context :pointer)) ; void* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $TerminateLogArchive = Win32::API::More->new('clfsw32',
'BOOL TerminateLogArchive(LPVOID pvArchiveContext)');
# my $ret = $TerminateLogArchive->Call($pvArchiveContext);
# pvArchiveContext : void* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
公式の関連項目
- f PrepareLogArchive — CLFSログのアーカイブ処理を準備しコンテキストを取得する。