Win32 API 日本語リファレンス
ホームStorage.FileSystem › ReadFileEx

ReadFileEx

関数
完了ルーチンを使い非同期でファイルを読み込む。
DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

BOOL ReadFileEx(
    HANDLE hFile,
    BYTE* lpBuffer,   // optional
    DWORD nNumberOfBytesToRead,
    OVERLAPPED* lpOverlapped,
    LPOVERLAPPED_COMPLETION_ROUTINE lpCompletionRoutine
);

パラメーター

名前方向説明
hFileHANDLEin

ファイルまたは I/O デバイス (たとえば、ファイル、ファイルストリーム、物理ディスク、ボリューム、コンソールバッファー、テープドライブ、ソケット、通信リソース、メールスロット、パイプなど) へのハンドル。

このパラメーターには、CreateFile 関数によって FILE_FLAG_OVERLAPPED フラグを指定して開いた任意のハンドル、または socket 関数や accept 関数が返したソケットハンドルを指定できます。

このハンドルには、GENERIC_READ アクセス権も必要です。アクセス権の詳細については、File Security and Access Rights を参照してください。

lpBufferBYTE*outoptional

ファイルまたはデバイスから読み取ったデータを受け取るバッファーへのポインター。

このバッファーは、読み取り操作の間、有効なまま維持されている必要があります。アプリケーションは、読み取り操作が完了するまでこのバッファーを使用しないでください。

nNumberOfBytesToReadDWORDin読み取るバイト数。
lpOverlappedOVERLAPPED*inout

非同期 (オーバーラップ) ファイル読み取り操作中に使用されるデータを提供する OVERLAPPED データ構造体へのポインター。

バイトオフセットをサポートするファイルでは、ファイルの読み取りを開始するバイトオフセットを指定する必要があります。このオフセットは、OVERLAPPED 構造体の Offset メンバーと OffsetHigh メンバーを設定することで指定します。バイトオフセットをサポートしないファイルやデバイスでは、OffsetOffsetHigh は無視されます。

ReadFileEx 関数は、OVERLAPPED 構造体の hEvent メンバーを無視します。アプリケーションは、ReadFileEx 呼び出しのコンテキストにおいて、このメンバーを独自の目的で自由に使用できます。ReadFileEx は、lpCompletionRoutine が指す完了ルーチンを呼び出す、またはその呼び出しをキューに入れることによって読み取り操作の完了を通知するため、イベントハンドルを必要としません。

ReadFileEx 関数は、OVERLAPPED 構造体の Internal メンバーと InternalHigh メンバーを使用します。アプリケーションはこれらのメンバーを設定しないでください。

OVERLAPPED データ構造体は、読み取り操作の間、有効なまま維持されている必要があります。読み取り操作が完了するまでの間にスコープ外になりうる変数であってはなりません。

lpCompletionRoutineLPOVERLAPPED_COMPLETION_ROUTINEin読み取り操作が完了し、かつ呼び出しスレッドがアラート可能な待機状態にあるときに呼び出される完了ルーチンへのポインター。完了ルーチンの詳細については、FileIOCompletionRoutine を参照してください。

戻り値の型: BOOL

公式ドキュメント

指定されたファイルまたは入出力 (I/O) デバイスからデータを読み取ります。完了状態は非同期に報告され、読み取りが完了またはキャンセルされ、かつ呼び出しスレッドがアラート可能な待機状態にあるときに、指定された完了ルーチンを呼び出します。

戻り値

関数が成功すると、戻り値は 0 以外になります。

関数が失敗すると、戻り値は 0 になります。拡張エラー情報を取得するには、GetLastError を呼び出してください。

関数が成功した場合、呼び出しスレッドには非同期 I/O 操作 (ファイルからのオーバーラップ読み取り操作) が保留状態になります。この I/O 操作が完了し、かつ呼び出しスレッドがアラート可能な待機状態でブロックされているとき、システムは lpCompletionRoutine が指す関数を呼び出し、待機状態は戻りコード WAIT_IO_COMPLETION で完了します。

関数が成功し、ファイル読み取り操作が完了したものの、呼び出しスレッドがアラート可能な待機状態にない場合、システムは完了ルーチンの呼び出しをキューに入れ、呼び出しスレッドがアラート可能な待機状態に入るまでその呼び出しを保留します。アラート可能な待機とオーバーラップ入出力操作の詳細については、About Synchronization を参照してください。

解説(Remarks)

ReadFileEx を使用する際は、関数が "成功" を返した場合でも GetLastError を確認し、"成功" ではあるものの把握しておきたい結果を伴う状態がないかをチェックする必要があります。たとえば、ReadFileEx の呼び出し時にバッファーオーバーフローが発生した場合は TRUE が返されますが、GetLastErrorERROR_MORE_DATA でオーバーフローを報告します。関数呼び出しが成功し、警告状態がない場合、GetLastErrorERROR_SUCCESS を返します。

ReadFileEx 関数は、未処理の非同期 I/O 要求が多すぎる場合に失敗することがあります。このような失敗が発生した場合、GetLastErrorERROR_INVALID_USER_BUFFER または ERROR_NOT_ENOUGH_MEMORY を返すことがあります。

保留中のすべての非同期 I/O 操作をキャンセルするには、次のいずれかを使用します。

保留中の同期 I/O 操作をキャンセルするには、CancelSynchronousIo を使用します。

キャンセルされた I/O 操作は、エラー ERROR_OPERATION_ABORTED で完了します。

hFile で指定されたファイルの一部が別のプロセスによってロックされており、ReadFileEx の呼び出しで指定された読み取り操作がロックされた部分と重なる場合、ReadFileEx の呼び出しは失敗します。

バッファーが小さすぎるメールスロットからデータを読み取ろうとすると、ReadFileExFALSE を返し、GetLastErrorERROR_INSUFFICIENT_BUFFER を返します。

読み取り操作がバッファーを使用している間にその入力バッファーにアクセスすると、そのバッファーに読み取られたデータが破損する可能性があります。アプリケーションは、読み取り操作が完了するまで、その読み取り操作が使用している入力バッファーの読み取り、書き込み、再割り当て、解放を行ってはなりません。

ファイルに対する読み取り操作がファイルの終端またはそれ以降の位置で開始される場合、その読み取り操作はエラー ERROR_HANDLE_EOF で失敗します。ファイルに対する読み取り操作がファイルの終端より前で開始されるものの、読み取り操作がファイルの終端を超えて及ぶ場合、読み取り操作は成功し、読み取られたバイト数はファイルの終端に達する前に読み取られたバイト数になります。

アプリケーションは、MsgWaitForMultipleObjectsExWaitForSingleObjectExWaitForMultipleObjectsExSleepEx の各関数を使用してアラート可能な待機状態に入ります。アラート可能な待機とオーバーラップ入出力の詳細については、About Synchronization を参照してください。

CreateFileFILE_FLAG_NO_BUFFERING を使用して開いたファイルを正しく扱うには、厳格な要件があります。詳細については、File Buffering を参照してください。

Windows 8 および Windows Server 2012 では、この関数は次のテクノロジによってサポートされています。

テクノロジ サポート
Server Message Block (SMB) 3.0 プロトコル はい
SMB 3.0 Transparent Failover (TFO) はい
SMB 3.0 with Scale-out File Shares (SO) はい
Cluster Shared Volume File System (CsvFS) はい
Resilient File System (ReFS) はい

トランザクション操作

ファイルハンドルにトランザクションがバインドされている場合、この関数はファイルのトランザクションビューからデータを返します。トランザクション読み取りハンドルは、ハンドルが有効な間、ファイルの同一のビューを表示することが保証されます。追加情報については、About Transactional NTFS を参照してください。

例については、Named Pipe Server Using Completion Routines を参照してください。

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

各言語での呼び出し定義

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

BOOL ReadFileEx(
    HANDLE hFile,
    BYTE* lpBuffer,   // optional
    DWORD nNumberOfBytesToRead,
    OVERLAPPED* lpOverlapped,
    LPOVERLAPPED_COMPLETION_ROUTINE lpCompletionRoutine
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool ReadFileEx(
    IntPtr hFile,   // HANDLE
    IntPtr lpBuffer,   // BYTE* optional, out
    uint nNumberOfBytesToRead,   // DWORD
    IntPtr lpOverlapped,   // OVERLAPPED* in/out
    IntPtr lpCompletionRoutine   // LPOVERLAPPED_COMPLETION_ROUTINE
);
<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function ReadFileEx(
    hFile As IntPtr,   ' HANDLE
    lpBuffer As IntPtr,   ' BYTE* optional, out
    nNumberOfBytesToRead As UInteger,   ' DWORD
    lpOverlapped As IntPtr,   ' OVERLAPPED* in/out
    lpCompletionRoutine As IntPtr   ' LPOVERLAPPED_COMPLETION_ROUTINE
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' hFile : HANDLE
' lpBuffer : BYTE* optional, out
' nNumberOfBytesToRead : DWORD
' lpOverlapped : OVERLAPPED* in/out
' lpCompletionRoutine : LPOVERLAPPED_COMPLETION_ROUTINE
Declare PtrSafe Function ReadFileEx Lib "kernel32" ( _
    ByVal hFile As LongPtr, _
    ByVal lpBuffer As LongPtr, _
    ByVal nNumberOfBytesToRead As Long, _
    ByVal lpOverlapped As LongPtr, _
    ByVal lpCompletionRoutine As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

ReadFileEx = ctypes.windll.kernel32.ReadFileEx
ReadFileEx.restype = wintypes.BOOL
ReadFileEx.argtypes = [
    wintypes.HANDLE,  # hFile : HANDLE
    ctypes.POINTER(ctypes.c_ubyte),  # lpBuffer : BYTE* optional, out
    wintypes.DWORD,  # nNumberOfBytesToRead : DWORD
    ctypes.c_void_p,  # lpOverlapped : OVERLAPPED* in/out
    ctypes.c_void_p,  # lpCompletionRoutine : LPOVERLAPPED_COMPLETION_ROUTINE
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
ReadFileEx = Fiddle::Function.new(
  lib['ReadFileEx'],
  [
    Fiddle::TYPE_VOIDP,  # hFile : HANDLE
    Fiddle::TYPE_VOIDP,  # lpBuffer : BYTE* optional, out
    -Fiddle::TYPE_INT,  # nNumberOfBytesToRead : DWORD
    Fiddle::TYPE_VOIDP,  # lpOverlapped : OVERLAPPED* in/out
    Fiddle::TYPE_VOIDP,  # lpCompletionRoutine : LPOVERLAPPED_COMPLETION_ROUTINE
  ],
  Fiddle::TYPE_INT)
#[link(name = "kernel32")]
extern "system" {
    fn ReadFileEx(
        hFile: *mut core::ffi::c_void,  // HANDLE
        lpBuffer: *mut u8,  // BYTE* optional, out
        nNumberOfBytesToRead: u32,  // DWORD
        lpOverlapped: *mut OVERLAPPED,  // OVERLAPPED* in/out
        lpCompletionRoutine: *const core::ffi::c_void  // LPOVERLAPPED_COMPLETION_ROUTINE
    ) -> 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 ReadFileEx(IntPtr hFile, IntPtr lpBuffer, uint nNumberOfBytesToRead, IntPtr lpOverlapped, IntPtr lpCompletionRoutine);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_ReadFileEx' -Namespace Win32 -PassThru
# $api::ReadFileEx(hFile, lpBuffer, nNumberOfBytesToRead, lpOverlapped, lpCompletionRoutine)
#uselib "KERNEL32.dll"
#func global ReadFileEx "ReadFileEx" sptr, sptr, sptr, sptr, sptr
; ReadFileEx hFile, varptr(lpBuffer), nNumberOfBytesToRead, varptr(lpOverlapped), lpCompletionRoutine   ; 戻り値は stat
; hFile : HANDLE -> "sptr"
; lpBuffer : BYTE* optional, out -> "sptr"
; nNumberOfBytesToRead : DWORD -> "sptr"
; lpOverlapped : OVERLAPPED* in/out -> "sptr"
; lpCompletionRoutine : LPOVERLAPPED_COMPLETION_ROUTINE -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "KERNEL32.dll"
#cfunc global ReadFileEx "ReadFileEx" sptr, var, int, var, sptr
; res = ReadFileEx(hFile, lpBuffer, nNumberOfBytesToRead, lpOverlapped, lpCompletionRoutine)
; hFile : HANDLE -> "sptr"
; lpBuffer : BYTE* optional, out -> "var"
; nNumberOfBytesToRead : DWORD -> "int"
; lpOverlapped : OVERLAPPED* in/out -> "var"
; lpCompletionRoutine : LPOVERLAPPED_COMPLETION_ROUTINE -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL ReadFileEx(HANDLE hFile, BYTE* lpBuffer, DWORD nNumberOfBytesToRead, OVERLAPPED* lpOverlapped, LPOVERLAPPED_COMPLETION_ROUTINE lpCompletionRoutine)
#uselib "KERNEL32.dll"
#cfunc global ReadFileEx "ReadFileEx" intptr, var, int, var, intptr
; res = ReadFileEx(hFile, lpBuffer, nNumberOfBytesToRead, lpOverlapped, lpCompletionRoutine)
; hFile : HANDLE -> "intptr"
; lpBuffer : BYTE* optional, out -> "var"
; nNumberOfBytesToRead : DWORD -> "int"
; lpOverlapped : OVERLAPPED* in/out -> "var"
; lpCompletionRoutine : LPOVERLAPPED_COMPLETION_ROUTINE -> "intptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procReadFileEx = kernel32.NewProc("ReadFileEx")
)

// hFile (HANDLE), lpBuffer (BYTE* optional, out), nNumberOfBytesToRead (DWORD), lpOverlapped (OVERLAPPED* in/out), lpCompletionRoutine (LPOVERLAPPED_COMPLETION_ROUTINE)
r1, _, err := procReadFileEx.Call(
	uintptr(hFile),
	uintptr(lpBuffer),
	uintptr(nNumberOfBytesToRead),
	uintptr(lpOverlapped),
	uintptr(lpCompletionRoutine),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function ReadFileEx(
  hFile: THandle;   // HANDLE
  lpBuffer: Pointer;   // BYTE* optional, out
  nNumberOfBytesToRead: DWORD;   // DWORD
  lpOverlapped: Pointer;   // OVERLAPPED* in/out
  lpCompletionRoutine: Pointer   // LPOVERLAPPED_COMPLETION_ROUTINE
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'ReadFileEx';
result := DllCall("KERNEL32\ReadFileEx"
    , "Ptr", hFile   ; HANDLE
    , "Ptr", lpBuffer   ; BYTE* optional, out
    , "UInt", nNumberOfBytesToRead   ; DWORD
    , "Ptr", lpOverlapped   ; OVERLAPPED* in/out
    , "Ptr", lpCompletionRoutine   ; LPOVERLAPPED_COMPLETION_ROUTINE
    , "Int")   ; return: BOOL
●ReadFileEx(hFile, lpBuffer, nNumberOfBytesToRead, lpOverlapped, lpCompletionRoutine) = DLL("KERNEL32.dll", "bool ReadFileEx(void*, void*, dword, void*, void*)")
# 呼び出し: ReadFileEx(hFile, lpBuffer, nNumberOfBytesToRead, lpOverlapped, lpCompletionRoutine)
# hFile : HANDLE -> "void*"
# lpBuffer : BYTE* optional, out -> "void*"
# nNumberOfBytesToRead : DWORD -> "dword"
# lpOverlapped : OVERLAPPED* in/out -> "void*"
# lpCompletionRoutine : LPOVERLAPPED_COMPLETION_ROUTINE -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "kernel32" fn ReadFileEx(
    hFile: ?*anyopaque, // HANDLE
    lpBuffer: [*c]u8, // BYTE* optional, out
    nNumberOfBytesToRead: u32, // DWORD
    lpOverlapped: [*c]OVERLAPPED, // OVERLAPPED* in/out
    lpCompletionRoutine: ?*anyopaque // LPOVERLAPPED_COMPLETION_ROUTINE
) callconv(std.os.windows.WINAPI) i32;
proc ReadFileEx(
    hFile: pointer,  # HANDLE
    lpBuffer: ptr uint8,  # BYTE* optional, out
    nNumberOfBytesToRead: uint32,  # DWORD
    lpOverlapped: ptr OVERLAPPED,  # OVERLAPPED* in/out
    lpCompletionRoutine: pointer  # LPOVERLAPPED_COMPLETION_ROUTINE
): int32 {.importc: "ReadFileEx", stdcall, dynlib: "KERNEL32.dll".}
pragma(lib, "kernel32");
extern(Windows)
int ReadFileEx(
    void* hFile,   // HANDLE
    ubyte* lpBuffer,   // BYTE* optional, out
    uint nNumberOfBytesToRead,   // DWORD
    OVERLAPPED* lpOverlapped,   // OVERLAPPED* in/out
    void* lpCompletionRoutine   // LPOVERLAPPED_COMPLETION_ROUTINE
);
ccall((:ReadFileEx, "KERNEL32.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Ptr{UInt8}, UInt32, Ptr{OVERLAPPED}, Ptr{Cvoid}),
      hFile, lpBuffer, nNumberOfBytesToRead, lpOverlapped, lpCompletionRoutine)
# hFile : HANDLE -> Ptr{Cvoid}
# lpBuffer : BYTE* optional, out -> Ptr{UInt8}
# nNumberOfBytesToRead : DWORD -> UInt32
# lpOverlapped : OVERLAPPED* in/out -> Ptr{OVERLAPPED}
# lpCompletionRoutine : LPOVERLAPPED_COMPLETION_ROUTINE -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t ReadFileEx(
    void* hFile,
    uint8_t* lpBuffer,
    uint32_t nNumberOfBytesToRead,
    void* lpOverlapped,
    void* lpCompletionRoutine);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.ReadFileEx(hFile, lpBuffer, nNumberOfBytesToRead, lpOverlapped, lpCompletionRoutine)
-- hFile : HANDLE
-- lpBuffer : BYTE* optional, out
-- nNumberOfBytesToRead : DWORD
-- lpOverlapped : OVERLAPPED* in/out
-- lpCompletionRoutine : LPOVERLAPPED_COMPLETION_ROUTINE
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const ReadFileEx = lib.func('__stdcall', 'ReadFileEx', 'int32_t', ['void *', 'uint8_t *', 'uint32_t', 'void *', 'void *']);
// ReadFileEx(hFile, lpBuffer, nNumberOfBytesToRead, lpOverlapped, lpCompletionRoutine)
// hFile : HANDLE -> 'void *'
// lpBuffer : BYTE* optional, out -> 'uint8_t *'
// nNumberOfBytesToRead : DWORD -> 'uint32_t'
// lpOverlapped : OVERLAPPED* in/out -> 'void *'
// lpCompletionRoutine : LPOVERLAPPED_COMPLETION_ROUTINE -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
// コールバック(関数ポインタ)は koffi.proto/koffi.register で型を定義して渡す(素の void* では JS 関数を渡せない)。
const lib = Deno.dlopen("KERNEL32.dll", {
  ReadFileEx: { parameters: ["pointer", "pointer", "u32", "pointer", "pointer"], result: "i32" },
});
// lib.symbols.ReadFileEx(hFile, lpBuffer, nNumberOfBytesToRead, lpOverlapped, lpCompletionRoutine)
// hFile : HANDLE -> "pointer"
// lpBuffer : BYTE* optional, out -> "pointer"
// nNumberOfBytesToRead : DWORD -> "u32"
// lpOverlapped : OVERLAPPED* in/out -> "pointer"
// lpCompletionRoutine : LPOVERLAPPED_COMPLETION_ROUTINE -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t ReadFileEx(
    void* hFile,
    uint8_t* lpBuffer,
    uint32_t nNumberOfBytesToRead,
    void* lpOverlapped,
    void* lpCompletionRoutine);
C, "KERNEL32.dll");
// $ffi->ReadFileEx(hFile, lpBuffer, nNumberOfBytesToRead, lpOverlapped, lpCompletionRoutine);
// hFile : HANDLE
// lpBuffer : BYTE* optional, out
// nNumberOfBytesToRead : DWORD
// lpOverlapped : OVERLAPPED* in/out
// lpCompletionRoutine : LPOVERLAPPED_COMPLETION_ROUTINE
// 構造体/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 ReadFileEx(
        Pointer hFile,   // HANDLE
        byte[] lpBuffer,   // BYTE* optional, out
        int nNumberOfBytesToRead,   // DWORD
        Pointer lpOverlapped,   // OVERLAPPED* in/out
        Callback lpCompletionRoutine   // LPOVERLAPPED_COMPLETION_ROUTINE
    );
}
@[Link("kernel32")]
lib LibKERNEL32
  fun ReadFileEx = ReadFileEx(
    hFile : Void*,   # HANDLE
    lpBuffer : UInt8*,   # BYTE* optional, out
    nNumberOfBytesToRead : UInt32,   # DWORD
    lpOverlapped : OVERLAPPED*,   # OVERLAPPED* in/out
    lpCompletionRoutine : Void*   # LPOVERLAPPED_COMPLETION_ROUTINE
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef ReadFileExNative = Int32 Function(Pointer<Void>, Pointer<Uint8>, Uint32, Pointer<Void>, Pointer<Void>);
typedef ReadFileExDart = int Function(Pointer<Void>, Pointer<Uint8>, int, Pointer<Void>, Pointer<Void>);
final ReadFileEx = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<ReadFileExNative, ReadFileExDart>('ReadFileEx');
// hFile : HANDLE -> Pointer<Void>
// lpBuffer : BYTE* optional, out -> Pointer<Uint8>
// nNumberOfBytesToRead : DWORD -> Uint32
// lpOverlapped : OVERLAPPED* in/out -> Pointer<Void>
// lpCompletionRoutine : LPOVERLAPPED_COMPLETION_ROUTINE -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function ReadFileEx(
  hFile: THandle;   // HANDLE
  lpBuffer: Pointer;   // BYTE* optional, out
  nNumberOfBytesToRead: DWORD;   // DWORD
  lpOverlapped: Pointer;   // OVERLAPPED* in/out
  lpCompletionRoutine: Pointer   // LPOVERLAPPED_COMPLETION_ROUTINE
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'ReadFileEx';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "ReadFileEx"
  c_ReadFileEx :: Ptr () -> Ptr Word8 -> Word32 -> Ptr () -> Ptr () -> IO CInt
-- hFile : HANDLE -> Ptr ()
-- lpBuffer : BYTE* optional, out -> Ptr Word8
-- nNumberOfBytesToRead : DWORD -> Word32
-- lpOverlapped : OVERLAPPED* in/out -> Ptr ()
-- lpCompletionRoutine : LPOVERLAPPED_COMPLETION_ROUTINE -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let readfileex =
  foreign "ReadFileEx"
    ((ptr void) @-> (ptr uint8_t) @-> uint32_t @-> (ptr void) @-> (ptr void) @-> returning int32_t)
(* hFile : HANDLE -> (ptr void) *)
(* lpBuffer : BYTE* optional, out -> (ptr uint8_t) *)
(* nNumberOfBytesToRead : DWORD -> uint32_t *)
(* lpOverlapped : OVERLAPPED* in/out -> (ptr void) *)
(* lpCompletionRoutine : LPOVERLAPPED_COMPLETION_ROUTINE -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("ReadFileEx" read-file-ex :convention :stdcall) :int32
  (h-file :pointer)   ; HANDLE
  (lp-buffer :pointer)   ; BYTE* optional, out
  (n-number-of-bytes-to-read :uint32)   ; DWORD
  (lp-overlapped :pointer)   ; OVERLAPPED* in/out
  (lp-completion-routine :pointer))   ; LPOVERLAPPED_COMPLETION_ROUTINE
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $ReadFileEx = Win32::API::More->new('KERNEL32',
    'BOOL ReadFileEx(HANDLE hFile, LPVOID lpBuffer, DWORD nNumberOfBytesToRead, LPVOID lpOverlapped, LPVOID lpCompletionRoutine)');
# my $ret = $ReadFileEx->Call($hFile, $lpBuffer, $nNumberOfBytesToRead, $lpOverlapped, $lpCompletionRoutine);
# hFile : HANDLE -> HANDLE
# lpBuffer : BYTE* optional, out -> LPVOID
# nNumberOfBytesToRead : DWORD -> DWORD
# lpOverlapped : OVERLAPPED* in/out -> LPVOID
# lpCompletionRoutine : LPOVERLAPPED_COMPLETION_ROUTINE -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# コールバック(関数ポインタ)は Perl sub を直接渡せません。Win32::API::Callback を使用してください。

関連項目

類似 API
公式の関連項目
使用する型