ホーム › System.Threading › DeleteTimerQueueTimer

DeleteTimerQueueTimer

関数

タイマーキュータイマーを削除する。

DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

BOOL DeleteTimerQueueTimer(
    HANDLE TimerQueue,   // optional
    HANDLE Timer,
    HANDLE CompletionEvent   // optional
);

パラメーター

名前	型	方向	説明
TimerQueue	HANDLE	inoptional	タイマーキューへのハンドル。このハンドルは CreateTimerQueue 関数によって返されます。タイマーが既定のタイマーキューを使用して作成された場合、このパラメーターは NULL にする必要があります。
Timer	HANDLE	in	タイマーキュータイマーへのハンドル。このハンドルは CreateTimerQueueTimer 関数によって返されます。
CompletionEvent	HANDLE	inoptional	システムがタイマーをキャンセルし、すべてのコールバック関数が完了したときにシグナル状態になるイベントオブジェクトへのハンドル。このパラメーターは NULL にすることができます。このパラメーターが INVALID_HANDLE_VALUE の場合、関数は実行中のタイマーコールバック関数が完了するまで待機してから戻ります。このパラメーターが NULL の場合、関数はタイマーを削除対象としてマークし、直ちに戻ります。タイマーが既に満了している場合、タイマーコールバック関数は完了まで実行されます。ただし、タイマーコールバック関数が完了したときの通知は送信されません。ほとんどの呼び出し元はこのオプションを使用すべきではなく、必要なクリーンアップを行えるよう、実行中のタイマーコールバック関数の完了を待機する必要があります。

名前

型

方向

説明

TimerQueue

HANDLE

inoptional

タイマーキューへのハンドル。このハンドルは CreateTimerQueue 関数によって返されます。

タイマーが既定のタイマーキューを使用して作成された場合、このパラメーターは NULL にする必要があります。

Timer

HANDLE

タイマーキュータイマーへのハンドル。このハンドルは CreateTimerQueueTimer 関数によって返されます。

CompletionEvent

HANDLE

inoptional

システムがタイマーをキャンセルし、すべてのコールバック関数が完了したときにシグナル状態になるイベントオブジェクトへのハンドル。このパラメーターは NULL にすることができます。

このパラメーターが INVALID_HANDLE_VALUE の場合、関数は実行中のタイマーコールバック関数が完了するまで待機してから戻ります。

このパラメーターが NULL の場合、関数はタイマーを削除対象としてマークし、直ちに戻ります。タイマーが既に満了している場合、タイマーコールバック関数は完了まで実行されます。ただし、タイマーコールバック関数が完了したときの通知は送信されません。ほとんどの呼び出し元はこのオプションを使用すべきではなく、必要なクリーンアップを行えるよう、実行中のタイマーコールバック関数の完了を待機する必要があります。

戻り値の型: BOOL

公式ドキュメント

タイマーキューからタイマーを削除します。必要に応じて、タイマーを削除する前に、現在実行中のタイマーコールバック関数の完了を待機します。

戻り値

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

関数が失敗した場合、戻り値は 0 です。拡張エラー情報を取得するには、 GetLastError を呼び出します。エラーコードが ERROR_IO_PENDING の場合、この関数を再度呼び出す必要はありません。それ以外のエラーの場合は、呼び出しを再試行してください。

解説(Remarks)

この関数は、スレッドが偽装 (impersonation) を使用している間は呼び出せません。その場合の動作は未定義です。

コールバック関数がタイマースレッドで実行されない限り、別のタイマーのタイマーコールバック内からこの関数を呼び出す際に CompletionEvent に INVALID_HANDLE_VALUE を設定できます。ただし、2 つのコールバック関数が互いのタイマーに対してブロッキングの DeleteTimerQueueTimer 呼び出しを試みると、デッドロックが発生する可能性があります。さらに、コールバックに関連付けられたタイマーに対してブロッキングの削除呼び出しを行うことはできません。

永続スレッド上でブロッキングの DeleteTimerQueueTimer 呼び出しを行う際は注意してください。削除対象のタイマーが WT_EXECUTEINPERSISTENTTHREAD で作成されていた場合、デッドロックが発生する可能性があります。

未完了のコールバック関数があり、かつ CompletionEvent が NULL の場合、関数は失敗し、エラーコードに ERROR_IO_PENDING を設定します。これは未完了のコールバック関数があることを示します。それらのコールバックは、これから実行されるか、実行の途中にあります。タイマーは、コールバック関数の実行が終了した時点でクリーンアップされます。

タイマーキュー内のすべてのタイマーをキャンセルするには、 DeleteTimerQueueEx 関数を呼び出します。

この関数を使用するアプリケーションをコンパイルするには、_WIN32_WINNT を 0x0500 以降として定義します。詳細については、 Using the Windows Headers を参照してください。

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

各言語での呼び出し定義

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

BOOL DeleteTimerQueueTimer(
    HANDLE TimerQueue,   // optional
    HANDLE Timer,
    HANDLE CompletionEvent   // optional
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool DeleteTimerQueueTimer(
    IntPtr TimerQueue,   // HANDLE optional
    IntPtr Timer,   // HANDLE
    IntPtr CompletionEvent   // HANDLE optional
);

<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function DeleteTimerQueueTimer(
    TimerQueue As IntPtr,   ' HANDLE optional
    Timer As IntPtr,   ' HANDLE
    CompletionEvent As IntPtr   ' HANDLE optional
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' TimerQueue : HANDLE optional
' Timer : HANDLE
' CompletionEvent : HANDLE optional
Declare PtrSafe Function DeleteTimerQueueTimer Lib "kernel32" ( _
    ByVal TimerQueue As LongPtr, _
    ByVal Timer As LongPtr, _
    ByVal CompletionEvent As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

DeleteTimerQueueTimer = ctypes.windll.kernel32.DeleteTimerQueueTimer
DeleteTimerQueueTimer.restype = wintypes.BOOL
DeleteTimerQueueTimer.argtypes = [
    wintypes.HANDLE,  # TimerQueue : HANDLE optional
    wintypes.HANDLE,  # Timer : HANDLE
    wintypes.HANDLE,  # CompletionEvent : HANDLE optional
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
DeleteTimerQueueTimer = Fiddle::Function.new(
  lib['DeleteTimerQueueTimer'],
  [
    Fiddle::TYPE_VOIDP,  # TimerQueue : HANDLE optional
    Fiddle::TYPE_VOIDP,  # Timer : HANDLE
    Fiddle::TYPE_VOIDP,  # CompletionEvent : HANDLE optional
  ],
  Fiddle::TYPE_INT)

#[link(name = "kernel32")]
extern "system" {
    fn DeleteTimerQueueTimer(
        TimerQueue: *mut core::ffi::c_void,  // HANDLE optional
        Timer: *mut core::ffi::c_void,  // HANDLE
        CompletionEvent: *mut core::ffi::c_void  // HANDLE optional
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true)]
public static extern bool DeleteTimerQueueTimer(IntPtr TimerQueue, IntPtr Timer, IntPtr CompletionEvent);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_DeleteTimerQueueTimer' -Namespace Win32 -PassThru
# $api::DeleteTimerQueueTimer(TimerQueue, Timer, CompletionEvent)

#uselib "KERNEL32.dll"
#func global DeleteTimerQueueTimer "DeleteTimerQueueTimer" sptr, sptr, sptr
; DeleteTimerQueueTimer TimerQueue, Timer, CompletionEvent   ; 戻り値は stat
; TimerQueue : HANDLE optional -> "sptr"
; Timer : HANDLE -> "sptr"
; CompletionEvent : HANDLE optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

#uselib "KERNEL32.dll"
#cfunc global DeleteTimerQueueTimer "DeleteTimerQueueTimer" sptr, sptr, sptr
; res = DeleteTimerQueueTimer(TimerQueue, Timer, CompletionEvent)
; TimerQueue : HANDLE optional -> "sptr"
; Timer : HANDLE -> "sptr"
; CompletionEvent : HANDLE optional -> "sptr"

; BOOL DeleteTimerQueueTimer(HANDLE TimerQueue, HANDLE Timer, HANDLE CompletionEvent)
#uselib "KERNEL32.dll"
#cfunc global DeleteTimerQueueTimer "DeleteTimerQueueTimer" intptr, intptr, intptr
; res = DeleteTimerQueueTimer(TimerQueue, Timer, CompletionEvent)
; TimerQueue : HANDLE optional -> "intptr"
; Timer : HANDLE -> "intptr"
; CompletionEvent : HANDLE optional -> "intptr"

import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procDeleteTimerQueueTimer = kernel32.NewProc("DeleteTimerQueueTimer")
)

// TimerQueue (HANDLE optional), Timer (HANDLE), CompletionEvent (HANDLE optional)
r1, _, err := procDeleteTimerQueueTimer.Call(
	uintptr(TimerQueue),
	uintptr(Timer),
	uintptr(CompletionEvent),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL

function DeleteTimerQueueTimer(
  TimerQueue: THandle;   // HANDLE optional
  Timer: THandle;   // HANDLE
  CompletionEvent: THandle   // HANDLE optional
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'DeleteTimerQueueTimer';

result := DllCall("KERNEL32\DeleteTimerQueueTimer"
    , "Ptr", TimerQueue   ; HANDLE optional
    , "Ptr", Timer   ; HANDLE
    , "Ptr", CompletionEvent   ; HANDLE optional
    , "Int")   ; return: BOOL

●DeleteTimerQueueTimer(TimerQueue, Timer, CompletionEvent) = DLL("KERNEL32.dll", "bool DeleteTimerQueueTimer(void*, void*, void*)")
# 呼び出し: DeleteTimerQueueTimer(TimerQueue, Timer, CompletionEvent)
# TimerQueue : HANDLE optional -> "void*"
# Timer : HANDLE -> "void*"
# CompletionEvent : HANDLE optional -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。

const std = @import("std");

extern "kernel32" fn DeleteTimerQueueTimer(
    TimerQueue: ?*anyopaque, // HANDLE optional
    Timer: ?*anyopaque, // HANDLE
    CompletionEvent: ?*anyopaque // HANDLE optional
) callconv(std.os.windows.WINAPI) i32;

proc DeleteTimerQueueTimer(
    TimerQueue: pointer,  # HANDLE optional
    Timer: pointer,  # HANDLE
    CompletionEvent: pointer  # HANDLE optional
): int32 {.importc: "DeleteTimerQueueTimer", stdcall, dynlib: "KERNEL32.dll".}

pragma(lib, "kernel32");
extern(Windows)
int DeleteTimerQueueTimer(
    void* TimerQueue,   // HANDLE optional
    void* Timer,   // HANDLE
    void* CompletionEvent   // HANDLE optional
);

ccall((:DeleteTimerQueueTimer, "KERNEL32.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Ptr{Cvoid}, Ptr{Cvoid}),
      TimerQueue, Timer, CompletionEvent)
# TimerQueue : HANDLE optional -> Ptr{Cvoid}
# Timer : HANDLE -> Ptr{Cvoid}
# CompletionEvent : HANDLE optional -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。

local ffi = require("ffi")
ffi.cdef[[
int32_t DeleteTimerQueueTimer(
    void* TimerQueue,
    void* Timer,
    void* CompletionEvent);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.DeleteTimerQueueTimer(TimerQueue, Timer, CompletionEvent)
-- TimerQueue : HANDLE optional
-- Timer : HANDLE
-- CompletionEvent : HANDLE optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。

const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const DeleteTimerQueueTimer = lib.func('__stdcall', 'DeleteTimerQueueTimer', 'int32_t', ['void *', 'void *', 'void *']);
// DeleteTimerQueueTimer(TimerQueue, Timer, CompletionEvent)
// TimerQueue : HANDLE optional -> 'void *'
// Timer : HANDLE -> 'void *'
// CompletionEvent : HANDLE optional -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。

const lib = Deno.dlopen("KERNEL32.dll", {
  DeleteTimerQueueTimer: { parameters: ["pointer", "pointer", "pointer"], result: "i32" },
});
// lib.symbols.DeleteTimerQueueTimer(TimerQueue, Timer, CompletionEvent)
// TimerQueue : HANDLE optional -> "pointer"
// Timer : HANDLE -> "pointer"
// CompletionEvent : HANDLE optional -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。

<?php
$ffi = FFI::cdef(<<<C
int32_t DeleteTimerQueueTimer(
    void* TimerQueue,
    void* Timer,
    void* CompletionEvent);
C, "KERNEL32.dll");
// $ffi->DeleteTimerQueueTimer(TimerQueue, Timer, CompletionEvent);
// TimerQueue : HANDLE optional
// Timer : HANDLE
// CompletionEvent : 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 Kernel32 extends StdCallLibrary {
    Kernel32 INSTANCE = Native.load("kernel32", Kernel32.class);
    boolean DeleteTimerQueueTimer(
        Pointer TimerQueue,   // HANDLE optional
        Pointer Timer,   // HANDLE
        Pointer CompletionEvent   // HANDLE optional
    );
}

@[Link("kernel32")]
lib LibKERNEL32
  fun DeleteTimerQueueTimer = DeleteTimerQueueTimer(
    TimerQueue : Void*,   # HANDLE optional
    Timer : Void*,   # HANDLE
    CompletionEvent : Void*   # 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 DeleteTimerQueueTimerNative = Int32 Function(Pointer<Void>, Pointer<Void>, Pointer<Void>);
typedef DeleteTimerQueueTimerDart = int Function(Pointer<Void>, Pointer<Void>, Pointer<Void>);
final DeleteTimerQueueTimer = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<DeleteTimerQueueTimerNative, DeleteTimerQueueTimerDart>('DeleteTimerQueueTimer');
// TimerQueue : HANDLE optional -> Pointer<Void>
// Timer : HANDLE -> Pointer<Void>
// CompletionEvent : HANDLE optional -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。

{$mode objfpc}{$H+}
function DeleteTimerQueueTimer(
  TimerQueue: THandle;   // HANDLE optional
  Timer: THandle;   // HANDLE
  CompletionEvent: THandle   // HANDLE optional
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'DeleteTimerQueueTimer';

import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "DeleteTimerQueueTimer"
  c_DeleteTimerQueueTimer :: Ptr () -> Ptr () -> Ptr () -> IO CInt
-- TimerQueue : HANDLE optional -> Ptr ()
-- Timer : HANDLE -> Ptr ()
-- CompletionEvent : HANDLE optional -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。

open Ctypes
open Foreign

let deletetimerqueuetimer =
  foreign "DeleteTimerQueueTimer"
    ((ptr void) @-> (ptr void) @-> (ptr void) @-> returning int32_t)
(* TimerQueue : HANDLE optional -> (ptr void) *)
(* Timer : HANDLE -> (ptr void) *)
(* CompletionEvent : HANDLE optional -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)

(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("DeleteTimerQueueTimer" delete-timer-queue-timer :convention :stdcall) :int32
  (timer-queue :pointer)   ; HANDLE optional
  (timer :pointer)   ; HANDLE
  (completion-event :pointer))   ; HANDLE optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。

use Win32::API;
my $DeleteTimerQueueTimer = Win32::API::More->new('KERNEL32',
    'BOOL DeleteTimerQueueTimer(HANDLE TimerQueue, HANDLE Timer, HANDLE CompletionEvent)');
# my $ret = $DeleteTimerQueueTimer->Call($TimerQueue, $Timer, $CompletionEvent);
# TimerQueue : HANDLE optional -> HANDLE
# Timer : HANDLE -> HANDLE
# CompletionEvent : HANDLE optional -> HANDLE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

DeleteTimerQueueTimer

シグネチャ

パラメーター

公式ドキュメント

戻り値

解説(Remarks)

各言語での呼び出し定義

関連項目