ホーム › System.Threading › SetWaitableTimer

SetWaitableTimer

関数

発火時刻と周期を指定して待機可能タイマーを設定する。

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

シグネチャ

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

BOOL SetWaitableTimer(
    HANDLE hTimer,
    const LONGLONG* lpDueTime,
    INT lPeriod,
    PTIMERAPCROUTINE pfnCompletionRoutine,   // optional
    void* lpArgToCompletionRoutine,   // optional
    BOOL fResume
);

パラメーター

名前	型	方向	説明
hTimer	HANDLE	in	タイマーオブジェクトへのハンドル。 CreateWaitableTimer または OpenWaitableTimer 関数がこのハンドルを返します。ハンドルには TIMER_MODIFY_STATE アクセス権が必要です。詳細については、 Synchronization Object Security and Access Rights を参照してください。
lpDueTime	LONGLONG*	in	タイマーの状態がシグナル状態に設定されるまでの時間を、100 ナノ秒単位で指定します。 FILETIME 構造体で説明されている形式を使用します。正の値は絶対時刻を表します。システムは内部で UTC ベースの時刻を使用するため、必ず UTC ベースの絶対時刻を使用してください。負の値は相対時刻を表します。実際のタイマー精度はハードウェアの能力に依存します。UTC ベースの時刻の詳細については、 System Time を参照してください。 Windows XP、Windows Server 2003、Windows Vista、Windows 7、Windows Server 2008、Windows Server 2008 R2: 相対時刻を指定した場合、タイマーは低電力状態に費やされた時間を含みます。たとえば、コンピューターがスリープ中もタイマーはカウントダウンを続けます。 Windows 8 以降、Windows Server 2012 以降: 相対時刻を指定した場合、タイマーは低電力状態に費やされた時間を含みません。たとえば、コンピューターがスリープ中はタイマーはカウントダウンを続けません。
lPeriod	INT	in	タイマーの周期をミリ秒単位で指定します。lPeriod が 0 の場合、タイマーは一度だけシグナル状態になります。lPeriod が 0 より大きい場合、タイマーは周期的になります。周期的タイマーは、 CancelWaitableTimer 関数でキャンセルされるか、 SetWaitableTimer でリセットされるまで、周期が経過するたびに自動的に再有効化されます。lPeriod が 0 より小さい場合、この関数は失敗します。
pfnCompletionRoutine	PTIMERAPCROUTINE	inoptional	省略可能な完了ルーチンへのポインター。完了ルーチンは、タイマーがシグナル状態になったときに実行される PTIMERAPCROUTINE 型のアプリケーション定義関数です。タイマーコールバック関数の詳細については、 TimerAPCProc を参照してください。APC とスレッドプールスレッドの詳細については、「解説」を参照してください。
lpArgToCompletionRoutine	void*	inoptional	完了ルーチンに渡される構造体へのポインター。
fResume	BOOL	in	このパラメーターが TRUE の場合、タイマーの状態がシグナル状態に設定されたときに、省電力モードでサスペンド状態にあるシステムを復帰させます。それ以外の場合、システムは復帰しません。システムが復帰をサポートしていない場合、呼び出しは成功しますが、GetLastError は ERROR_NOT_SUPPORTED を返します。

戻り値の型: BOOL

公式ドキュメント

指定された待機可能タイマーを有効化します。指定時刻に到達するとタイマーがシグナル状態になり、タイマーを設定したスレッドが省略可能な完了ルーチンを呼び出します。

戻り値

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

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

解説(Remarks)

タイマーは初期状態では非アクティブです。タイマーを有効化するには、 SetWaitableTimer を呼び出します。 SetWaitableTimer を呼び出したときにタイマーがすでにアクティブな場合、タイマーは停止され、その後再有効化されます。この方法でタイマーを停止しても、タイマーの状態はシグナル状態に設定されないため、そのタイマーに対する待機操作でブロックされているスレッドはブロックされたままになります。ただし、保留中の完了ルーチンはすべてキャンセルされます。

指定された期日に到達すると、タイマーは非アクティブになり、未処理の APC がまだキューに入れられていない場合は、省略可能な APC がタイマーを設定したスレッドのキューに入れられます。タイマーの状態がシグナル状態に設定され、指定された周期を使用してタイマーが再有効化され、タイマーを設定したスレッドはアラート可能な待機状態に入ったときに完了ルーチンを呼び出します。詳細については、 QueueUserAPC を参照してください。スレッドプールスレッドの場合、APC は他のシグナリングメカニズムほどうまく機能しないことに注意してください。システムがスレッドプールスレッドの有効期間を制御するため、通知が配信される前にスレッドが終了する可能性があります。pfnCompletionRoutine パラメーターやその他の APC ベースのシグナリングメカニズムを使用する代わりに、CreateThreadpoolTimer で作成したタイマーなどの待機可能オブジェクトを使用してください。I/O の場合は、CreateThreadpoolIo で作成した I/O 完了オブジェクト、またはイベントを SetThreadpoolWait 関数に渡すことができる hEvent ベースの OVERLAPPED 構造体を使用してください。

タイマーを設定したスレッドが終了し、関連する完了ルーチンがある場合、タイマーはキャンセルされます。ただし、タイマーの状態は変更されません。完了ルーチンがない場合、スレッドの終了はタイマーに影響を与えません。

手動リセットタイマーがシグナル状態に設定されると、 SetWaitableTimer が呼び出されてタイマーがリセットされるまで、その状態が維持されます。その結果、周期的な手動リセットタイマーは、最初の期日に到達したときにシグナル状態に設定され、リセットされるまでシグナル状態を維持します。同期タイマーがシグナル状態に設定されると、スレッドがそのタイマーオブジェクトに対する待機操作を完了するまで、その状態が維持されます。

システム時刻が調整されると、未処理のすべての絶対タイマーの期日が調整されます。

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

ウィンドウのイベントをスケジュールするためにタイマーを使用するには、SetTimer 関数を使用します。

タイマーを扱う API は、さまざまな異なるハードウェアクロックを使用します。これらのクロックの分解能は、期待するものと大きく異なる場合があります。ミリ秒単位で測定されるもの(RTC ベースのタイマーチップを使用するもの)から、ナノ秒単位で測定されるもの(ACPI または TSC カウンターを使用するもの)まであります。timeBeginPeriod 関数および timeEndPeriod 関数を呼び出すことで、API の分解能を変更できます。分解能をどの程度精密に変更できるかは、特定の API がどのハードウェアクロックを使用するかに依存します。詳細については、お使いのハードウェアのドキュメントを確認してください。

例

SetWaitableTimer を使用する例については、 Using Waitable Timer Objects を参照してください。

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

各言語での呼び出し定義

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

BOOL SetWaitableTimer(
    HANDLE hTimer,
    const LONGLONG* lpDueTime,
    INT lPeriod,
    PTIMERAPCROUTINE pfnCompletionRoutine,   // optional
    void* lpArgToCompletionRoutine,   // optional
    BOOL fResume
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool SetWaitableTimer(
    IntPtr hTimer,   // HANDLE
    ref long lpDueTime,   // LONGLONG*
    int lPeriod,   // INT
    IntPtr pfnCompletionRoutine,   // PTIMERAPCROUTINE optional
    IntPtr lpArgToCompletionRoutine,   // void* optional
    bool fResume   // BOOL
);

<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SetWaitableTimer(
    hTimer As IntPtr,   ' HANDLE
    ByRef lpDueTime As Long,   ' LONGLONG*
    lPeriod As Integer,   ' INT
    pfnCompletionRoutine As IntPtr,   ' PTIMERAPCROUTINE optional
    lpArgToCompletionRoutine As IntPtr,   ' void* optional
    fResume As Boolean   ' BOOL
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hTimer : HANDLE
' lpDueTime : LONGLONG*
' lPeriod : INT
' pfnCompletionRoutine : PTIMERAPCROUTINE optional
' lpArgToCompletionRoutine : void* optional
' fResume : BOOL
Declare PtrSafe Function SetWaitableTimer Lib "kernel32" ( _
    ByVal hTimer As LongPtr, _
    ByRef lpDueTime As LongLong, _
    ByVal lPeriod As Long, _
    ByVal pfnCompletionRoutine As LongPtr, _
    ByVal lpArgToCompletionRoutine As LongPtr, _
    ByVal fResume As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

SetWaitableTimer = ctypes.windll.kernel32.SetWaitableTimer
SetWaitableTimer.restype = wintypes.BOOL
SetWaitableTimer.argtypes = [
    wintypes.HANDLE,  # hTimer : HANDLE
    ctypes.POINTER(ctypes.c_longlong),  # lpDueTime : LONGLONG*
    ctypes.c_int,  # lPeriod : INT
    ctypes.c_void_p,  # pfnCompletionRoutine : PTIMERAPCROUTINE optional
    ctypes.POINTER(None),  # lpArgToCompletionRoutine : void* optional
    wintypes.BOOL,  # fResume : BOOL
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
SetWaitableTimer = Fiddle::Function.new(
  lib['SetWaitableTimer'],
  [
    Fiddle::TYPE_VOIDP,  # hTimer : HANDLE
    Fiddle::TYPE_VOIDP,  # lpDueTime : LONGLONG*
    Fiddle::TYPE_INT,  # lPeriod : INT
    Fiddle::TYPE_VOIDP,  # pfnCompletionRoutine : PTIMERAPCROUTINE optional
    Fiddle::TYPE_VOIDP,  # lpArgToCompletionRoutine : void* optional
    Fiddle::TYPE_INT,  # fResume : BOOL
  ],
  Fiddle::TYPE_INT)

#[link(name = "kernel32")]
extern "system" {
    fn SetWaitableTimer(
        hTimer: *mut core::ffi::c_void,  // HANDLE
        lpDueTime: *const i64,  // LONGLONG*
        lPeriod: i32,  // INT
        pfnCompletionRoutine: *const core::ffi::c_void,  // PTIMERAPCROUTINE optional
        lpArgToCompletionRoutine: *mut (),  // void* optional
        fResume: i32  // BOOL
    ) -> 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 SetWaitableTimer(IntPtr hTimer, ref long lpDueTime, int lPeriod, IntPtr pfnCompletionRoutine, IntPtr lpArgToCompletionRoutine, bool fResume);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_SetWaitableTimer' -Namespace Win32 -PassThru
# $api::SetWaitableTimer(hTimer, lpDueTime, lPeriod, pfnCompletionRoutine, lpArgToCompletionRoutine, fResume)

#uselib "KERNEL32.dll"
#func global SetWaitableTimer "SetWaitableTimer" sptr, sptr, sptr, sptr, sptr, sptr
; SetWaitableTimer hTimer, varptr(lpDueTime), lPeriod, pfnCompletionRoutine, lpArgToCompletionRoutine, fResume   ; 戻り値は stat
; hTimer : HANDLE -> "sptr"
; lpDueTime : LONGLONG* -> "sptr"
; lPeriod : INT -> "sptr"
; pfnCompletionRoutine : PTIMERAPCROUTINE optional -> "sptr"
; lpArgToCompletionRoutine : void* optional -> "sptr"
; fResume : BOOL -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "KERNEL32.dll"
#cfunc global SetWaitableTimer "SetWaitableTimer" sptr, var, int, sptr, sptr, int
; res = SetWaitableTimer(hTimer, lpDueTime, lPeriod, pfnCompletionRoutine, lpArgToCompletionRoutine, fResume)
; hTimer : HANDLE -> "sptr"
; lpDueTime : LONGLONG* -> "var"
; lPeriod : INT -> "int"
; pfnCompletionRoutine : PTIMERAPCROUTINE optional -> "sptr"
; lpArgToCompletionRoutine : void* optional -> "sptr"
; fResume : BOOL -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "KERNEL32.dll"
#cfunc global SetWaitableTimer "SetWaitableTimer" sptr, sptr, int, sptr, sptr, int
; res = SetWaitableTimer(hTimer, varptr(lpDueTime), lPeriod, pfnCompletionRoutine, lpArgToCompletionRoutine, fResume)
; hTimer : HANDLE -> "sptr"
; lpDueTime : LONGLONG* -> "sptr"
; lPeriod : INT -> "int"
; pfnCompletionRoutine : PTIMERAPCROUTINE optional -> "sptr"
; lpArgToCompletionRoutine : void* optional -> "sptr"
; fResume : BOOL -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。