ホーム › System.Threading › SetThreadpoolTimer

SetThreadpoolTimer

関数

スレッドプールタイマーの発火時刻と周期を設定する。

DLLKERNEL32.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

void SetThreadpoolTimer(
    PTP_TIMER pti,
    FILETIME* pftDueTime,   // optional
    DWORD msPeriod,
    DWORD msWindowLength   // optional
);

パラメーター

名前	型	方向	説明
pti	PTP_TIMER	in	設定するタイマーオブジェクトを定義する TP_TIMER 構造体へのポインターです。このポインターは CreateThreadpoolTimer 関数によって返されます。
pftDueTime	FILETIME*	inoptional	タイマーが期限切れになる絶対時刻または相対時刻を指定する FILETIME 構造体へのポインターです。正またはゼロの場合は、1601 年 1 月 1 日 (UTC) からの絶対時刻を 100 ナノセカンド単位で表します。負の場合は、現在時刻を基準とした待機時間を表します。時刻値の詳細については、File Times を参照してください。このパラメーターが NULL の場合、タイマーオブジェクトは新しいコールバックのキューイングを停止します (ただし、すでにキューイングされているコールバックは引き続き実行されます)。 pftDueTime パラメーターが NULL でない場合、タイマーが設定されます。
msPeriod	DWORD	in	タイマーの周期 (ミリ秒単位)。このパラメーターがゼロの場合、タイマーは一度だけシグナル状態になります。このパラメーターがゼロより大きい場合、タイマーは周期的になります。周期的なタイマーは、キャンセルされるまで、周期が経過するたびに自動的に再アクティブ化されます。
msWindowLength	DWORD	inoptional	タイマーコールバックを呼び出すまでにシステムが遅延できる最大時間です。このパラメーターがゼロに設定されていない場合、システムは電力を節約するために呼び出しをまとめて処理できます。

戻り値の型: void

公式ドキュメント

タイマーオブジェクトを設定し、既存のタイマーがあればそれを置き換えます。指定したタイムアウトが経過すると、ワーカースレッドがタイマーオブジェクトのコールバックを呼び出します。(SetThreadpoolTimer)

解説(Remarks)

タイマーを設定すると、既存のタイマーがあればそれがキャンセルされます。

場合によっては、アプリケーションがスレッドプールタイマーを閉じた後にコールバック関数が実行されることがあります。この動作を防ぐには、アプリケーションは CloseThreadpoolTimer で説明されている手順に従う必要があります。

pftDueTime で指定した期限が相対時刻の場合、システムがスリープまたは休止状態で費やす時間はタイマーの期限切れにはカウントされません。タイマーは、システムが起動状態で費やした経過時間の累計がタイマーの相対期限または周期に等しくなったときにシグナル状態になります。pftDueTime で指定した期限が絶対時刻の場合、システムがスリープまたは休止状態で費やす時間はタイマーの期限切れにカウントされます。システムがスリープしている間にタイマーが期限切れになった場合、システムが起動したときにタイマーは直ちにシグナル状態になります。

pftDueTime で指定した期限がゼロの場合、タイマーは直ちに期限切れになります。

この関数を使用するアプリケーションをコンパイルするには、_WIN32_WINNT を 0x0600 以上として定義してください。

Examples

例については、Using the Thread Pool Functions を参照してください。

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

各言語での呼び出し定義

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

void SetThreadpoolTimer(
    PTP_TIMER pti,
    FILETIME* pftDueTime,   // optional
    DWORD msPeriod,
    DWORD msWindowLength   // optional
);

[DllImport("KERNEL32.dll", ExactSpelling = true)]
static extern void SetThreadpoolTimer(
    IntPtr pti,   // PTP_TIMER
    IntPtr pftDueTime,   // FILETIME* optional
    uint msPeriod,   // DWORD
    uint msWindowLength   // DWORD optional
);

<DllImport("KERNEL32.dll", ExactSpelling:=True)>
Public Shared Sub SetThreadpoolTimer(
    pti As IntPtr,   ' PTP_TIMER
    pftDueTime As IntPtr,   ' FILETIME* optional
    msPeriod As UInteger,   ' DWORD
    msWindowLength As UInteger   ' DWORD optional
)
End Sub

' pti : PTP_TIMER
' pftDueTime : FILETIME* optional
' msPeriod : DWORD
' msWindowLength : DWORD optional
Declare PtrSafe Sub SetThreadpoolTimer Lib "kernel32" ( _
    ByVal pti As LongPtr, _
    ByVal pftDueTime As LongPtr, _
    ByVal msPeriod As Long, _
    ByVal msWindowLength As Long)
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

SetThreadpoolTimer = ctypes.windll.kernel32.SetThreadpoolTimer
SetThreadpoolTimer.restype = None
SetThreadpoolTimer.argtypes = [
    ctypes.c_ssize_t,  # pti : PTP_TIMER
    ctypes.c_void_p,  # pftDueTime : FILETIME* optional
    wintypes.DWORD,  # msPeriod : DWORD
    wintypes.DWORD,  # msWindowLength : DWORD optional
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
SetThreadpoolTimer = Fiddle::Function.new(
  lib['SetThreadpoolTimer'],
  [
    Fiddle::TYPE_INTPTR_T,  # pti : PTP_TIMER
    Fiddle::TYPE_VOIDP,  # pftDueTime : FILETIME* optional
    -Fiddle::TYPE_INT,  # msPeriod : DWORD
    -Fiddle::TYPE_INT,  # msWindowLength : DWORD optional
  ],
  Fiddle::TYPE_VOID)

#[link(name = "kernel32")]
extern "system" {
    fn SetThreadpoolTimer(
        pti: isize,  // PTP_TIMER
        pftDueTime: *mut FILETIME,  // FILETIME* optional
        msPeriod: u32,  // DWORD
        msWindowLength: u32  // DWORD optional
    );
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("KERNEL32.dll")]
public static extern void SetThreadpoolTimer(IntPtr pti, IntPtr pftDueTime, uint msPeriod, uint msWindowLength);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_SetThreadpoolTimer' -Namespace Win32 -PassThru
# $api::SetThreadpoolTimer(pti, pftDueTime, msPeriod, msWindowLength)

#uselib "KERNEL32.dll"
#func global SetThreadpoolTimer "SetThreadpoolTimer" sptr, sptr, sptr, sptr
; SetThreadpoolTimer pti, varptr(pftDueTime), msPeriod, msWindowLength
; pti : PTP_TIMER -> "sptr"
; pftDueTime : FILETIME* optional -> "sptr"
; msPeriod : DWORD -> "sptr"
; msWindowLength : DWORD optional -> "sptr"

出力引数:

#uselib "KERNEL32.dll"
#func global SetThreadpoolTimer "SetThreadpoolTimer" sptr, var, int, int
; SetThreadpoolTimer pti, pftDueTime, msPeriod, msWindowLength
; pti : PTP_TIMER -> "sptr"
; pftDueTime : FILETIME* optional -> "var"
; msPeriod : DWORD -> "int"
; msWindowLength : DWORD optional -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "KERNEL32.dll"
#func global SetThreadpoolTimer "SetThreadpoolTimer" sptr, sptr, int, int
; SetThreadpoolTimer pti, varptr(pftDueTime), msPeriod, msWindowLength
; pti : PTP_TIMER -> "sptr"
; pftDueTime : FILETIME* optional -> "sptr"
; msPeriod : DWORD -> "int"
; msWindowLength : DWORD optional -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。