ホーム › System.Threading › SetWaitableTimerEx

SetWaitableTimerEx

関数

完了ルーチンと許容遅延付きで待機可能タイマーを設定する。

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

シグネチャ

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

BOOL SetWaitableTimerEx(
    HANDLE hTimer,
    const LONGLONG* lpDueTime,
    INT lPeriod,
    PTIMERAPCROUTINE pfnCompletionRoutine,   // optional
    void* lpArgToCompletionRoutine,   // optional
    REASON_CONTEXT* WakeContext,   // optional
    DWORD TolerableDelay
);

パラメーター

名前	型	方向	説明
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 の場合、タイマーは 1 回だけシグナル状態になります。lPeriod が 0 より大きい場合、タイマーは周期的になります。周期的タイマーは、 CancelWaitableTimer 関数によってキャンセルされるか、SetWaitableTimerEx によってリセットされるまで、周期が経過するたびに自動的に再アクティブ化されます。lPeriod が 0 より小さい場合、関数は失敗します。
pfnCompletionRoutine	PTIMERAPCROUTINE	inoptional	省略可能な完了ルーチンへのポインター。完了ルーチンは、タイマーがシグナル状態になったときに実行される、PTIMERAPCROUTINE 型のアプリケーション定義の関数です。タイマーコールバック関数の詳細については、 TimerAPCProc を参照してください。APC とスレッドプールスレッドの詳細については、「解説」を参照してください。
lpArgToCompletionRoutine	void*	inoptional	完了ルーチンに渡される構造体へのポインター。
WakeContext	REASON_CONTEXT*	inoptional	タイマーのコンテキスト情報を含む REASON_CONTEXT 構造体へのポインター。
TolerableDelay	DWORD	in	有効期限に対する許容遅延を、ミリ秒単位で指定します。

戻り値の型: BOOL

公式ドキュメント

指定された待機可能タイマーをアクティブ化し、タイマーのコンテキスト情報を提供します。指定時刻に達すると、タイマーはシグナル状態になり、タイマーを設定したスレッドが省略可能な完了ルーチンを呼び出します。

戻り値

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

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

解説(Remarks)

SetWaitableTimerEx 関数は SetWaitableTimer 関数に似ていますが、SetWaitableTimerEx ではコンテキスト文字列とタイマーの有効期限に対する許容遅延を指定できる点が異なります。

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

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

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

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

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

システム時刻が調整された場合、保留中の絶対時刻タイマーの指定時刻も調整されます。

SetWaitableTimerEx を呼び出したスレッドが終了すると、タイマーはキャンセルされます。これにより、タイマーがシグナル状態に設定される前に停止され、保留中の APC がキャンセルされます。タイマーのシグナル状態は変更されません。

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

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

各言語での呼び出し定義

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

BOOL SetWaitableTimerEx(
    HANDLE hTimer,
    const LONGLONG* lpDueTime,
    INT lPeriod,
    PTIMERAPCROUTINE pfnCompletionRoutine,   // optional
    void* lpArgToCompletionRoutine,   // optional
    REASON_CONTEXT* WakeContext,   // optional
    DWORD TolerableDelay
);

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

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

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

import ctypes
from ctypes import wintypes

SetWaitableTimerEx = ctypes.windll.kernel32.SetWaitableTimerEx
SetWaitableTimerEx.restype = wintypes.BOOL
SetWaitableTimerEx.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
    ctypes.c_void_p,  # WakeContext : REASON_CONTEXT* optional
    wintypes.DWORD,  # TolerableDelay : DWORD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
SetWaitableTimerEx = Fiddle::Function.new(
  lib['SetWaitableTimerEx'],
  [
    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_VOIDP,  # WakeContext : REASON_CONTEXT* optional
    -Fiddle::TYPE_INT,  # TolerableDelay : DWORD
  ],
  Fiddle::TYPE_INT)

#[link(name = "kernel32")]
extern "system" {
    fn SetWaitableTimerEx(
        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
        WakeContext: *mut REASON_CONTEXT,  // REASON_CONTEXT* optional
        TolerableDelay: u32  // DWORD
    ) -> 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 SetWaitableTimerEx(IntPtr hTimer, ref long lpDueTime, int lPeriod, IntPtr pfnCompletionRoutine, IntPtr lpArgToCompletionRoutine, IntPtr WakeContext, uint TolerableDelay);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_SetWaitableTimerEx' -Namespace Win32 -PassThru
# $api::SetWaitableTimerEx(hTimer, lpDueTime, lPeriod, pfnCompletionRoutine, lpArgToCompletionRoutine, WakeContext, TolerableDelay)

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

出力引数:

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