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

CancelWaitableTimer

関数
待機可能タイマーの設定を解除して無効化する。
DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

BOOL CancelWaitableTimer(
    HANDLE hTimer
);

パラメーター

名前方向説明
hTimerHANDLEinタイマーオブジェクトへのハンドル。このハンドルは CreateWaitableTimer または OpenWaitableTimer 関数によって返されます。このハンドルには TIMER_MODIFY_STATE アクセス権が必要です。詳細については、 Synchronization Object Security and Access Rights を参照してください。

戻り値の型: BOOL

公式ドキュメント

指定された待機可能タイマーを非アクティブ状態に設定します。

戻り値

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

関数が失敗した場合、戻り値は 0 になります。拡張エラー情報を取得するには、 GetLastError を呼び出します。

解説(Remarks)

CancelWaitableTimer 関数は、タイマーのシグナル状態を変更しません。この関数は、タイマーがシグナル状態に設定される前にタイマーを停止し、保留中の APC をキャンセルします。そのため、タイマーに対して待機操作を実行しているスレッドは、タイムアウトするか、タイマーが再アクティブ化されてその状態がシグナル状態に設定されるまで待機し続けます。タイマーが既にシグナル状態にある場合は、その状態のまま維持されます。

タイマーを再アクティブ化するには、 SetWaitableTimer 関数を呼び出します。

この関数を使用するアプリケーションをコンパイルするには、_WIN32_WINNT を 0x0400 以降として定義します。詳細については、 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 CancelWaitableTimer(
    HANDLE hTimer
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool CancelWaitableTimer(
    IntPtr hTimer   // HANDLE
);
<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CancelWaitableTimer(
    hTimer As IntPtr   ' HANDLE
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' hTimer : HANDLE
Declare PtrSafe Function CancelWaitableTimer Lib "kernel32" ( _
    ByVal hTimer As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

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

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

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procCancelWaitableTimer = kernel32.NewProc("CancelWaitableTimer")
)

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

extern "kernel32" fn CancelWaitableTimer(
    hTimer: ?*anyopaque // HANDLE
) callconv(std.os.windows.WINAPI) i32;
proc CancelWaitableTimer(
    hTimer: pointer  # HANDLE
): int32 {.importc: "CancelWaitableTimer", stdcall, dynlib: "KERNEL32.dll".}
pragma(lib, "kernel32");
extern(Windows)
int CancelWaitableTimer(
    void* hTimer   // HANDLE
);
ccall((:CancelWaitableTimer, "KERNEL32.dll"), stdcall, Int32,
      (Ptr{Cvoid},),
      hTimer)
# hTimer : HANDLE -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t CancelWaitableTimer(
    void* hTimer);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.CancelWaitableTimer(hTimer)
-- hTimer : HANDLE
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const CancelWaitableTimer = lib.func('__stdcall', 'CancelWaitableTimer', 'int32_t', ['void *']);
// CancelWaitableTimer(hTimer)
// hTimer : HANDLE -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  CancelWaitableTimer: { parameters: ["pointer"], result: "i32" },
});
// lib.symbols.CancelWaitableTimer(hTimer)
// hTimer : HANDLE -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t CancelWaitableTimer(
    void* hTimer);
C, "KERNEL32.dll");
// $ffi->CancelWaitableTimer(hTimer);
// hTimer : 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 Kernel32 extends StdCallLibrary {
    Kernel32 INSTANCE = Native.load("kernel32", Kernel32.class);
    boolean CancelWaitableTimer(
        Pointer hTimer   // HANDLE
    );
}
@[Link("kernel32")]
lib LibKERNEL32
  fun CancelWaitableTimer = CancelWaitableTimer(
    hTimer : 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 CancelWaitableTimerNative = Int32 Function(Pointer<Void>);
typedef CancelWaitableTimerDart = int Function(Pointer<Void>);
final CancelWaitableTimer = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<CancelWaitableTimerNative, CancelWaitableTimerDart>('CancelWaitableTimer');
// hTimer : HANDLE -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function CancelWaitableTimer(
  hTimer: THandle   // HANDLE
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'CancelWaitableTimer';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

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

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

関連項目

公式の関連項目