ReadFile
関数シグネチャ
// KERNEL32.dll
#include <windows.h>
BOOL ReadFile(
HANDLE hFile,
BYTE* lpBuffer, // optional
DWORD nNumberOfBytesToRead,
DWORD* lpNumberOfBytesRead, // optional
OVERLAPPED* lpOverlapped // optional
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| hFile | HANDLE | in | デバイス (たとえば、ファイル、ファイルストリーム、物理ディスク、ボリューム、コンソールバッファー、テープドライブ、ソケット、通信リソース、メールスロット、またはパイプ) へのハンドルです。 hFile パラメーターは、読み取りアクセス権を指定して作成されている必要があります。詳細については、Generic Access Rights および File Security and Access Rights を参照してください。 非同期の読み取り操作の場合、hFile には、CreateFile 関数で FILE_FLAG_OVERLAPPED フラグを指定して開いた任意のハンドル、または socket もしくは accept 関数から返されたソケットハンドルを指定できます。 |
| lpBuffer | BYTE* | outoptional | ファイルまたはデバイスから読み取られたデータを受け取るバッファーへのポインターです。 このバッファーは、読み取り操作の間、有効なまま保持されている必要があります。呼び出し元は、読み取り操作が完了するまでこのバッファーを使用してはなりません。 |
| nNumberOfBytesToRead | DWORD | in | 読み取るバイト数の最大値です。 |
| lpNumberOfBytesRead | DWORD* | outoptional | 同期的な hFile パラメーターを使用する場合に、読み取られたバイト数を受け取る変数へのポインターです。ReadFile は、処理やエラーチェックを行う前にこの値をゼロに設定します。これが非同期操作である場合は、誤った結果が生じる可能性を避けるため、このパラメーターに NULL を使用してください。 このパラメーターを NULL にできるのは、lpOverlapped パラメーターが NULL でない場合のみです。 Windows 7: このパラメーターを NULL にすることはできません。 詳細については、「解説」セクションを参照してください。 |
| lpOverlapped | OVERLAPPED* | inoutoptional | hFile パラメーターが FILE_FLAG_OVERLAPPED を指定して開かれた場合は、OVERLAPPED 構造体へのポインターが必要です。それ以外の場合は NULL にできます。 hFile が FILE_FLAG_OVERLAPPED を指定して開かれている場合、lpOverlapped パラメーターは有効で一意の OVERLAPPED 構造体を指している必要があります。そうでないと、関数が読み取り操作の完了を誤って報告することがあります。 バイトオフセットをサポートする hFile の場合、このパラメーターを使用するときは、ファイルまたはデバイスからの読み取りを開始するバイトオフセットを指定する必要があります。このオフセットは、OVERLAPPED 構造体の Offset メンバーと OffsetHigh メンバーを設定することで指定します。バイトオフセットをサポートしない hFile の場合、Offset と OffsetHigh は無視されます。 lpOverlapped と FILE_FLAG_OVERLAPPED のさまざまな組み合わせの詳細については、「解説」セクションおよび「同期とファイル位置」セクションを参照してください。 |
戻り値の型: BOOL
公式ドキュメント
指定されたファイルまたは入出力 (I/O) デバイスからデータを読み取ります。デバイスがサポートしている場合、読み取りはファイルポインターで指定された位置で行われます。
戻り値
関数が成功した場合、戻り値は非ゼロ (TRUE) です。
関数が失敗した場合、または非同期で完了する場合、戻り値はゼロ (FALSE) です。拡張エラー情報を取得するには、GetLastError 関数を呼び出します。
GetLastError コード ERROR_IO_PENDING は失敗ではありません。これは読み取り操作が非同期で完了待ちであることを示します。詳細については、「解説」を参照してください。
解説(Remarks)
ReadFile 関数は、次のいずれかの条件が発生したときに戻ります。
- 要求されたバイト数が読み取られた。
- パイプの書き込み側で書き込み操作が完了した。
- 非同期ハンドルが使用されており、読み取りが非同期で行われている。
- エラーが発生した。
ReadFile 関数は、未完了の非同期 I/O 要求が多すぎる場合に、ERROR_INVALID_USER_BUFFER または ERROR_NOT_ENOUGH_MEMORY で失敗することがあります。
保留中のすべての非同期 I/O 操作をキャンセルするには、次のいずれかを使用します。
- CancelIo: この関数は、指定されたファイルハンドルに対して呼び出し元スレッドが発行した操作のみをキャンセルします。
- CancelIoEx: この関数は、指定されたファイルハンドルに対してスレッドが発行したすべての操作をキャンセルします。
保留中の同期 I/O 操作をキャンセルするには、CancelSynchronousIo を使用します。
キャンセルされた I/O 操作は、エラー ERROR_OPERATION_ABORTED で完了します。
ReadFile 関数は ERROR_NOT_ENOUGH_QUOTA で失敗することがあります。これは、呼び出し元プロセスのバッファーをページロックできなかったことを意味します。詳細については、SetProcessWorkingSetSize を参照してください。
ファイルの一部が別のプロセスによってロックされており、読み取り操作がロックされた部分と重なる場合、この関数は失敗します。
読み取り操作がバッファーを使用している間に入力バッファーにアクセスすると、そのバッファーに読み込まれるデータが破損する可能性があります。アプリケーションは、読み取り操作が完了するまで、その読み取り操作が使用している入力バッファーに対して読み取り、書き込み、再割り当て、または解放を行ってはなりません。これは特に非同期ファイルハンドルを使用する場合に問題となることがあります。同期ファイルハンドルと非同期ファイルハンドルに関する追加情報は、同期とファイル位置 セクションおよび CreateFile のリファレンストピックに記載されています。
コンソール入力へのハンドルを使用して ReadFile を呼び出すことで、コンソール入力バッファーから文字を読み取ることができます。コンソールモードによって、ReadFile 関数の正確な動作が決まります。既定では、コンソールモードは ENABLE_LINE_INPUT であり、これは ReadFile がキャリッジリターンに達するまで読み取ることを示します。Ctrl+C を押すと呼び出しは成功しますが、GetLastError は ERROR_OPERATION_ABORTED を返します。詳細については、CreateFile を参照してください。
通信デバイスから読み取る場合、ReadFile の動作は、SetCommTimeouts および GetCommTimeouts 関数を使用して設定・取得される現在の通信タイムアウトによって決まります。タイムアウト値を設定しないと、予期しない結果が生じることがあります。通信タイムアウトの詳細については、COMMTIMEOUTS を参照してください。
ReadFile が、小さすぎるバッファーを持つメールスロットからの読み取りを試みると、関数は FALSE を返し、GetLastError は ERROR_INSUFFICIENT_BUFFER を返します。
FILE_FLAG_NO_BUFFERING フラグを指定して CreateFile で開いたファイルを正しく扱うには、厳密な要件があります。詳細については、File Buffering を参照してください。
hFile が FILE_FLAG_OVERLAPPED を指定して開かれている場合、次の条件が適用されます。
- lpOverlapped パラメーターは、有効で一意の OVERLAPPED 構造体を指している必要があります。そうでないと、関数が読み取り操作の完了を誤って報告することがあります。
- lpNumberOfBytesRead パラメーターは NULL に設定する必要があります。実際に読み取られたバイト数を取得するには、GetOverlappedResult 関数を使用します。hFile パラメーターが I/O 完了ポートに関連付けられている場合は、GetQueuedCompletionStatus 関数を呼び出して読み取られたバイト数を取得することもできます。
ファイルに対する読み取り操作がファイルの終端以降で開始される場合、読み取り操作はエラー ERROR_HANDLE_EOF で失敗します。読み取り操作がファイルの終端より前で開始されるものの、ファイルの終端を超えて伸びる場合、読み取り操作は成功し、読み取られるバイト数はファイルの終端に達する前に読み取られたバイト数になります。
同期とファイル位置
hFile が FILE_FLAG_OVERLAPPED を指定して開かれている場合、それは非同期ファイルハンドルです。そうでない場合は同期ファイルハンドルです。OVERLAPPED 構造体の使用規則は、前述のとおり、それぞれで多少異なります。
ファイルまたはデバイスが非同期 I/O 用に開かれている場合、そのハンドルを使用する ReadFile などの関数の後続の呼び出しは一般に即座に戻りますが、ブロックされた実行に関して同期的に振る舞うこともあります。詳細については、Asynchronous disk I/O appears as synchronous on Windows を参照してください。
非同期ファイルハンドルを扱う際の考慮事項:
- ReadFile は、読み取り操作が完了する前に戻ることがあります。このシナリオでは、ReadFile は FALSE を返し、GetLastError 関数は ERROR_IO_PENDING を返します。これにより、システムが読み取り操作を完了する間、呼び出し元プロセスは処理を続行できます。
- lpOverlapped パラメーターは NULL であってはならず、次の事実を念頭に置いて使用する必要があります。
- OVERLAPPED 構造体で指定されたイベントはシステムによって自動的に設定・リセットされますが、OVERLAPPED 構造体で指定されたオフセットは自動的には更新されません。
- ReadFile は、I/O 操作を開始するときにイベントを非シグナル状態にリセットします。
- OVERLAPPED 構造体で指定されたイベントは、読み取り操作が完了するとシグナル状態に設定されます。それまで、読み取り操作は保留中とみなされます。
- 読み取り操作は OVERLAPPED 構造体で指定されたオフセットから開始され、ReadFile はシステムレベルの読み取り操作が完了する前 (読み取り保留中) に戻ることがあるため、イベントがシグナル状態になる (つまり読み取りが完了する) まで、オフセットや構造体のその他の部分をアプリケーションが変更、解放、または再利用してはなりません。
同期ファイルハンドルを扱う際の考慮事項:
- lpOverlapped が NULL の場合、読み取り操作は現在のファイル位置から開始され、ReadFile は操作が完了するまで戻りません。システムは ReadFile が戻る前にファイルポインターを更新します。
- lpOverlapped が NULL でない場合、読み取り操作は OVERLAPPED 構造体で指定されたオフセットから開始され、ReadFile は読み取り操作が完了するまで戻りません。システムは ReadFile が戻る前に OVERLAPPED オフセットとファイルポインターを更新します。
詳細については、CreateFile および Synchronous and Asynchronous I/O を参照してください。
パイプ
匿名パイプが使用されており、書き込みハンドルが閉じられている場合、ReadFile がパイプの対応する読み取りハンドルを使用して読み取りを試みると、関数は FALSE を返し、GetLastError は ERROR_BROKEN_PIPE を返します。
名前付きパイプがメッセージモードで読み取られており、次のメッセージが nNumberOfBytesToRead パラメーターで指定された値より長い場合、ReadFile は FALSE を返し、GetLastError は ERROR_MORE_DATA を返します。メッセージの残りの部分は、ReadFile または PeekNamedPipe 関数を後続で呼び出すことで読み取ることができます。
パイプに対して ReadFile が TRUE を返したときに lpNumberOfBytesRead パラメーターがゼロである場合、パイプのもう一方の端が nNumberOfBytesToWrite をゼロに設定して WriteFile 関数を呼び出したことを意味します。
パイプの詳細については、Pipes を参照してください。
トランザクション操作
ファイルハンドルにトランザクションがバインドされている場合、関数はファイルのトランザクションビューからデータを返します。トランザクション読み取りハンドルは、そのハンドルの存続期間中、同じファイルのビューを示すことが保証されます。詳細については、About Transactional NTFS を参照してください。
Windows 8 および Windows Server 2012 では、この関数は次のテクノロジによってサポートされます。
| テクノロジ | サポート |
|---|---|
| Server Message Block (SMB) 3.0 プロトコル | あり |
| SMB 3.0 トランスペアレントフェールオーバー (TFO) | あり |
| SMB 3.0 スケールアウトファイル共有 (SO) | あり |
| クラスター共有ボリュームファイルシステム (CsvFS) | あり |
| 回復性のあるファイルシステム (ReFS) | あり |
例
ファイルの終端をテストする方法を示すコード例については、Testing for the End of a File を参照してください。その他の例については、Creating and Using a Temporary File および Opening a File for Reading or Writing を参照してください。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// KERNEL32.dll
#include <windows.h>
BOOL ReadFile(
HANDLE hFile,
BYTE* lpBuffer, // optional
DWORD nNumberOfBytesToRead,
DWORD* lpNumberOfBytesRead, // optional
OVERLAPPED* lpOverlapped // optional
);[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool ReadFile(
IntPtr hFile, // HANDLE
IntPtr lpBuffer, // BYTE* optional, out
uint nNumberOfBytesToRead, // DWORD
IntPtr lpNumberOfBytesRead, // DWORD* optional, out
IntPtr lpOverlapped // OVERLAPPED* optional, in/out
);<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function ReadFile(
hFile As IntPtr, ' HANDLE
lpBuffer As IntPtr, ' BYTE* optional, out
nNumberOfBytesToRead As UInteger, ' DWORD
lpNumberOfBytesRead As IntPtr, ' DWORD* optional, out
lpOverlapped As IntPtr ' OVERLAPPED* optional, in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function' hFile : HANDLE
' lpBuffer : BYTE* optional, out
' nNumberOfBytesToRead : DWORD
' lpNumberOfBytesRead : DWORD* optional, out
' lpOverlapped : OVERLAPPED* optional, in/out
Declare PtrSafe Function ReadFile Lib "kernel32" ( _
ByVal hFile As LongPtr, _
ByVal lpBuffer As LongPtr, _
ByVal nNumberOfBytesToRead As Long, _
ByVal lpNumberOfBytesRead As LongPtr, _
ByVal lpOverlapped As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
ReadFile = ctypes.windll.kernel32.ReadFile
ReadFile.restype = wintypes.BOOL
ReadFile.argtypes = [
wintypes.HANDLE, # hFile : HANDLE
ctypes.POINTER(ctypes.c_ubyte), # lpBuffer : BYTE* optional, out
wintypes.DWORD, # nNumberOfBytesToRead : DWORD
ctypes.POINTER(wintypes.DWORD), # lpNumberOfBytesRead : DWORD* optional, out
ctypes.c_void_p, # lpOverlapped : OVERLAPPED* optional, in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('KERNEL32.dll')
ReadFile = Fiddle::Function.new(
lib['ReadFile'],
[
Fiddle::TYPE_VOIDP, # hFile : HANDLE
Fiddle::TYPE_VOIDP, # lpBuffer : BYTE* optional, out
-Fiddle::TYPE_INT, # nNumberOfBytesToRead : DWORD
Fiddle::TYPE_VOIDP, # lpNumberOfBytesRead : DWORD* optional, out
Fiddle::TYPE_VOIDP, # lpOverlapped : OVERLAPPED* optional, in/out
],
Fiddle::TYPE_INT)#[link(name = "kernel32")]
extern "system" {
fn ReadFile(
hFile: *mut core::ffi::c_void, // HANDLE
lpBuffer: *mut u8, // BYTE* optional, out
nNumberOfBytesToRead: u32, // DWORD
lpNumberOfBytesRead: *mut u32, // DWORD* optional, out
lpOverlapped: *mut OVERLAPPED // OVERLAPPED* optional, in/out
) -> 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 ReadFile(IntPtr hFile, IntPtr lpBuffer, uint nNumberOfBytesToRead, IntPtr lpNumberOfBytesRead, IntPtr lpOverlapped);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_ReadFile' -Namespace Win32 -PassThru
# $api::ReadFile(hFile, lpBuffer, nNumberOfBytesToRead, lpNumberOfBytesRead, lpOverlapped)#uselib "KERNEL32.dll"
#func global ReadFile "ReadFile" sptr, sptr, sptr, sptr, sptr
; ReadFile hFile, varptr(lpBuffer), nNumberOfBytesToRead, varptr(lpNumberOfBytesRead), varptr(lpOverlapped) ; 戻り値は stat
; hFile : HANDLE -> "sptr"
; lpBuffer : BYTE* optional, out -> "sptr"
; nNumberOfBytesToRead : DWORD -> "sptr"
; lpNumberOfBytesRead : DWORD* optional, out -> "sptr"
; lpOverlapped : OVERLAPPED* optional, in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "KERNEL32.dll" #cfunc global ReadFile "ReadFile" sptr, var, int, var, var ; res = ReadFile(hFile, lpBuffer, nNumberOfBytesToRead, lpNumberOfBytesRead, lpOverlapped) ; hFile : HANDLE -> "sptr" ; lpBuffer : BYTE* optional, out -> "var" ; nNumberOfBytesToRead : DWORD -> "int" ; lpNumberOfBytesRead : DWORD* optional, out -> "var" ; lpOverlapped : OVERLAPPED* optional, in/out -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "KERNEL32.dll" #cfunc global ReadFile "ReadFile" sptr, sptr, int, sptr, sptr ; res = ReadFile(hFile, varptr(lpBuffer), nNumberOfBytesToRead, varptr(lpNumberOfBytesRead), varptr(lpOverlapped)) ; hFile : HANDLE -> "sptr" ; lpBuffer : BYTE* optional, out -> "sptr" ; nNumberOfBytesToRead : DWORD -> "int" ; lpNumberOfBytesRead : DWORD* optional, out -> "sptr" ; lpOverlapped : OVERLAPPED* optional, in/out -> "sptr" ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; BOOL ReadFile(HANDLE hFile, BYTE* lpBuffer, DWORD nNumberOfBytesToRead, DWORD* lpNumberOfBytesRead, OVERLAPPED* lpOverlapped) #uselib "KERNEL32.dll" #cfunc global ReadFile "ReadFile" intptr, var, int, var, var ; res = ReadFile(hFile, lpBuffer, nNumberOfBytesToRead, lpNumberOfBytesRead, lpOverlapped) ; hFile : HANDLE -> "intptr" ; lpBuffer : BYTE* optional, out -> "var" ; nNumberOfBytesToRead : DWORD -> "int" ; lpNumberOfBytesRead : DWORD* optional, out -> "var" ; lpOverlapped : OVERLAPPED* optional, in/out -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; BOOL ReadFile(HANDLE hFile, BYTE* lpBuffer, DWORD nNumberOfBytesToRead, DWORD* lpNumberOfBytesRead, OVERLAPPED* lpOverlapped) #uselib "KERNEL32.dll" #cfunc global ReadFile "ReadFile" intptr, intptr, int, intptr, intptr ; res = ReadFile(hFile, varptr(lpBuffer), nNumberOfBytesToRead, varptr(lpNumberOfBytesRead), varptr(lpOverlapped)) ; hFile : HANDLE -> "intptr" ; lpBuffer : BYTE* optional, out -> "intptr" ; nNumberOfBytesToRead : DWORD -> "int" ; lpNumberOfBytesRead : DWORD* optional, out -> "intptr" ; lpOverlapped : OVERLAPPED* optional, in/out -> "intptr" ; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。
import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
procReadFile = kernel32.NewProc("ReadFile")
)
// hFile (HANDLE), lpBuffer (BYTE* optional, out), nNumberOfBytesToRead (DWORD), lpNumberOfBytesRead (DWORD* optional, out), lpOverlapped (OVERLAPPED* optional, in/out)
r1, _, err := procReadFile.Call(
uintptr(hFile),
uintptr(lpBuffer),
uintptr(nNumberOfBytesToRead),
uintptr(lpNumberOfBytesRead),
uintptr(lpOverlapped),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // BOOLfunction ReadFile(
hFile: THandle; // HANDLE
lpBuffer: Pointer; // BYTE* optional, out
nNumberOfBytesToRead: DWORD; // DWORD
lpNumberOfBytesRead: Pointer; // DWORD* optional, out
lpOverlapped: Pointer // OVERLAPPED* optional, in/out
): BOOL; stdcall;
external 'KERNEL32.dll' name 'ReadFile';result := DllCall("KERNEL32\ReadFile"
, "Ptr", hFile ; HANDLE
, "Ptr", lpBuffer ; BYTE* optional, out
, "UInt", nNumberOfBytesToRead ; DWORD
, "Ptr", lpNumberOfBytesRead ; DWORD* optional, out
, "Ptr", lpOverlapped ; OVERLAPPED* optional, in/out
, "Int") ; return: BOOL●ReadFile(hFile, lpBuffer, nNumberOfBytesToRead, lpNumberOfBytesRead, lpOverlapped) = DLL("KERNEL32.dll", "bool ReadFile(void*, void*, dword, void*, void*)")
# 呼び出し: ReadFile(hFile, lpBuffer, nNumberOfBytesToRead, lpNumberOfBytesRead, lpOverlapped)
# hFile : HANDLE -> "void*"
# lpBuffer : BYTE* optional, out -> "void*"
# nNumberOfBytesToRead : DWORD -> "dword"
# lpNumberOfBytesRead : DWORD* optional, out -> "void*"
# lpOverlapped : OVERLAPPED* optional, in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "kernel32" fn ReadFile(
hFile: ?*anyopaque, // HANDLE
lpBuffer: [*c]u8, // BYTE* optional, out
nNumberOfBytesToRead: u32, // DWORD
lpNumberOfBytesRead: [*c]u32, // DWORD* optional, out
lpOverlapped: [*c]OVERLAPPED // OVERLAPPED* optional, in/out
) callconv(std.os.windows.WINAPI) i32;proc ReadFile(
hFile: pointer, # HANDLE
lpBuffer: ptr uint8, # BYTE* optional, out
nNumberOfBytesToRead: uint32, # DWORD
lpNumberOfBytesRead: ptr uint32, # DWORD* optional, out
lpOverlapped: ptr OVERLAPPED # OVERLAPPED* optional, in/out
): int32 {.importc: "ReadFile", stdcall, dynlib: "KERNEL32.dll".}pragma(lib, "kernel32");
extern(Windows)
int ReadFile(
void* hFile, // HANDLE
ubyte* lpBuffer, // BYTE* optional, out
uint nNumberOfBytesToRead, // DWORD
uint* lpNumberOfBytesRead, // DWORD* optional, out
OVERLAPPED* lpOverlapped // OVERLAPPED* optional, in/out
);ccall((:ReadFile, "KERNEL32.dll"), stdcall, Int32,
(Ptr{Cvoid}, Ptr{UInt8}, UInt32, Ptr{UInt32}, Ptr{OVERLAPPED}),
hFile, lpBuffer, nNumberOfBytesToRead, lpNumberOfBytesRead, lpOverlapped)
# hFile : HANDLE -> Ptr{Cvoid}
# lpBuffer : BYTE* optional, out -> Ptr{UInt8}
# nNumberOfBytesToRead : DWORD -> UInt32
# lpNumberOfBytesRead : DWORD* optional, out -> Ptr{UInt32}
# lpOverlapped : OVERLAPPED* optional, in/out -> Ptr{OVERLAPPED}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t ReadFile(
void* hFile,
uint8_t* lpBuffer,
uint32_t nNumberOfBytesToRead,
uint32_t* lpNumberOfBytesRead,
void* lpOverlapped);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.ReadFile(hFile, lpBuffer, nNumberOfBytesToRead, lpNumberOfBytesRead, lpOverlapped)
-- hFile : HANDLE
-- lpBuffer : BYTE* optional, out
-- nNumberOfBytesToRead : DWORD
-- lpNumberOfBytesRead : DWORD* optional, out
-- lpOverlapped : OVERLAPPED* optional, in/out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const ReadFile = lib.func('__stdcall', 'ReadFile', 'int32_t', ['void *', 'uint8_t *', 'uint32_t', 'uint32_t *', 'void *']);
// ReadFile(hFile, lpBuffer, nNumberOfBytesToRead, lpNumberOfBytesRead, lpOverlapped)
// hFile : HANDLE -> 'void *'
// lpBuffer : BYTE* optional, out -> 'uint8_t *'
// nNumberOfBytesToRead : DWORD -> 'uint32_t'
// lpNumberOfBytesRead : DWORD* optional, out -> 'uint32_t *'
// lpOverlapped : OVERLAPPED* optional, in/out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("KERNEL32.dll", {
ReadFile: { parameters: ["pointer", "pointer", "u32", "pointer", "pointer"], result: "i32" },
});
// lib.symbols.ReadFile(hFile, lpBuffer, nNumberOfBytesToRead, lpNumberOfBytesRead, lpOverlapped)
// hFile : HANDLE -> "pointer"
// lpBuffer : BYTE* optional, out -> "pointer"
// nNumberOfBytesToRead : DWORD -> "u32"
// lpNumberOfBytesRead : DWORD* optional, out -> "pointer"
// lpOverlapped : OVERLAPPED* optional, in/out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t ReadFile(
void* hFile,
uint8_t* lpBuffer,
uint32_t nNumberOfBytesToRead,
uint32_t* lpNumberOfBytesRead,
void* lpOverlapped);
C, "KERNEL32.dll");
// $ffi->ReadFile(hFile, lpBuffer, nNumberOfBytesToRead, lpNumberOfBytesRead, lpOverlapped);
// hFile : HANDLE
// lpBuffer : BYTE* optional, out
// nNumberOfBytesToRead : DWORD
// lpNumberOfBytesRead : DWORD* optional, out
// lpOverlapped : OVERLAPPED* optional, in/out
// 構造体/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 ReadFile(
Pointer hFile, // HANDLE
byte[] lpBuffer, // BYTE* optional, out
int nNumberOfBytesToRead, // DWORD
IntByReference lpNumberOfBytesRead, // DWORD* optional, out
Pointer lpOverlapped // OVERLAPPED* optional, in/out
);
}@[Link("kernel32")]
lib LibKERNEL32
fun ReadFile = ReadFile(
hFile : Void*, # HANDLE
lpBuffer : UInt8*, # BYTE* optional, out
nNumberOfBytesToRead : UInt32, # DWORD
lpNumberOfBytesRead : UInt32*, # DWORD* optional, out
lpOverlapped : OVERLAPPED* # OVERLAPPED* optional, in/out
) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef ReadFileNative = Int32 Function(Pointer<Void>, Pointer<Uint8>, Uint32, Pointer<Uint32>, Pointer<Void>);
typedef ReadFileDart = int Function(Pointer<Void>, Pointer<Uint8>, int, Pointer<Uint32>, Pointer<Void>);
final ReadFile = DynamicLibrary.open('KERNEL32.dll')
.lookupFunction<ReadFileNative, ReadFileDart>('ReadFile');
// hFile : HANDLE -> Pointer<Void>
// lpBuffer : BYTE* optional, out -> Pointer<Uint8>
// nNumberOfBytesToRead : DWORD -> Uint32
// lpNumberOfBytesRead : DWORD* optional, out -> Pointer<Uint32>
// lpOverlapped : OVERLAPPED* optional, in/out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function ReadFile(
hFile: THandle; // HANDLE
lpBuffer: Pointer; // BYTE* optional, out
nNumberOfBytesToRead: DWORD; // DWORD
lpNumberOfBytesRead: Pointer; // DWORD* optional, out
lpOverlapped: Pointer // OVERLAPPED* optional, in/out
): BOOL; stdcall;
external 'KERNEL32.dll' name 'ReadFile';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "ReadFile"
c_ReadFile :: Ptr () -> Ptr Word8 -> Word32 -> Ptr Word32 -> Ptr () -> IO CInt
-- hFile : HANDLE -> Ptr ()
-- lpBuffer : BYTE* optional, out -> Ptr Word8
-- nNumberOfBytesToRead : DWORD -> Word32
-- lpNumberOfBytesRead : DWORD* optional, out -> Ptr Word32
-- lpOverlapped : OVERLAPPED* optional, in/out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let readfile =
foreign "ReadFile"
((ptr void) @-> (ptr uint8_t) @-> uint32_t @-> (ptr uint32_t) @-> (ptr void) @-> returning int32_t)
(* hFile : HANDLE -> (ptr void) *)
(* lpBuffer : BYTE* optional, out -> (ptr uint8_t) *)
(* nNumberOfBytesToRead : DWORD -> uint32_t *)
(* lpNumberOfBytesRead : DWORD* optional, out -> (ptr uint32_t) *)
(* lpOverlapped : OVERLAPPED* optional, in/out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)
(cffi:defcfun ("ReadFile" read-file :convention :stdcall) :int32
(h-file :pointer) ; HANDLE
(lp-buffer :pointer) ; BYTE* optional, out
(n-number-of-bytes-to-read :uint32) ; DWORD
(lp-number-of-bytes-read :pointer) ; DWORD* optional, out
(lp-overlapped :pointer)) ; OVERLAPPED* optional, in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $ReadFile = Win32::API::More->new('KERNEL32',
'BOOL ReadFile(HANDLE hFile, LPVOID lpBuffer, DWORD nNumberOfBytesToRead, LPVOID lpNumberOfBytesRead, LPVOID lpOverlapped)');
# my $ret = $ReadFile->Call($hFile, $lpBuffer, $nNumberOfBytesToRead, $lpNumberOfBytesRead, $lpOverlapped);
# hFile : HANDLE -> HANDLE
# lpBuffer : BYTE* optional, out -> LPVOID
# nNumberOfBytesToRead : DWORD -> DWORD
# lpNumberOfBytesRead : DWORD* optional, out -> LPVOID
# lpOverlapped : OVERLAPPED* optional, in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
- f ReadFileEx — 完了ルーチンを使い非同期でファイルを読み込む。