Win32 API 日本語リファレンス
ホームSystem.Threading › CloseThreadpoolWait

CloseThreadpoolWait

関数
スレッドプールの待機オブジェクトを解放する。
DLLKERNEL32.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

void CloseThreadpoolWait(
    PTP_WAIT pwa
);

パラメーター

名前方向説明
pwaPTP_WAITin待機オブジェクトを定義する TP_WAIT 構造体へのポインター。CreateThreadpoolWait 関数がこのポインターを返します。

戻り値の型: void

公式ドキュメント

指定された待機オブジェクトを解放します。

解説(Remarks)

未処理のコールバックがない場合、待機オブジェクトは直ちに解放されます。それ以外の場合は、未処理のコールバックが完了した後、タイマーオブジェクトが非同期に解放されます。

場合によっては、CloseThreadpoolWait の呼び出し後にコールバック関数が実行されることがあります。この動作を防ぐには、次のいずれかを行います。

待機オブジェクトに関連付けられたクリーンアップグループがある場合、この関数を呼び出す必要はありません。CloseThreadpoolCleanupGroupMembers 関数を呼び出すと、クリーンアップグループに関連付けられた作業オブジェクト、待機オブジェクト、およびタイマーオブジェクトが解放されます。

この関数を使用するアプリケーションをコンパイルするには、_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 CloseThreadpoolWait(
    PTP_WAIT pwa
);
[DllImport("KERNEL32.dll", ExactSpelling = true)]
static extern void CloseThreadpoolWait(
    IntPtr pwa   // PTP_WAIT
);
<DllImport("KERNEL32.dll", ExactSpelling:=True)>
Public Shared Sub CloseThreadpoolWait(
    pwa As IntPtr   ' PTP_WAIT
)
End Sub
' pwa : PTP_WAIT
Declare PtrSafe Sub CloseThreadpoolWait Lib "kernel32" ( _
    ByVal pwa As LongPtr)
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

CloseThreadpoolWait = ctypes.windll.kernel32.CloseThreadpoolWait
CloseThreadpoolWait.restype = None
CloseThreadpoolWait.argtypes = [
    ctypes.c_ssize_t,  # pwa : PTP_WAIT
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
CloseThreadpoolWait = Fiddle::Function.new(
  lib['CloseThreadpoolWait'],
  [
    Fiddle::TYPE_INTPTR_T,  # pwa : PTP_WAIT
  ],
  Fiddle::TYPE_VOID)
#[link(name = "kernel32")]
extern "system" {
    fn CloseThreadpoolWait(
        pwa: isize  // PTP_WAIT
    );
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("KERNEL32.dll")]
public static extern void CloseThreadpoolWait(IntPtr pwa);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_CloseThreadpoolWait' -Namespace Win32 -PassThru
# $api::CloseThreadpoolWait(pwa)
#uselib "KERNEL32.dll"
#func global CloseThreadpoolWait "CloseThreadpoolWait" sptr
; CloseThreadpoolWait pwa
; pwa : PTP_WAIT -> "sptr"
#uselib "KERNEL32.dll"
#func global CloseThreadpoolWait "CloseThreadpoolWait" sptr
; CloseThreadpoolWait pwa
; pwa : PTP_WAIT -> "sptr"
; void CloseThreadpoolWait(PTP_WAIT pwa)
#uselib "KERNEL32.dll"
#func global CloseThreadpoolWait "CloseThreadpoolWait" intptr
; CloseThreadpoolWait pwa
; pwa : PTP_WAIT -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procCloseThreadpoolWait = kernel32.NewProc("CloseThreadpoolWait")
)

// pwa (PTP_WAIT)
r1, _, err := procCloseThreadpoolWait.Call(
	uintptr(pwa),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // void
procedure CloseThreadpoolWait(
  pwa: NativeInt   // PTP_WAIT
); stdcall;
  external 'KERNEL32.dll' name 'CloseThreadpoolWait';
result := DllCall("KERNEL32\CloseThreadpoolWait"
    , "Ptr", pwa   ; PTP_WAIT
    , "Int")   ; return: void
●CloseThreadpoolWait(pwa) = DLL("KERNEL32.dll", "int CloseThreadpoolWait(int)")
# 呼び出し: CloseThreadpoolWait(pwa)
# pwa : PTP_WAIT -> "int"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "kernel32" fn CloseThreadpoolWait(
    pwa: isize // PTP_WAIT
) callconv(std.os.windows.WINAPI) void;
proc CloseThreadpoolWait(
    pwa: int  # PTP_WAIT
) {.importc: "CloseThreadpoolWait", stdcall, dynlib: "KERNEL32.dll".}
pragma(lib, "kernel32");
extern(Windows)
void CloseThreadpoolWait(
    ptrdiff_t pwa   // PTP_WAIT
);
ccall((:CloseThreadpoolWait, "KERNEL32.dll"), stdcall, Cvoid,
      (Int,),
      pwa)
# pwa : PTP_WAIT -> Int
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
void CloseThreadpoolWait(
    intptr_t pwa);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.CloseThreadpoolWait(pwa)
-- pwa : PTP_WAIT
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const CloseThreadpoolWait = lib.func('__stdcall', 'CloseThreadpoolWait', 'void', ['intptr_t']);
// CloseThreadpoolWait(pwa)
// pwa : PTP_WAIT -> 'intptr_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  CloseThreadpoolWait: { parameters: ["isize"], result: "void" },
});
// lib.symbols.CloseThreadpoolWait(pwa)
// pwa : PTP_WAIT -> "isize"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
void CloseThreadpoolWait(
    intptr_t pwa);
C, "KERNEL32.dll");
// $ffi->CloseThreadpoolWait(pwa);
// pwa : PTP_WAIT
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Kernel32 extends StdCallLibrary {
    Kernel32 INSTANCE = Native.load("kernel32", Kernel32.class);
    void CloseThreadpoolWait(
        long pwa   // PTP_WAIT
    );
}
@[Link("kernel32")]
lib LibKERNEL32
  fun CloseThreadpoolWait = CloseThreadpoolWait(
    pwa : LibC::SSizeT   # PTP_WAIT
  ) : Void
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef CloseThreadpoolWaitNative = Void Function(IntPtr);
typedef CloseThreadpoolWaitDart = void Function(int);
final CloseThreadpoolWait = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<CloseThreadpoolWaitNative, CloseThreadpoolWaitDart>('CloseThreadpoolWait');
// pwa : PTP_WAIT -> IntPtr
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
procedure CloseThreadpoolWait(
  pwa: NativeInt   // PTP_WAIT
); stdcall;
  external 'KERNEL32.dll' name 'CloseThreadpoolWait';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "CloseThreadpoolWait"
  c_CloseThreadpoolWait :: CIntPtr -> IO ()
-- pwa : PTP_WAIT -> CIntPtr
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let closethreadpoolwait =
  foreign "CloseThreadpoolWait"
    (intptr_t @-> returning void)
(* pwa : PTP_WAIT -> intptr_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("CloseThreadpoolWait" close-threadpool-wait :convention :stdcall) :void
  (pwa :int64))   ; PTP_WAIT
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $CloseThreadpoolWait = Win32::API::More->new('KERNEL32',
    'void CloseThreadpoolWait(LPARAM pwa)');
# my $ret = $CloseThreadpoolWait->Call($pwa);
# pwa : PTP_WAIT -> LPARAM
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目