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

CancelThreadpoolIo

関数
開始通知済みのスレッドプールI/Oを取り消す。
DLLKERNEL32.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

void CancelThreadpoolIo(
    PTP_IO pio
);

パラメーター

名前方向説明
pioPTP_IOinI/O 完了オブジェクトを定義する TP_IO 構造体へのポインター。このポインターは CreateThreadpoolIo 関数によって返されます。

戻り値の型: void

公式ドキュメント

StartThreadpoolIo 関数による通知をキャンセルします。

解説(Remarks)

メモリリークを防ぐため、次のいずれかのシナリオでは CancelThreadpoolIo 関数を呼び出す必要があります。

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

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

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

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procCancelThreadpoolIo = kernel32.NewProc("CancelThreadpoolIo")
)

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

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

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

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

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

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

関連項目

公式の関連項目