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

EvtCancel

関数
進行中のイベントログ操作をキャンセルする。
DLLwevtapi.dll呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

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

BOOL EvtCancel(
    EVT_HANDLE Object   // optional
);

パラメーター

名前方向説明
ObjectEVT_HANDLEinoptional

操作をキャンセルするハンドルです。次の操作をキャンセルできます。

EvtClearLogEvtExportLogEvtQueryEvtSubscribe の各操作をキャンセルするには、セッション ハンドルを渡す必要があります。既定のセッション (ローカル セッション) を指定するには、このパラメーターに NULL を設定します。

戻り値の型: BOOL

公式ドキュメント

ハンドルに対する保留中のすべての操作をキャンセルします。

戻り値

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

解説(Remarks)

長時間実行される操作をキャンセルするには、この関数を使用します。たとえば、 EvtNext 関数の呼び出しは、数千件のイベント レコードを フィルタリングするため、理論的には長時間を要する可能性があります。 EvtCancel を呼び出すと、 EvtNext 関数による以降のイベント レコードの処理が停止されます。ただし、 この関数が操作を直ちに停止できるとは限らない点に注意してください。

完了したら、EvtClose 関数を呼び出して ハンドルを閉じる必要があります。

次の手順では、長時間実行される操作をキャンセルする方法を説明します。

長時間実行される操作をキャンセルするには

  1. スレッド A が長時間実行される操作 (たとえば EvtSeek 関数) を呼び出します。
  2. スレッド B がすべての操作をキャンセルして閉じたいと考え、 EvtCancel 関数を呼び出します。
  3. 続いてスレッド B は、保留中のすべての呼び出しが完了するのを (スレッド A と同期して) 待機します。 EvtCancel 関数が呼び出されたため、EvtCancel の呼び出し後、スレッド A はまもなく 完了するはずです。
  4. スレッド A が操作 (EvtSeek) を完全に完了した後、 スレッド B は EvtClose 関数を使用して クエリ結果ハンドルを閉じることができます。
停止された操作は、エラー コード ERROR_CANCELLED を返します。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

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

BOOL EvtCancel(
    EVT_HANDLE Object   // optional
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("wevtapi.dll", SetLastError = true, ExactSpelling = true)]
static extern bool EvtCancel(
    IntPtr Object   // EVT_HANDLE optional
);
<DllImport("wevtapi.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function EvtCancel(
    [Object] As IntPtr   ' EVT_HANDLE optional
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' Object : EVT_HANDLE optional
Declare PtrSafe Function EvtCancel 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

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

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

var (
	wevtapi = windows.NewLazySystemDLL("wevtapi.dll")
	procEvtCancel = wevtapi.NewProc("EvtCancel")
)

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

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

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

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

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

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