ホーム › System.Threading › CloseThreadpoolTimer
CloseThreadpoolTimer
関数スレッドプールのタイマーオブジェクトを解放する。
シグネチャ
// KERNEL32.dll
#include <windows.h>
void CloseThreadpoolTimer(
PTP_TIMER pti
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| pti | PTP_TIMER | in | タイマーオブジェクトを定義する TP_TIMER 構造体へのポインターです。 このポインターは CreateThreadpoolTimer 関数が返します。 |
戻り値の型: void
公式ドキュメント
指定したタイマーオブジェクトを解放します。
解説(Remarks)
未処理のコールバックが存在しない場合、タイマーオブジェクトは直ちに解放されます。それ以外の場合、タイマーオブジェクトは未処理のコールバック関数が完了した後に非同期で解放されます。
場合によっては、CloseThreadpoolTimer を呼び出した後にコールバック関数が実行されることがあります。この動作を防ぐには、次のようにします。
- pftDueTime パラメーターを NULL に設定し、msPeriod および msWindowLength パラメーターを 0 に設定して、SetThreadpoolTimer 関数または SetThreadpoolTimerEx 関数を呼び出します。
- fCancelPendingCallbacks パラメーターを TRUE に設定して WaitForThreadpoolTimerCallbacks 関数を呼び出します。
- CloseThreadpoolTimer を呼び出します。
タイマーオブジェクトにクリーンアップグループが関連付けられている場合、この関数を呼び出す必要はありません。CloseThreadpoolCleanupGroupMembers 関数を呼び出すと、クリーンアップグループに関連付けられた work、wait、timer の各オブジェクトが解放されます。
この関数を使用するアプリケーションをコンパイルするには、_WIN32_WINNT を 0x0600 以上として定義します。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// KERNEL32.dll
#include <windows.h>
void CloseThreadpoolTimer(
PTP_TIMER pti
);[DllImport("KERNEL32.dll", ExactSpelling = true)]
static extern void CloseThreadpoolTimer(
IntPtr pti // PTP_TIMER
);<DllImport("KERNEL32.dll", ExactSpelling:=True)>
Public Shared Sub CloseThreadpoolTimer(
pti As IntPtr ' PTP_TIMER
)
End Sub' pti : PTP_TIMER
Declare PtrSafe Sub CloseThreadpoolTimer Lib "kernel32" ( _
ByVal pti As LongPtr)
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
CloseThreadpoolTimer = ctypes.windll.kernel32.CloseThreadpoolTimer
CloseThreadpoolTimer.restype = None
CloseThreadpoolTimer.argtypes = [
ctypes.c_ssize_t, # pti : PTP_TIMER
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('KERNEL32.dll')
CloseThreadpoolTimer = Fiddle::Function.new(
lib['CloseThreadpoolTimer'],
[
Fiddle::TYPE_INTPTR_T, # pti : PTP_TIMER
],
Fiddle::TYPE_VOID)#[link(name = "kernel32")]
extern "system" {
fn CloseThreadpoolTimer(
pti: isize // PTP_TIMER
);
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("KERNEL32.dll")]
public static extern void CloseThreadpoolTimer(IntPtr pti);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_CloseThreadpoolTimer' -Namespace Win32 -PassThru
# $api::CloseThreadpoolTimer(pti)#uselib "KERNEL32.dll"
#func global CloseThreadpoolTimer "CloseThreadpoolTimer" sptr
; CloseThreadpoolTimer pti
; pti : PTP_TIMER -> "sptr"#uselib "KERNEL32.dll"
#func global CloseThreadpoolTimer "CloseThreadpoolTimer" sptr
; CloseThreadpoolTimer pti
; pti : PTP_TIMER -> "sptr"; void CloseThreadpoolTimer(PTP_TIMER pti)
#uselib "KERNEL32.dll"
#func global CloseThreadpoolTimer "CloseThreadpoolTimer" intptr
; CloseThreadpoolTimer pti
; pti : PTP_TIMER -> "intptr"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
procCloseThreadpoolTimer = kernel32.NewProc("CloseThreadpoolTimer")
)
// pti (PTP_TIMER)
r1, _, err := procCloseThreadpoolTimer.Call(
uintptr(pti),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // voidprocedure CloseThreadpoolTimer(
pti: NativeInt // PTP_TIMER
); stdcall;
external 'KERNEL32.dll' name 'CloseThreadpoolTimer';result := DllCall("KERNEL32\CloseThreadpoolTimer"
, "Ptr", pti ; PTP_TIMER
, "Int") ; return: void●CloseThreadpoolTimer(pti) = DLL("KERNEL32.dll", "int CloseThreadpoolTimer(int)")
# 呼び出し: CloseThreadpoolTimer(pti)
# pti : PTP_TIMER -> "int"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "kernel32" fn CloseThreadpoolTimer(
pti: isize // PTP_TIMER
) callconv(std.os.windows.WINAPI) void;proc CloseThreadpoolTimer(
pti: int # PTP_TIMER
) {.importc: "CloseThreadpoolTimer", stdcall, dynlib: "KERNEL32.dll".}pragma(lib, "kernel32");
extern(Windows)
void CloseThreadpoolTimer(
ptrdiff_t pti // PTP_TIMER
);ccall((:CloseThreadpoolTimer, "KERNEL32.dll"), stdcall, Cvoid,
(Int,),
pti)
# pti : PTP_TIMER -> Int
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
void CloseThreadpoolTimer(
intptr_t pti);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.CloseThreadpoolTimer(pti)
-- pti : PTP_TIMER
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const CloseThreadpoolTimer = lib.func('__stdcall', 'CloseThreadpoolTimer', 'void', ['intptr_t']);
// CloseThreadpoolTimer(pti)
// pti : PTP_TIMER -> 'intptr_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("KERNEL32.dll", {
CloseThreadpoolTimer: { parameters: ["isize"], result: "void" },
});
// lib.symbols.CloseThreadpoolTimer(pti)
// pti : PTP_TIMER -> "isize"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
void CloseThreadpoolTimer(
intptr_t pti);
C, "KERNEL32.dll");
// $ffi->CloseThreadpoolTimer(pti);
// pti : PTP_TIMER
// 構造体/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 CloseThreadpoolTimer(
long pti // PTP_TIMER
);
}@[Link("kernel32")]
lib LibKERNEL32
fun CloseThreadpoolTimer = CloseThreadpoolTimer(
pti : LibC::SSizeT # PTP_TIMER
) : Void
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef CloseThreadpoolTimerNative = Void Function(IntPtr);
typedef CloseThreadpoolTimerDart = void Function(int);
final CloseThreadpoolTimer = DynamicLibrary.open('KERNEL32.dll')
.lookupFunction<CloseThreadpoolTimerNative, CloseThreadpoolTimerDart>('CloseThreadpoolTimer');
// pti : PTP_TIMER -> IntPtr
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
procedure CloseThreadpoolTimer(
pti: NativeInt // PTP_TIMER
); stdcall;
external 'KERNEL32.dll' name 'CloseThreadpoolTimer';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "CloseThreadpoolTimer"
c_CloseThreadpoolTimer :: CIntPtr -> IO ()
-- pti : PTP_TIMER -> CIntPtr
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let closethreadpooltimer =
foreign "CloseThreadpoolTimer"
(intptr_t @-> returning void)
(* pti : PTP_TIMER -> intptr_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)
(cffi:defcfun ("CloseThreadpoolTimer" close-threadpool-timer :convention :stdcall) :void
(pti :int64)) ; PTP_TIMER
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $CloseThreadpoolTimer = Win32::API::More->new('KERNEL32',
'void CloseThreadpoolTimer(LPARAM pti)');
# my $ret = $CloseThreadpoolTimer->Call($pti);
# pti : PTP_TIMER -> LPARAM
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
公式の関連項目
- f CreateThreadpoolTimer — スレッドプールのタイマーオブジェクトを作成する。
- f IsThreadpoolTimerSet — スレッドプールタイマーが設定済みか判定する。
- f SetThreadpoolTimer — スレッドプールタイマーの発火時刻と周期を設定する。
- f SetThreadpoolTimerEx — スレッドプールタイマーの発火時刻と周期を設定する(拡張版)。
- f WaitForThreadpoolTimerCallbacks — タイマーコールバックの完了を待機する。