ホーム › System.Threading › SetThreadpoolWait

SetThreadpoolWait

関数

待機オブジェクトの監視ハンドルとタイムアウトを設定する。

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

シグネチャ

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

void SetThreadpoolWait(
    PTP_WAIT pwa,
    HANDLE h,   // optional
    FILETIME* pftTimeout   // optional
);

パラメーター

名前	型	方向	説明
pwa	PTP_WAIT	in	待機オブジェクトを定義する TP_WAIT 構造体へのポインターです。このポインターは CreateThreadpoolWait 関数が返します。
h	HANDLE	inoptional	ハンドルです。このパラメーターが NULL の場合、待機オブジェクトは新しいコールバックのキューイングを停止します(ただし、すでにキューに入っているコールバックは引き続き実行されます)。このパラメーターが NULL でない場合は、有効な待機可能オブジェクトを参照している必要があります。ミューテックスはサポートされていません。ミューテックスのハンドルが渡された場合、スレッドプールは STATUS_THREADPOOL_HANDLE_EXCEPTION 例外を発生させ、ExceptionRecord.ExceptionInformation[0] は STATUS_INVALID_PARAMETER_3 と等しくなります。このハンドルが待機の保留中に閉じられた場合、関数の動作は未定義です。待機が保留中でハンドルを閉じる必要がある場合は、CloseThreadpoolWait を使用して待機をキャンセルしてからハンドルを閉じてください。このパラメーターが NULL 以外の場合、待機は設定されたものとみなされます。
pftTimeout	FILETIME*	inoptional	待機操作がタイムアウトする絶対時刻または相対時刻を指定する FILETIME 構造体へのポインターです。このパラメーターが正の値を指す場合、1601 年 1 月 1 日(UTC)からの絶対時刻を 100 ナノ秒間隔で示します。負の値を指す場合、現在時刻からの相対的な待機時間を示します。時刻値の詳細については、File Times を参照してください。このパラメーターが 0 を指す場合、待機は直ちにタイムアウトします。このパラメーターが NULL の場合、待機はタイムアウトしません。

名前

型

方向

説明

pwa

PTP_WAIT

待機オブジェクトを定義する TP_WAIT 構造体へのポインターです。このポインターは CreateThreadpoolWait 関数が返します。

HANDLE

inoptional

ハンドルです。

このパラメーターが NULL の場合、待機オブジェクトは新しいコールバックのキューイングを停止します(ただし、すでにキューに入っているコールバックは引き続き実行されます)。

このパラメーターが NULL でない場合は、有効な待機可能オブジェクトを参照している必要があります。

ミューテックスはサポートされていません。ミューテックスのハンドルが渡された場合、スレッドプールは STATUS_THREADPOOL_HANDLE_EXCEPTION 例外を発生させ、ExceptionRecord.ExceptionInformation[0] は STATUS_INVALID_PARAMETER_3 と等しくなります。

このハンドルが待機の保留中に閉じられた場合、関数の動作は未定義です。待機が保留中でハンドルを閉じる必要がある場合は、CloseThreadpoolWait を使用して待機をキャンセルしてからハンドルを閉じてください。

このパラメーターが NULL 以外の場合、待機は設定されたものとみなされます。

pftTimeout

FILETIME*

inoptional

待機操作がタイムアウトする絶対時刻または相対時刻を指定する FILETIME 構造体へのポインターです。このパラメーターが正の値を指す場合、1601 年 1 月 1 日(UTC)からの絶対時刻を 100 ナノ秒間隔で示します。負の値を指す場合、現在時刻からの相対的な待機時間を示します。時刻値の詳細については、File Times を参照してください。

このパラメーターが 0 を指す場合、待機は直ちにタイムアウトします。このパラメーターが NULL の場合、待機はタイムアウトしません。

戻り値の型: void

公式ドキュメント

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

解説(Remarks)

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

待機コールバックをトリガーするには、シグナル状態にする前に毎回イベントを待機オブジェクトに再登録する必要があります。

この関数を使用するアプリケーションをコンパイルするには、_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 SetThreadpoolWait(
    PTP_WAIT pwa,
    HANDLE h,   // optional
    FILETIME* pftTimeout   // optional
);

[DllImport("KERNEL32.dll", ExactSpelling = true)]
static extern void SetThreadpoolWait(
    IntPtr pwa,   // PTP_WAIT
    IntPtr h,   // HANDLE optional
    IntPtr pftTimeout   // FILETIME* optional
);

<DllImport("KERNEL32.dll", ExactSpelling:=True)>
Public Shared Sub SetThreadpoolWait(
    pwa As IntPtr,   ' PTP_WAIT
    h As IntPtr,   ' HANDLE optional
    pftTimeout As IntPtr   ' FILETIME* optional
)
End Sub

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

import ctypes
from ctypes import wintypes

SetThreadpoolWait = ctypes.windll.kernel32.SetThreadpoolWait
SetThreadpoolWait.restype = None
SetThreadpoolWait.argtypes = [
    ctypes.c_ssize_t,  # pwa : PTP_WAIT
    wintypes.HANDLE,  # h : HANDLE optional
    ctypes.c_void_p,  # pftTimeout : FILETIME* optional
]

require 'fiddle'
require 'fiddle/import'

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

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

$sig = @"
[DllImport("KERNEL32.dll")]
public static extern void SetThreadpoolWait(IntPtr pwa, IntPtr h, IntPtr pftTimeout);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_SetThreadpoolWait' -Namespace Win32 -PassThru
# $api::SetThreadpoolWait(pwa, h, pftTimeout)

#uselib "KERNEL32.dll"
#func global SetThreadpoolWait "SetThreadpoolWait" sptr, sptr, sptr
; SetThreadpoolWait pwa, h, varptr(pftTimeout)
; pwa : PTP_WAIT -> "sptr"
; h : HANDLE optional -> "sptr"
; pftTimeout : FILETIME* optional -> "sptr"

出力引数:

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