ホーム › System.Threading › SetThreadpoolWaitEx

SetThreadpoolWaitEx

関数

待機オブジェクトのハンドルとタイムアウトを設定する(拡張版)。

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

シグネチャ

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

BOOL SetThreadpoolWaitEx(
    PTP_WAIT pwa,
    HANDLE h,   // optional
    FILETIME* pftTimeout,   // optional
    void* Reserved   // optional
);

パラメーター

名前	型	方向	説明
pwa	PTP_WAIT	in	待機オブジェクトを定義する TP_WAIT 構造体へのポインター。CreateThreadpoolWait 関数がこのポインターを返します。
h	HANDLE	inoptional	ハンドル。このパラメーターが NULL の場合、待機オブジェクトは新しいコールバックのキューイングを停止します(ただし、既にキューに入れられたコールバックは実行されます)。このパラメーターが NULL でない場合、有効な待機可能オブジェクトを参照していなければなりません。待機が保留中のままこのハンドルを閉じた場合、関数の動作は未定義です。待機が保留中でハンドルを閉じる必要がある場合は、CloseThreadpoolWait を使用して待機をキャンセルしてからハンドルを閉じてください。このパラメーターが NULL 以外の場合、待機は設定されているとみなされます。
pftTimeout	FILETIME*	inoptional	待機操作がタイムアウトする絶対時刻または相対時刻を指定する FILETIME 構造体へのポインター。このパラメーターが正の値を指す場合、1601 年 1 月 1 日(UTC)からの経過時間を 100 ナノ秒単位の絶対時刻として示します。負の値を指す場合、現在時刻からの相対的な待機時間を示します。ゼロを指す場合、待機は直ちにタイムアウトします。時刻値の詳細については、File Times を参照してください。このパラメーターが NULL の場合、待機はタイムアウトしません。
Reserved	void*	optional	予約済み。 NULL でなければなりません。

戻り値の型: BOOL

公式ドキュメント

待機オブジェクトを設定し、既存の待機オブジェクトがあればそれを置き換えます。ハンドルがシグナル状態になるか、指定したタイムアウトが経過した後に、ワーカースレッドが待機オブジェクトのコールバック関数を呼び出します。(SetThreadpoolWaitEx)

戻り値

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

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

解説(Remarks)

待機オブジェクトは 1 つのハンドルに対してのみ待機できます。待機オブジェクトのハンドルを設定すると、既存の待機ハンドルがあればそれが置き換えられます。

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

pftTimeout で指定したタイムアウトが相対時刻の場合、システムがスリープまたは休止状態で費やした時間は、待機の満了にはカウントされません。システムが起動状態で費やした経過時間の累計が待機の相対タイムアウトに達したときに、待機がシグナル状態になります。pftTimeout で指定したタイムアウトが絶対時刻の場合、システムがスリープまたは休止状態で費やした時間も待機の満了にカウントされます。システムがスリープ中に待機が満了した場合、システムが起動したときに待機が直ちにシグナル状態になります。

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

各言語での呼び出し定義

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

BOOL SetThreadpoolWaitEx(
    PTP_WAIT pwa,
    HANDLE h,   // optional
    FILETIME* pftTimeout,   // optional
    void* Reserved   // optional
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", ExactSpelling = true)]
static extern bool SetThreadpoolWaitEx(
    IntPtr pwa,   // PTP_WAIT
    IntPtr h,   // HANDLE optional
    IntPtr pftTimeout,   // FILETIME* optional
    IntPtr Reserved   // void* optional
);

<DllImport("KERNEL32.dll", ExactSpelling:=True)>
Public Shared Function SetThreadpoolWaitEx(
    pwa As IntPtr,   ' PTP_WAIT
    h As IntPtr,   ' HANDLE optional
    pftTimeout As IntPtr,   ' FILETIME* optional
    Reserved As IntPtr   ' void* optional
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' pwa : PTP_WAIT
' h : HANDLE optional
' pftTimeout : FILETIME* optional
' Reserved : void* optional
Declare PtrSafe Function SetThreadpoolWaitEx Lib "kernel32" ( _
    ByVal pwa As LongPtr, _
    ByVal h As LongPtr, _
    ByVal pftTimeout As LongPtr, _
    ByVal Reserved As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

SetThreadpoolWaitEx = ctypes.windll.kernel32.SetThreadpoolWaitEx
SetThreadpoolWaitEx.restype = wintypes.BOOL
SetThreadpoolWaitEx.argtypes = [
    ctypes.c_ssize_t,  # pwa : PTP_WAIT
    wintypes.HANDLE,  # h : HANDLE optional
    ctypes.c_void_p,  # pftTimeout : FILETIME* optional
    ctypes.POINTER(None),  # Reserved : void* optional
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
SetThreadpoolWaitEx = Fiddle::Function.new(
  lib['SetThreadpoolWaitEx'],
  [
    Fiddle::TYPE_INTPTR_T,  # pwa : PTP_WAIT
    Fiddle::TYPE_VOIDP,  # h : HANDLE optional
    Fiddle::TYPE_VOIDP,  # pftTimeout : FILETIME* optional
    Fiddle::TYPE_VOIDP,  # Reserved : void* optional
  ],
  Fiddle::TYPE_INT)

#[link(name = "kernel32")]
extern "system" {
    fn SetThreadpoolWaitEx(
        pwa: isize,  // PTP_WAIT
        h: *mut core::ffi::c_void,  // HANDLE optional
        pftTimeout: *mut FILETIME,  // FILETIME* optional
        Reserved: *mut ()  // void* optional
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll")]
public static extern bool SetThreadpoolWaitEx(IntPtr pwa, IntPtr h, IntPtr pftTimeout, IntPtr Reserved);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_SetThreadpoolWaitEx' -Namespace Win32 -PassThru
# $api::SetThreadpoolWaitEx(pwa, h, pftTimeout, Reserved)

#uselib "KERNEL32.dll"
#func global SetThreadpoolWaitEx "SetThreadpoolWaitEx" sptr, sptr, sptr, sptr
; SetThreadpoolWaitEx pwa, h, varptr(pftTimeout), Reserved   ; 戻り値は stat
; pwa : PTP_WAIT -> "sptr"
; h : HANDLE optional -> "sptr"
; pftTimeout : FILETIME* optional -> "sptr"
; Reserved : void* optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "KERNEL32.dll"
#cfunc global SetThreadpoolWaitEx "SetThreadpoolWaitEx" sptr, sptr, var, sptr
; res = SetThreadpoolWaitEx(pwa, h, pftTimeout, Reserved)
; pwa : PTP_WAIT -> "sptr"
; h : HANDLE optional -> "sptr"
; pftTimeout : FILETIME* optional -> "var"
; Reserved : void* optional -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "KERNEL32.dll"
#cfunc global SetThreadpoolWaitEx "SetThreadpoolWaitEx" sptr, sptr, sptr, sptr
; res = SetThreadpoolWaitEx(pwa, h, varptr(pftTimeout), Reserved)
; pwa : PTP_WAIT -> "sptr"
; h : HANDLE optional -> "sptr"
; pftTimeout : FILETIME* optional -> "sptr"
; Reserved : void* optional -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。