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

StartThreadpoolIo

関数
ファイルハンドルへの非同期I/O開始をプールに通知する。
DLLKERNEL32.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

void StartThreadpoolIo(
    PTP_IO pio
);

パラメーター

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

戻り値の型: void

公式ドキュメント

指定した I/O 完了オブジェクトに対して I/O 操作が開始される可能性があることをスレッドプールに通知します。このオブジェクトにバインドされたファイルハンドル上で操作が完了すると、ワーカースレッドが I/O 完了オブジェクトのコールバック関数を呼び出します。

解説(Remarks)

I/O 完了オブジェクトにバインドされたファイルハンドル上で非同期 I/O 操作を開始する前に、その操作ごとにこの関数を呼び出す必要があります。これを怠ると、スレッドプールは I/O 操作の完了時にその操作を無視し、メモリ破壊を引き起こします。

I/O 操作が失敗した場合は、CancelThreadpoolIo 関数を呼び出してこの通知をキャンセルしてください。

I/O 完了オブジェクトにバインドされたファイルハンドルに通知モード FILE_SKIP_COMPLETION_PORT_ON_SUCCESS が設定されており、非同期 I/O 操作が即座に成功して返された場合、そのオブジェクトの I/O 完了コールバック関数は呼び出されず、スレッドプールの I/O 通知をキャンセルする必要があります。詳細については、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 StartThreadpoolIo(
    PTP_IO pio
);
[DllImport("KERNEL32.dll", ExactSpelling = true)]
static extern void StartThreadpoolIo(
    IntPtr pio   // PTP_IO
);
<DllImport("KERNEL32.dll", ExactSpelling:=True)>
Public Shared Sub StartThreadpoolIo(
    pio As IntPtr   ' PTP_IO
)
End Sub
' pio : PTP_IO
Declare PtrSafe Sub StartThreadpoolIo Lib "kernel32" ( _
    ByVal pio As LongPtr)
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

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

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

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procStartThreadpoolIo = kernel32.NewProc("StartThreadpoolIo")
)

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

extern "kernel32" fn StartThreadpoolIo(
    pio: isize // PTP_IO
) callconv(std.os.windows.WINAPI) void;
proc StartThreadpoolIo(
    pio: int  # PTP_IO
) {.importc: "StartThreadpoolIo", stdcall, dynlib: "KERNEL32.dll".}
pragma(lib, "kernel32");
extern(Windows)
void StartThreadpoolIo(
    ptrdiff_t pio   // PTP_IO
);
ccall((:StartThreadpoolIo, "KERNEL32.dll"), stdcall, Cvoid,
      (Int,),
      pio)
# pio : PTP_IO -> Int
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
void StartThreadpoolIo(
    intptr_t pio);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.StartThreadpoolIo(pio)
-- pio : PTP_IO
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const StartThreadpoolIo = lib.func('__stdcall', 'StartThreadpoolIo', 'void', ['intptr_t']);
// StartThreadpoolIo(pio)
// pio : PTP_IO -> 'intptr_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  StartThreadpoolIo: { parameters: ["isize"], result: "void" },
});
// lib.symbols.StartThreadpoolIo(pio)
// pio : PTP_IO -> "isize"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
void StartThreadpoolIo(
    intptr_t pio);
C, "KERNEL32.dll");
// $ffi->StartThreadpoolIo(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 StartThreadpoolIo(
        long pio   // PTP_IO
    );
}
@[Link("kernel32")]
lib LibKERNEL32
  fun StartThreadpoolIo = StartThreadpoolIo(
    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 StartThreadpoolIoNative = Void Function(IntPtr);
typedef StartThreadpoolIoDart = void Function(int);
final StartThreadpoolIo = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<StartThreadpoolIoNative, StartThreadpoolIoDart>('StartThreadpoolIo');
// pio : PTP_IO -> IntPtr
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
procedure StartThreadpoolIo(
  pio: NativeInt   // PTP_IO
); stdcall;
  external 'KERNEL32.dll' name 'StartThreadpoolIo';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let startthreadpoolio =
  foreign "StartThreadpoolIo"
    (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 ("StartThreadpoolIo" start-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 $StartThreadpoolIo = Win32::API::More->new('KERNEL32',
    'void StartThreadpoolIo(LPARAM pio)');
# my $ret = $StartThreadpoolIo->Call($pio);
# pio : PTP_IO -> LPARAM
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目