ホーム › Networking.WinInet › InternetReadFile

InternetReadFile

関数

開いたインターネットハンドルからデータを読み取る。

DLLWININET.dll呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

BOOL InternetReadFile(
    void* hFile,
    void* lpBuffer,
    DWORD dwNumberOfBytesToRead,
    DWORD* lpdwNumberOfBytesRead
);

パラメーター

名前	型	方向	説明
hFile	void*	in	InternetOpenUrl、 FtpOpenFile、または HttpOpenRequest の前回の呼び出しで返されたハンドル。
lpBuffer	void*	out	データを受け取るバッファーへのポインター。
dwNumberOfBytesToRead	DWORD	in	読み取るバイト数。
lpdwNumberOfBytesRead	DWORD*	out	読み取られたバイト数を受け取る変数へのポインター。 InternetReadFile は、処理やエラーチェックを行う前にこの値をゼロに設定します。

戻り値の型: BOOL

公式ドキュメント

InternetOpenUrl、FtpOpenFile、または HttpOpenRequest 関数で開いたハンドルからデータを読み取ります。

戻り値

成功した場合は TRUE を、それ以外の場合は FALSE を返します。拡張エラー情報を取得するには、 GetLastError を呼び出します。アプリケーションは必要に応じて InternetGetLastResponseInfo を使用することもできます。

解説(Remarks)

InternetReadFile は、いくつかの例外を除き、基盤となる ReadFile 関数とほぼ同様に動作します。通常、 InternetReadFile は HINTERNET ハンドルからデータを連続したバイトストリームとして取得します。各 InternetReadFile 呼び出しで読み取るデータ量は dwNumberOfBytesToRead パラメーターで指定し、データは lpBuffer パラメーターで返されます。通常の読み取りでは、ファイルの終端に達するまで、各 InternetReadFile 呼び出しで指定された dwNumberOfBytesToRead 分のデータを取得します。すべてのデータを確実に取得するには、関数が TRUE を返し、かつ lpdwNumberOfBytesRead パラメーターがゼロになるまで、アプリケーションは InternetReadFile 関数を呼び出し続ける必要があります。これは、要求されたデータがキャッシュに書き込まれる場合に特に重要です。そうしないとキャッシュが正しく更新されず、ダウンロードされたファイルがキャッシュにコミットされないためです。なお、元のデータストリームを開く要求で INTERNET_FLAG_NO_CACHE_WRITE フラグを設定していない限り、キャッシュは自動的に行われます。

アプリケーションが InternetOpenUrl を使用してハンドルを取得した場合、WinINet はインターネットからの読み取りをアプリケーションにとって容易にするため、すべてのデータをファイルのダウンロードのように見せようとします。FTP ファイルディレクトリの一覧などの一部の種類の情報については、 InternetReadFile によって返されるデータを HTML ストリームに変換します。この変換は行単位で行われます。たとえば、FTP ディレクトリの一覧を 1 行の HTML に変換し、その HTML をアプリケーションに返すことができます。

WinINet は、HTML を lpBuffer バッファーに 1 行ずつ書き込もうとします。アプリケーションのバッファーが、生成された HTML の少なくとも 1 行を収めるには小さすぎる場合、より大きなバッファーが必要であることをアプリケーションに示すため、エラーコード ERROR_INSUFFICIENT_BUFFER が返されます。また、変換された行がバッファーを完全に満たさない場合もあるため、 InternetReadFile は要求されたよりも少ないデータを lpBuffer に格納して返ることがあります。後続の読み取りで、変換されたすべての HTML が取得されます。アプリケーションは、前述のとおり、すべてのデータが取得されたことを再度確認する必要があります。

WinINet API の他のすべての側面と同様に、この関数を DllMain 内、またはグローバルオブジェクトのコンストラクターやデストラクター内から安全に呼び出すことはできません。

非同期で実行している場合、InternetReadFile の呼び出しでトランザクションが完了しなかったときは FALSE を返し、続いて GetLastError を呼び出すと ERROR_IO_PENDING が返されます。トランザクションが完了すると、前回の InternetSetStatusCallback の呼び出しで指定された InternetStatusCallback が INTERNET_STATUS_REQUEST_COMPLETE とともに呼び出されます。

注意 WinINet はサーバー実装をサポートしていません。また、サービスから使用しないでください。サーバー実装やサービスでは、Microsoft Windows HTTP Services (WinHTTP) を使用してください。

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

各言語での呼び出し定義

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

BOOL InternetReadFile(
    void* hFile,
    void* lpBuffer,
    DWORD dwNumberOfBytesToRead,
    DWORD* lpdwNumberOfBytesRead
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WININET.dll", SetLastError = true, ExactSpelling = true)]
static extern bool InternetReadFile(
    IntPtr hFile,   // void*
    IntPtr lpBuffer,   // void* out
    uint dwNumberOfBytesToRead,   // DWORD
    out uint lpdwNumberOfBytesRead   // DWORD* out
);

<DllImport("WININET.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function InternetReadFile(
    hFile As IntPtr,   ' void*
    lpBuffer As IntPtr,   ' void* out
    dwNumberOfBytesToRead As UInteger,   ' DWORD
    <Out> ByRef lpdwNumberOfBytesRead As UInteger   ' DWORD* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hFile : void*
' lpBuffer : void* out
' dwNumberOfBytesToRead : DWORD
' lpdwNumberOfBytesRead : DWORD* out
Declare PtrSafe Function InternetReadFile Lib "wininet" ( _
    ByVal hFile As LongPtr, _
    ByVal lpBuffer As LongPtr, _
    ByVal dwNumberOfBytesToRead As Long, _
    ByRef lpdwNumberOfBytesRead As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

InternetReadFile = ctypes.windll.wininet.InternetReadFile
InternetReadFile.restype = wintypes.BOOL
InternetReadFile.argtypes = [
    ctypes.POINTER(None),  # hFile : void*
    ctypes.POINTER(None),  # lpBuffer : void* out
    wintypes.DWORD,  # dwNumberOfBytesToRead : DWORD
    ctypes.POINTER(wintypes.DWORD),  # lpdwNumberOfBytesRead : DWORD* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WININET.dll')
InternetReadFile = Fiddle::Function.new(
  lib['InternetReadFile'],
  [
    Fiddle::TYPE_VOIDP,  # hFile : void*
    Fiddle::TYPE_VOIDP,  # lpBuffer : void* out
    -Fiddle::TYPE_INT,  # dwNumberOfBytesToRead : DWORD
    Fiddle::TYPE_VOIDP,  # lpdwNumberOfBytesRead : DWORD* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "wininet")]
extern "system" {
    fn InternetReadFile(
        hFile: *mut (),  // void*
        lpBuffer: *mut (),  // void* out
        dwNumberOfBytesToRead: u32,  // DWORD
        lpdwNumberOfBytesRead: *mut u32  // DWORD* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WININET.dll", SetLastError = true)]
public static extern bool InternetReadFile(IntPtr hFile, IntPtr lpBuffer, uint dwNumberOfBytesToRead, out uint lpdwNumberOfBytesRead);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WININET_InternetReadFile' -Namespace Win32 -PassThru
# $api::InternetReadFile(hFile, lpBuffer, dwNumberOfBytesToRead, lpdwNumberOfBytesRead)

#uselib "WININET.dll"
#func global InternetReadFile "InternetReadFile" sptr, sptr, sptr, sptr
; InternetReadFile hFile, lpBuffer, dwNumberOfBytesToRead, varptr(lpdwNumberOfBytesRead)   ; 戻り値は stat
; hFile : void* -> "sptr"
; lpBuffer : void* out -> "sptr"
; dwNumberOfBytesToRead : DWORD -> "sptr"
; lpdwNumberOfBytesRead : DWORD* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "WININET.dll"
#cfunc global InternetReadFile "InternetReadFile" sptr, sptr, int, var
; res = InternetReadFile(hFile, lpBuffer, dwNumberOfBytesToRead, lpdwNumberOfBytesRead)
; hFile : void* -> "sptr"
; lpBuffer : void* out -> "sptr"
; dwNumberOfBytesToRead : DWORD -> "int"
; lpdwNumberOfBytesRead : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "WININET.dll"
#cfunc global InternetReadFile "InternetReadFile" sptr, sptr, int, sptr
; res = InternetReadFile(hFile, lpBuffer, dwNumberOfBytesToRead, varptr(lpdwNumberOfBytesRead))
; hFile : void* -> "sptr"
; lpBuffer : void* out -> "sptr"
; dwNumberOfBytesToRead : DWORD -> "int"
; lpdwNumberOfBytesRead : DWORD* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。