Win32 API 日本語リファレンス
ホームStorage.FileSystem › DeleteLogByHandle

DeleteLogByHandle

関数
ハンドルで指定したCLFSログを削除対象に設定する。
DLLclfsw32.dll呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

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

BOOL DeleteLogByHandle(
    HANDLE hLog
);

パラメーター

名前方向説明
hLogHANDLEinCreateLogFile の呼び出しが成功して取得した、オープン中のログへのハンドルです。ログを削除するには、そのログが DELETE アクセス権を指定して作成されている必要があります。そうでない場合、ログを削除できません。

戻り値の型: BOOL

公式ドキュメント

指定されたログを削除対象としてマークします。ログは、そのログへのすべてのハンドル、マーシャリング領域、および読み取りコンテキストが閉じられた時点で実際に削除されます。ログが物理ログである場合は、その基になるコンテナーも削除されます。

戻り値

関数が成功した場合、戻り値は 0 以外の値になります。

関数が失敗した場合、戻り値は 0 になります。拡張エラー情報を取得するには、 GetLastError を呼び出します。発生する可能性のあるエラーコードを次の一覧に示します。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

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

BOOL DeleteLogByHandle(
    HANDLE hLog
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("clfsw32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool DeleteLogByHandle(
    IntPtr hLog   // HANDLE
);
<DllImport("clfsw32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function DeleteLogByHandle(
    hLog As IntPtr   ' HANDLE
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' hLog : HANDLE
Declare PtrSafe Function DeleteLogByHandle Lib "clfsw32" ( _
    ByVal hLog As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

DeleteLogByHandle = ctypes.windll.clfsw32.DeleteLogByHandle
DeleteLogByHandle.restype = wintypes.BOOL
DeleteLogByHandle.argtypes = [
    wintypes.HANDLE,  # hLog : HANDLE
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('clfsw32.dll')
DeleteLogByHandle = Fiddle::Function.new(
  lib['DeleteLogByHandle'],
  [
    Fiddle::TYPE_VOIDP,  # hLog : HANDLE
  ],
  Fiddle::TYPE_INT)
#[link(name = "clfsw32")]
extern "system" {
    fn DeleteLogByHandle(
        hLog: *mut core::ffi::c_void  // HANDLE
    ) -> 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 DeleteLogByHandle(IntPtr hLog);
"@
$api = Add-Type -MemberDefinition $sig -Name 'clfsw32_DeleteLogByHandle' -Namespace Win32 -PassThru
# $api::DeleteLogByHandle(hLog)
#uselib "clfsw32.dll"
#func global DeleteLogByHandle "DeleteLogByHandle" sptr
; DeleteLogByHandle hLog   ; 戻り値は stat
; hLog : HANDLE -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "clfsw32.dll"
#cfunc global DeleteLogByHandle "DeleteLogByHandle" sptr
; res = DeleteLogByHandle(hLog)
; hLog : HANDLE -> "sptr"
; BOOL DeleteLogByHandle(HANDLE hLog)
#uselib "clfsw32.dll"
#cfunc global DeleteLogByHandle "DeleteLogByHandle" intptr
; res = DeleteLogByHandle(hLog)
; hLog : HANDLE -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	clfsw32 = windows.NewLazySystemDLL("clfsw32.dll")
	procDeleteLogByHandle = clfsw32.NewProc("DeleteLogByHandle")
)

// hLog (HANDLE)
r1, _, err := procDeleteLogByHandle.Call(
	uintptr(hLog),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function DeleteLogByHandle(
  hLog: THandle   // HANDLE
): BOOL; stdcall;
  external 'clfsw32.dll' name 'DeleteLogByHandle';
result := DllCall("clfsw32\DeleteLogByHandle"
    , "Ptr", hLog   ; HANDLE
    , "Int")   ; return: BOOL
●DeleteLogByHandle(hLog) = DLL("clfsw32.dll", "bool DeleteLogByHandle(void*)")
# 呼び出し: DeleteLogByHandle(hLog)
# hLog : HANDLE -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "clfsw32" fn DeleteLogByHandle(
    hLog: ?*anyopaque // HANDLE
) callconv(std.os.windows.WINAPI) i32;
proc DeleteLogByHandle(
    hLog: pointer  # HANDLE
): int32 {.importc: "DeleteLogByHandle", stdcall, dynlib: "clfsw32.dll".}
pragma(lib, "clfsw32");
extern(Windows)
int DeleteLogByHandle(
    void* hLog   // HANDLE
);
ccall((:DeleteLogByHandle, "clfsw32.dll"), stdcall, Int32,
      (Ptr{Cvoid},),
      hLog)
# hLog : HANDLE -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t DeleteLogByHandle(
    void* hLog);
]]
local clfsw32 = ffi.load("clfsw32")
-- clfsw32.DeleteLogByHandle(hLog)
-- hLog : HANDLE
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('clfsw32.dll');
const DeleteLogByHandle = lib.func('__stdcall', 'DeleteLogByHandle', 'int32_t', ['void *']);
// DeleteLogByHandle(hLog)
// hLog : HANDLE -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("clfsw32.dll", {
  DeleteLogByHandle: { parameters: ["pointer"], result: "i32" },
});
// lib.symbols.DeleteLogByHandle(hLog)
// hLog : HANDLE -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t DeleteLogByHandle(
    void* hLog);
C, "clfsw32.dll");
// $ffi->DeleteLogByHandle(hLog);
// hLog : HANDLE
// 構造体/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 DeleteLogByHandle(
        Pointer hLog   // HANDLE
    );
}
@[Link("clfsw32")]
lib Libclfsw32
  fun DeleteLogByHandle = DeleteLogByHandle(
    hLog : Void*   # HANDLE
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef DeleteLogByHandleNative = Int32 Function(Pointer<Void>);
typedef DeleteLogByHandleDart = int Function(Pointer<Void>);
final DeleteLogByHandle = DynamicLibrary.open('clfsw32.dll')
    .lookupFunction<DeleteLogByHandleNative, DeleteLogByHandleDart>('DeleteLogByHandle');
// hLog : HANDLE -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function DeleteLogByHandle(
  hLog: THandle   // HANDLE
): BOOL; stdcall;
  external 'clfsw32.dll' name 'DeleteLogByHandle';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "DeleteLogByHandle"
  c_DeleteLogByHandle :: Ptr () -> IO CInt
-- hLog : HANDLE -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let deletelogbyhandle =
  foreign "DeleteLogByHandle"
    ((ptr void) @-> returning int32_t)
(* hLog : HANDLE -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library clfsw32 (t "clfsw32.dll"))
(cffi:use-foreign-library clfsw32)

(cffi:defcfun ("DeleteLogByHandle" delete-log-by-handle :convention :stdcall) :int32
  (h-log :pointer))   ; HANDLE
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $DeleteLogByHandle = Win32::API::More->new('clfsw32',
    'BOOL DeleteLogByHandle(HANDLE hLog)');
# my $ret = $DeleteLogByHandle->Call($hLog);
# hLog : HANDLE -> HANDLE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目