BindIoCompletionCallback
関数シグネチャ
// KERNEL32.dll
#include <windows.h>
BOOL BindIoCompletionCallback(
HANDLE FileHandle,
LPOVERLAPPED_COMPLETION_ROUTINE Function,
DWORD Flags
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| FileHandle | HANDLE | in | オーバーラップ I/O 完了用に開かれたファイルへのハンドル。このハンドルは、FILE_FLAG_OVERLAPPED フラグを指定した CreateFile 関数によって返されます。 |
| Function | LPOVERLAPPED_COMPLETION_ROUTINE | in | I/O 操作が完了したときに、I/O 以外のワーカースレッドで実行されるコールバック関数へのポインター。このコールバック関数は TerminateThread 関数を呼び出してはなりません。 完了ルーチンの詳細については、 FileIOCompletionRoutine を参照してください。 |
| Flags | DWORD | in | このパラメーターは 0 でなければなりません。 |
戻り値の型: BOOL
公式ドキュメント
スレッドプールが所有する I/O 完了ポートを、指定されたファイルハンドルに関連付けます。このファイルに対する I/O 要求が完了すると、I/O 以外のワーカースレッドが指定されたコールバック関数を実行します。
戻り値
関数が成功した場合、戻り値は 0 以外になります。
関数が失敗した場合、戻り値は 0 になります。拡張エラー情報を取得するには、 GetLastError 関数を呼び出してください。
解説(Remarks)
プロセスが FileHandle パラメーターで指定されたファイルに対して非同期要求を発行したものの、その要求が ERROR_IO_PENDING 以外のエラーコードで即座に返された場合、コールバック関数は実行されないことがあります。
非同期 I/O 要求を開始したスレッドが、その要求が完了する前に終了しないようにしてください。また、DLL 内の関数がワーカースレッドにキューイングされている場合は、DLL がアンロードされる前に DLL 内のその関数の実行が完了していることを確認してください。
スレッドプールは I/O 完了ポートを保持しています。BindIoCompletionCallback を呼び出すと、指定されたファイルがスレッドプールの I/O 完了ポートに関連付けられます。そのファイルオブジェクトに対する非同期要求は、完了ポートへのポストによって完了し、スレッドプールのワーカースレッドによって取得されます。非同期プロシージャ呼び出しとして完了する I/O 要求を発行する必要があるコールバックのために、スレッドプールは I/O ワーカープールを提供します。I/O ワーカースレッドは完了ポートを待機せず、警告可能な待機状態でスリープし、完了した I/O 要求パケットによって起こされます。どちらの種類のワーカースレッドも、自身に対して保留中の I/O があるかどうかを確認し、保留中であれば終了しません。詳細については、Asynchronous Procedure Calls を参照してください。
この関数を使用するアプリケーションをコンパイルするには、_WIN32_WINNT を 0x0500 以降として定義してください。詳細については、 Using the Windows Headers を参照してください。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// KERNEL32.dll
#include <windows.h>
BOOL BindIoCompletionCallback(
HANDLE FileHandle,
LPOVERLAPPED_COMPLETION_ROUTINE Function,
DWORD Flags
);[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool BindIoCompletionCallback(
IntPtr FileHandle, // HANDLE
IntPtr Function, // LPOVERLAPPED_COMPLETION_ROUTINE
uint Flags // DWORD
);<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function BindIoCompletionCallback(
FileHandle As IntPtr, ' HANDLE
[Function] As IntPtr, ' LPOVERLAPPED_COMPLETION_ROUTINE
Flags As UInteger ' DWORD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function' FileHandle : HANDLE
' Function : LPOVERLAPPED_COMPLETION_ROUTINE
' Flags : DWORD
Declare PtrSafe Function BindIoCompletionCallback Lib "kernel32" ( _
ByVal FileHandle As LongPtr, _
ByVal Function As LongPtr, _
ByVal Flags As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
BindIoCompletionCallback = ctypes.windll.kernel32.BindIoCompletionCallback
BindIoCompletionCallback.restype = wintypes.BOOL
BindIoCompletionCallback.argtypes = [
wintypes.HANDLE, # FileHandle : HANDLE
ctypes.c_void_p, # Function : LPOVERLAPPED_COMPLETION_ROUTINE
wintypes.DWORD, # Flags : DWORD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('KERNEL32.dll')
BindIoCompletionCallback = Fiddle::Function.new(
lib['BindIoCompletionCallback'],
[
Fiddle::TYPE_VOIDP, # FileHandle : HANDLE
Fiddle::TYPE_VOIDP, # Function : LPOVERLAPPED_COMPLETION_ROUTINE
-Fiddle::TYPE_INT, # Flags : DWORD
],
Fiddle::TYPE_INT)#[link(name = "kernel32")]
extern "system" {
fn BindIoCompletionCallback(
FileHandle: *mut core::ffi::c_void, // HANDLE
Function: *const core::ffi::c_void, // LPOVERLAPPED_COMPLETION_ROUTINE
Flags: u32 // DWORD
) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true)]
public static extern bool BindIoCompletionCallback(IntPtr FileHandle, IntPtr Function, uint Flags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_BindIoCompletionCallback' -Namespace Win32 -PassThru
# $api::BindIoCompletionCallback(FileHandle, Function, Flags)#uselib "KERNEL32.dll"
#func global BindIoCompletionCallback "BindIoCompletionCallback" sptr, sptr, sptr
; BindIoCompletionCallback FileHandle, Function, Flags ; 戻り値は stat
; FileHandle : HANDLE -> "sptr"
; Function : LPOVERLAPPED_COMPLETION_ROUTINE -> "sptr"
; Flags : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "KERNEL32.dll"
#cfunc global BindIoCompletionCallback "BindIoCompletionCallback" sptr, sptr, int
; res = BindIoCompletionCallback(FileHandle, Function, Flags)
; FileHandle : HANDLE -> "sptr"
; Function : LPOVERLAPPED_COMPLETION_ROUTINE -> "sptr"
; Flags : DWORD -> "int"; BOOL BindIoCompletionCallback(HANDLE FileHandle, LPOVERLAPPED_COMPLETION_ROUTINE Function, DWORD Flags)
#uselib "KERNEL32.dll"
#cfunc global BindIoCompletionCallback "BindIoCompletionCallback" intptr, intptr, int
; res = BindIoCompletionCallback(FileHandle, Function, Flags)
; FileHandle : HANDLE -> "intptr"
; Function : LPOVERLAPPED_COMPLETION_ROUTINE -> "intptr"
; Flags : DWORD -> "int"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
procBindIoCompletionCallback = kernel32.NewProc("BindIoCompletionCallback")
)
// FileHandle (HANDLE), Function (LPOVERLAPPED_COMPLETION_ROUTINE), Flags (DWORD)
r1, _, err := procBindIoCompletionCallback.Call(
uintptr(FileHandle),
uintptr(Function),
uintptr(Flags),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // BOOLfunction BindIoCompletionCallback(
FileHandle: THandle; // HANDLE
Function: Pointer; // LPOVERLAPPED_COMPLETION_ROUTINE
Flags: DWORD // DWORD
): BOOL; stdcall;
external 'KERNEL32.dll' name 'BindIoCompletionCallback';result := DllCall("KERNEL32\BindIoCompletionCallback"
, "Ptr", FileHandle ; HANDLE
, "Ptr", Function ; LPOVERLAPPED_COMPLETION_ROUTINE
, "UInt", Flags ; DWORD
, "Int") ; return: BOOL●BindIoCompletionCallback(FileHandle, Function, Flags) = DLL("KERNEL32.dll", "bool BindIoCompletionCallback(void*, void*, dword)")
# 呼び出し: BindIoCompletionCallback(FileHandle, Function, Flags)
# FileHandle : HANDLE -> "void*"
# Function : LPOVERLAPPED_COMPLETION_ROUTINE -> "void*"
# Flags : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "kernel32" fn BindIoCompletionCallback(
FileHandle: ?*anyopaque, // HANDLE
Function: ?*anyopaque, // LPOVERLAPPED_COMPLETION_ROUTINE
Flags: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;proc BindIoCompletionCallback(
FileHandle: pointer, # HANDLE
Function: pointer, # LPOVERLAPPED_COMPLETION_ROUTINE
Flags: uint32 # DWORD
): int32 {.importc: "BindIoCompletionCallback", stdcall, dynlib: "KERNEL32.dll".}pragma(lib, "kernel32");
extern(Windows)
int BindIoCompletionCallback(
void* FileHandle, // HANDLE
void* Function, // LPOVERLAPPED_COMPLETION_ROUTINE
uint Flags // DWORD
);ccall((:BindIoCompletionCallback, "KERNEL32.dll"), stdcall, Int32,
(Ptr{Cvoid}, Ptr{Cvoid}, UInt32),
FileHandle, Function, Flags)
# FileHandle : HANDLE -> Ptr{Cvoid}
# Function : LPOVERLAPPED_COMPLETION_ROUTINE -> Ptr{Cvoid}
# Flags : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t BindIoCompletionCallback(
void* FileHandle,
void* Function,
uint32_t Flags);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.BindIoCompletionCallback(FileHandle, Function, Flags)
-- FileHandle : HANDLE
-- Function : LPOVERLAPPED_COMPLETION_ROUTINE
-- Flags : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const BindIoCompletionCallback = lib.func('__stdcall', 'BindIoCompletionCallback', 'int32_t', ['void *', 'void *', 'uint32_t']);
// BindIoCompletionCallback(FileHandle, Function, Flags)
// FileHandle : HANDLE -> 'void *'
// Function : LPOVERLAPPED_COMPLETION_ROUTINE -> 'void *'
// Flags : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
// コールバック(関数ポインタ)は koffi.proto/koffi.register で型を定義して渡す(素の void* では JS 関数を渡せない)。const lib = Deno.dlopen("KERNEL32.dll", {
BindIoCompletionCallback: { parameters: ["pointer", "pointer", "u32"], result: "i32" },
});
// lib.symbols.BindIoCompletionCallback(FileHandle, Function, Flags)
// FileHandle : HANDLE -> "pointer"
// Function : LPOVERLAPPED_COMPLETION_ROUTINE -> "pointer"
// Flags : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t BindIoCompletionCallback(
void* FileHandle,
void* Function,
uint32_t Flags);
C, "KERNEL32.dll");
// $ffi->BindIoCompletionCallback(FileHandle, Function, Flags);
// FileHandle : HANDLE
// Function : LPOVERLAPPED_COMPLETION_ROUTINE
// Flags : DWORD
// 構造体/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);
boolean BindIoCompletionCallback(
Pointer FileHandle, // HANDLE
Callback Function, // LPOVERLAPPED_COMPLETION_ROUTINE
int Flags // DWORD
);
}@[Link("kernel32")]
lib LibKERNEL32
fun BindIoCompletionCallback = BindIoCompletionCallback(
FileHandle : Void*, # HANDLE
Function : Void*, # LPOVERLAPPED_COMPLETION_ROUTINE
Flags : UInt32 # DWORD
) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef BindIoCompletionCallbackNative = Int32 Function(Pointer<Void>, Pointer<Void>, Uint32);
typedef BindIoCompletionCallbackDart = int Function(Pointer<Void>, Pointer<Void>, int);
final BindIoCompletionCallback = DynamicLibrary.open('KERNEL32.dll')
.lookupFunction<BindIoCompletionCallbackNative, BindIoCompletionCallbackDart>('BindIoCompletionCallback');
// FileHandle : HANDLE -> Pointer<Void>
// Function : LPOVERLAPPED_COMPLETION_ROUTINE -> Pointer<Void>
// Flags : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function BindIoCompletionCallback(
FileHandle: THandle; // HANDLE
Function: Pointer; // LPOVERLAPPED_COMPLETION_ROUTINE
Flags: DWORD // DWORD
): BOOL; stdcall;
external 'KERNEL32.dll' name 'BindIoCompletionCallback';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "BindIoCompletionCallback"
c_BindIoCompletionCallback :: Ptr () -> Ptr () -> Word32 -> IO CInt
-- FileHandle : HANDLE -> Ptr ()
-- Function : LPOVERLAPPED_COMPLETION_ROUTINE -> Ptr ()
-- Flags : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let bindiocompletioncallback =
foreign "BindIoCompletionCallback"
((ptr void) @-> (ptr void) @-> uint32_t @-> returning int32_t)
(* FileHandle : HANDLE -> (ptr void) *)
(* Function : LPOVERLAPPED_COMPLETION_ROUTINE -> (ptr void) *)
(* Flags : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)
(cffi:defcfun ("BindIoCompletionCallback" bind-io-completion-callback :convention :stdcall) :int32
(file-handle :pointer) ; HANDLE
(function :pointer) ; LPOVERLAPPED_COMPLETION_ROUTINE
(flags :uint32)) ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $BindIoCompletionCallback = Win32::API::More->new('KERNEL32',
'BOOL BindIoCompletionCallback(HANDLE FileHandle, LPVOID Function, DWORD Flags)');
# my $ret = $BindIoCompletionCallback->Call($FileHandle, $Function, $Flags);
# FileHandle : HANDLE -> HANDLE
# Function : LPOVERLAPPED_COMPLETION_ROUTINE -> LPVOID
# Flags : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# コールバック(関数ポインタ)は Perl sub を直接渡せません。Win32::API::Callback を使用してください。