ホーム › System.Threading › SetThreadpoolTimerEx

SetThreadpoolTimerEx

関数

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

DLLKERNEL32.dll呼出規約winapi対応OSwindows8.0

シグネチャ

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

BOOL SetThreadpoolTimerEx(
    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	システムがタイマーコールバックを呼び出すまでに遅延できる最大時間です。このパラメーターが設定されている場合、システムは電力を節約するために呼び出しをまとめて処理できます。

戻り値の型: BOOL

公式ドキュメント

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

戻り値

タイマーが以前に設定されており、キャンセルされた場合は TRUE を返します。それ以外の場合は FALSE を返します。

タイマーの以前の状態が「設定済み」で、関数が FALSE を返した場合は、コールバックが進行中であるか、まもなく開始されようとしています。詳細については「解説」を参照してください。

解説(Remarks)

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

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

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>

BOOL SetThreadpoolTimerEx(
    PTP_TIMER pti,
    FILETIME* pftDueTime,   // optional
    DWORD msPeriod,
    DWORD msWindowLength   // optional
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", ExactSpelling = true)]
static extern bool SetThreadpoolTimerEx(
    IntPtr pti,   // PTP_TIMER
    IntPtr pftDueTime,   // FILETIME* optional
    uint msPeriod,   // DWORD
    uint msWindowLength   // DWORD optional
);

<DllImport("KERNEL32.dll", ExactSpelling:=True)>
Public Shared Function SetThreadpoolTimerEx(
    pti As IntPtr,   ' PTP_TIMER
    pftDueTime As IntPtr,   ' FILETIME* optional
    msPeriod As UInteger,   ' DWORD
    msWindowLength As UInteger   ' DWORD optional
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

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

import ctypes
from ctypes import wintypes

SetThreadpoolTimerEx = ctypes.windll.kernel32.SetThreadpoolTimerEx
SetThreadpoolTimerEx.restype = wintypes.BOOL
SetThreadpoolTimerEx.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')
SetThreadpoolTimerEx = Fiddle::Function.new(
  lib['SetThreadpoolTimerEx'],
  [
    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_INT)

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

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll")]
public static extern bool SetThreadpoolTimerEx(IntPtr pti, IntPtr pftDueTime, uint msPeriod, uint msWindowLength);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_SetThreadpoolTimerEx' -Namespace Win32 -PassThru
# $api::SetThreadpoolTimerEx(pti, pftDueTime, msPeriod, msWindowLength)

#uselib "KERNEL32.dll"
#func global SetThreadpoolTimerEx "SetThreadpoolTimerEx" sptr, sptr, sptr, sptr
; SetThreadpoolTimerEx pti, varptr(pftDueTime), msPeriod, msWindowLength   ; 戻り値は stat
; pti : PTP_TIMER -> "sptr"
; pftDueTime : FILETIME* optional -> "sptr"
; msPeriod : DWORD -> "sptr"
; msWindowLength : DWORD optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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