Win32 API 日本語リファレンス
ホームSystem.EventLog › EvtClose

EvtClose

関数
イベントログAPIのハンドルを閉じる。
DLLwevtapi.dll呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

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

BOOL EvtClose(
    EVT_HANDLE Object
);

パラメーター

名前方向説明
ObjectEVT_HANDLEin閉じる、開いているイベントハンドル。

戻り値の型: BOOL

公式ドキュメント

開いているハンドルを閉じます。

戻り値

戻り値/コード 説明
TRUE
関数は成功しました。
FALSE
関数は失敗しました。エラーコードを取得するには、GetLastError 関数を呼び出してください。

解説(Remarks)

ハンドルを閉じた後は、そのハンドルを使用できません。親ハンドルを閉じると、そのハンドルを使用して作成された、開いているハンドルもすべて閉じられます。たとえば、イベントを照会すると、照会結果にはクエリに一致する各イベントのハンドルが含まれます。各イベントの処理が完了した時点でそれぞれのイベントハンドルを閉じることが推奨されますが、閉じなかった場合でも、クエリハンドルを閉じればすべてのイベントハンドルも閉じられます。

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

各言語での呼び出し定義

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

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

EvtClose = ctypes.windll.wevtapi.EvtClose
EvtClose.restype = wintypes.BOOL
EvtClose.argtypes = [
    ctypes.c_ssize_t,  # Object : EVT_HANDLE
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('wevtapi.dll')
EvtClose = Fiddle::Function.new(
  lib['EvtClose'],
  [
    Fiddle::TYPE_INTPTR_T,  # Object : EVT_HANDLE
  ],
  Fiddle::TYPE_INT)
#[link(name = "wevtapi")]
extern "system" {
    fn EvtClose(
        Object: isize  // EVT_HANDLE
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("wevtapi.dll", SetLastError = true)]
public static extern bool EvtClose(IntPtr Object);
"@
$api = Add-Type -MemberDefinition $sig -Name 'wevtapi_EvtClose' -Namespace Win32 -PassThru
# $api::EvtClose(Object)
#uselib "wevtapi.dll"
#func global EvtClose "EvtClose" sptr
; EvtClose Object   ; 戻り値は stat
; Object : EVT_HANDLE -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "wevtapi.dll"
#cfunc global EvtClose "EvtClose" sptr
; res = EvtClose(Object)
; Object : EVT_HANDLE -> "sptr"
; BOOL EvtClose(EVT_HANDLE Object)
#uselib "wevtapi.dll"
#cfunc global EvtClose "EvtClose" intptr
; res = EvtClose(Object)
; Object : EVT_HANDLE -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	wevtapi = windows.NewLazySystemDLL("wevtapi.dll")
	procEvtClose = wevtapi.NewProc("EvtClose")
)

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

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

typedef EvtCloseNative = Int32 Function(IntPtr);
typedef EvtCloseDart = int Function(int);
final EvtClose = DynamicLibrary.open('wevtapi.dll')
    .lookupFunction<EvtCloseNative, EvtCloseDart>('EvtClose');
// Object : EVT_HANDLE -> IntPtr
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function EvtClose(
  Object: NativeInt   // EVT_HANDLE
): BOOL; stdcall;
  external 'wevtapi.dll' name 'EvtClose';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let evtclose =
  foreign "EvtClose"
    (intptr_t @-> returning int32_t)
(* Object : EVT_HANDLE -> intptr_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library wevtapi (t "wevtapi.dll"))
(cffi:use-foreign-library wevtapi)

(cffi:defcfun ("EvtClose" evt-close :convention :stdcall) :int32
  (object :int64))   ; EVT_HANDLE
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $EvtClose = Win32::API::More->new('wevtapi',
    'BOOL EvtClose(LPARAM Object)');
# my $ret = $EvtClose->Call($Object);
# Object : EVT_HANDLE -> LPARAM
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。