ホーム › Networking.WinInet › InternetReadFileExA

InternetReadFileExA

関数

インターネットハンドルから拡張形式でデータを読み取る(ANSI)。

DLLWININET.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

// WININET.dll  (ANSI / -A)
#include <windows.h>

BOOL InternetReadFileExA(
    void* hFile,
    INTERNET_BUFFERSA* lpBuffersOut,
    DWORD dwFlags,
    UINT_PTR dwContext   // optional
);

パラメーター

名前

型

方向

説明

hFile

void*

InternetOpenUrl 関数または HttpOpenRequest 関数が返したハンドルです。

lpBuffersOut

INTERNET_BUFFERSA*

out

ダウンロードしたデータを受け取る INTERNET_BUFFERS 構造体へのポインターです。

dwFlags

DWORD

このパラメーターには、次のいずれかの値を指定できます。

値	意味
IRF_ASYNC	WININET_API_FLAG_ASYNC と同一です。
IRF_SYNC	WININET_API_FLAG_SYNC と同一です。
IRF_USE_CONTEXT	WININET_API_FLAG_USE_CONTEXT と同一です。
IRF_NO_WAIT	データを待機しません。利用可能なデータがある場合、この関数は要求されたデータ量または利用可能なデータ量のいずれか小さい方を返します。

dwContext

UINT_PTR

inoptional

非同期操作で使用される、呼び出し元が指定したコンテキスト値です。

戻り値の型: BOOL

公式ドキュメント

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

戻り値

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

解説(Remarks)

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

メモ

wininet.h ヘッダーは InternetReadFileEx を、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして定義しています。エンコーディング非依存のエイリアスを、エンコーディング非依存でないコードと混在させて使用すると、コンパイルエラーや実行時エラーを引き起こす不一致が生じる可能性があります。詳細については、Conventions for Function Prototypes を参照してください。

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

各言語での呼び出し定義

// WININET.dll  (ANSI / -A)
#include <windows.h>

BOOL InternetReadFileExA(
    void* hFile,
    INTERNET_BUFFERSA* lpBuffersOut,
    DWORD dwFlags,
    UINT_PTR dwContext   // optional
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WININET.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool InternetReadFileExA(
    IntPtr hFile,   // void*
    IntPtr lpBuffersOut,   // INTERNET_BUFFERSA* out
    uint dwFlags,   // DWORD
    UIntPtr dwContext   // UINT_PTR optional
);

<DllImport("WININET.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function InternetReadFileExA(
    hFile As IntPtr,   ' void*
    lpBuffersOut As IntPtr,   ' INTERNET_BUFFERSA* out
    dwFlags As UInteger,   ' DWORD
    dwContext As UIntPtr   ' UINT_PTR optional
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hFile : void*
' lpBuffersOut : INTERNET_BUFFERSA* out
' dwFlags : DWORD
' dwContext : UINT_PTR optional
Declare PtrSafe Function InternetReadFileExA Lib "wininet" ( _
    ByVal hFile As LongPtr, _
    ByVal lpBuffersOut As LongPtr, _
    ByVal dwFlags As Long, _
    ByVal dwContext As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

InternetReadFileExA = ctypes.windll.wininet.InternetReadFileExA
InternetReadFileExA.restype = wintypes.BOOL
InternetReadFileExA.argtypes = [
    ctypes.POINTER(None),  # hFile : void*
    ctypes.c_void_p,  # lpBuffersOut : INTERNET_BUFFERSA* out
    wintypes.DWORD,  # dwFlags : DWORD
    ctypes.c_size_t,  # dwContext : UINT_PTR optional
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WININET.dll')
InternetReadFileExA = Fiddle::Function.new(
  lib['InternetReadFileExA'],
  [
    Fiddle::TYPE_VOIDP,  # hFile : void*
    Fiddle::TYPE_VOIDP,  # lpBuffersOut : INTERNET_BUFFERSA* out
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
    Fiddle::TYPE_UINTPTR_T,  # dwContext : UINT_PTR optional
  ],
  Fiddle::TYPE_INT)

#[link(name = "wininet")]
extern "system" {
    fn InternetReadFileExA(
        hFile: *mut (),  // void*
        lpBuffersOut: *mut INTERNET_BUFFERSA,  // INTERNET_BUFFERSA* out
        dwFlags: u32,  // DWORD
        dwContext: usize  // UINT_PTR optional
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WININET.dll", CharSet = CharSet.Ansi, SetLastError = true)]
public static extern bool InternetReadFileExA(IntPtr hFile, IntPtr lpBuffersOut, uint dwFlags, UIntPtr dwContext);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WININET_InternetReadFileExA' -Namespace Win32 -PassThru
# $api::InternetReadFileExA(hFile, lpBuffersOut, dwFlags, dwContext)

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

出力引数:

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