Win32API: ReadFile

ファイル データを指定したバッファに読み込みます。


定義
Declare Function ReadFile Lib "kernel32" _
         (hFile As HANDLE, _
          lpBuffer As VoidPtr, _
          nNumberOfBytesToRead As DWord, _
          lpNumberOfBytesRead As DWordPtr, _
    ByRef lpOverlapped As OVERLAPPED) As Long
hFile
GENERIC_READ権を持つ、ファイル ハンドルを指定します。

lpBuffer
バッファへのポインタを指定します。ファイルから読み込まれるデータはここで指定するバッファに格納されていきます。

nNumberOfBytesToRead
読み込むデータのバイト数を指定します。

lpNumberOfBytesRead
DWord型変数へのポインタを指定します。実際に読み込まれたデータのバイト数が格納されます。
lpOverlapped パラメータに NULL を指定した場合は、lpNumberOfBytesRead を NULL にすることができません。
lpOverlapped パラメータを指定した場合は、lpNumberOfBytesRead を NULL にすることができます。

lpOverlapped (ポインタ参照)
OVERLAPPED構造体へのポインタを指定します。必要のない場合は NULL を指定することができます。

戻り値

関数が成功すると、TRUE が返ります。失敗すると FALSE が返ります。
戻り値が TRUE であり、lpNumberOfBytesRead に格納された値が 0 の場合、ファイル ポインタがファイルの終端を越えていることを意味します。

解説

ファイル ポインタの現在位置から読み込みが開始されます。読み取ったデータのバイト数だけ、ファイル ポインタは進められます。

環境情報

インクルード ファイル: api_system.sbp 内で定義済み
DLLファイル: kernel32.dll


CreateFile関数SetFilePointer関数WriteFile関数