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

WaitForThreadpoolIoCallbacks

関数
I/O完了コールバックの完了を待機する。
DLLKERNEL32.dll呼出規約winapi対応OSWindows Vista 以降
📘 Microsoft Learn (日本語) · English

シグネチャ

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

void WaitForThreadpoolIoCallbacks(
    PTP_IO pio,
    BOOL fCancelPendingCallbacks
);

パラメーター

名前型方向説明
pioPTP_IOinI/O 完了オブジェクトを定義する TP_IO 構造体へのポインター。このポインターは CreateThreadpoolIo 関数が返します。
fCancelPendingCallbacksBOOLinまだ実行を開始していないキューに入れられたコールバックをキャンセルするかどうかを示します。

戻り値の型: void

公式ドキュメント

未処理の I/O 完了コールバックの完了を待機し、必要に応じて、まだ実行を開始していない保留中のコールバックをキャンセルします。

解説(Remarks)

fCancelPendingCallbacks が TRUE に設定されている場合、キューに入れられたコールバックのみがキャンセルされます。保留中の I/O 要求はキャンセルされません。したがって呼び出し元は、構造体を解放する前に I/O 操作が完了したかどうかを確認するため、OVERLAPPED 構造体に対して GetOverlappedResult を呼び出す必要があります。あるいは、fCancelPendingCallbacks を FALSE に設定し、関連する I/O 完了コールバックに OVERLAPPED 構造体を解放させる方法もあります。I/O 要求がまだ保留中の間は OVERLAPPED 構造体を解放しないように注意してください。GetOverlappedResult を使用して I/O 操作の状態を判断し、操作の完了を待機します。先に CancelIoEx 関数を使用して未処理の I/O 要求をキャンセルすることもでき、待機時間を短縮できる場合があります。詳細については、「Canceling Pending I/O Operations」を参照してください。

この関数を使用するアプリケーションをコンパイルするには、_WIN32_WINNT を 0x0600 以上として定義します。

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

各言語での呼び出し定義

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

void WaitForThreadpoolIoCallbacks(
    PTP_IO pio,
    BOOL fCancelPendingCallbacks
);
[DllImport("KERNEL32.dll", ExactSpelling = true)]
static extern void WaitForThreadpoolIoCallbacks(
    IntPtr pio,   // PTP_IO
    bool fCancelPendingCallbacks   // BOOL
);
<DllImport("KERNEL32.dll", ExactSpelling:=True)>
Public Shared Sub WaitForThreadpoolIoCallbacks(
    pio As IntPtr,   ' PTP_IO
    fCancelPendingCallbacks As Boolean   ' BOOL
)
End Sub
' pio : PTP_IO
' fCancelPendingCallbacks : BOOL
Declare PtrSafe Sub WaitForThreadpoolIoCallbacks Lib "kernel32" ( _
    ByVal pio As LongPtr, _
    ByVal fCancelPendingCallbacks As Long)
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

WaitForThreadpoolIoCallbacks = ctypes.windll.kernel32.WaitForThreadpoolIoCallbacks
WaitForThreadpoolIoCallbacks.restype = None
WaitForThreadpoolIoCallbacks.argtypes = [
    ctypes.c_ssize_t,  # pio : PTP_IO
    wintypes.BOOL,  # fCancelPendingCallbacks : BOOL
]
require 'fiddle'
require 'fiddle/import'

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

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procWaitForThreadpoolIoCallbacks = kernel32.NewProc("WaitForThreadpoolIoCallbacks")
)

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

extern "kernel32" fn WaitForThreadpoolIoCallbacks(
    pio: isize, // PTP_IO
    fCancelPendingCallbacks: i32 // BOOL
) callconv(std.os.windows.WINAPI) void;
proc WaitForThreadpoolIoCallbacks(
    pio: int,  # PTP_IO
    fCancelPendingCallbacks: int32  # BOOL
) {.importc: "WaitForThreadpoolIoCallbacks", stdcall, dynlib: "KERNEL32.dll".}
pragma(lib, "kernel32");
extern(Windows)
void WaitForThreadpoolIoCallbacks(
    ptrdiff_t pio,   // PTP_IO
    int fCancelPendingCallbacks   // BOOL
);
ccall((:WaitForThreadpoolIoCallbacks, "KERNEL32.dll"), stdcall, Cvoid,
      (Int, Int32),
      pio, fCancelPendingCallbacks)
# pio : PTP_IO -> Int
# fCancelPendingCallbacks : BOOL -> Int32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
void WaitForThreadpoolIoCallbacks(
    intptr_t pio,
    int32_t fCancelPendingCallbacks);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.WaitForThreadpoolIoCallbacks(pio, fCancelPendingCallbacks)
-- pio : PTP_IO
-- fCancelPendingCallbacks : BOOL
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const WaitForThreadpoolIoCallbacks = lib.func('__stdcall', 'WaitForThreadpoolIoCallbacks', 'void', ['intptr_t', 'int32_t']);
// WaitForThreadpoolIoCallbacks(pio, fCancelPendingCallbacks)
// pio : PTP_IO -> 'intptr_t'
// fCancelPendingCallbacks : BOOL -> 'int32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  WaitForThreadpoolIoCallbacks: { parameters: ["isize", "i32"], result: "void" },
});
// lib.symbols.WaitForThreadpoolIoCallbacks(pio, fCancelPendingCallbacks)
// pio : PTP_IO -> "isize"
// fCancelPendingCallbacks : BOOL -> "i32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
void WaitForThreadpoolIoCallbacks(
    intptr_t pio,
    int32_t fCancelPendingCallbacks);
C, "KERNEL32.dll");
// $ffi->WaitForThreadpoolIoCallbacks(pio, fCancelPendingCallbacks);
// pio : PTP_IO
// fCancelPendingCallbacks : BOOL
// 構造体/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 WaitForThreadpoolIoCallbacks(
        long pio,   // PTP_IO
        boolean fCancelPendingCallbacks   // BOOL
    );
}
@[Link("kernel32")]
lib LibKERNEL32
  fun WaitForThreadpoolIoCallbacks = WaitForThreadpoolIoCallbacks(
    pio : LibC::SSizeT,   # PTP_IO
    fCancelPendingCallbacks : Int32   # BOOL
  ) : Void
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

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

foreign import stdcall safe "WaitForThreadpoolIoCallbacks"
  c_WaitForThreadpoolIoCallbacks :: CIntPtr -> CInt -> IO ()
-- pio : PTP_IO -> CIntPtr
-- fCancelPendingCallbacks : BOOL -> CInt
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

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

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

関連項目

公式の関連項目