ホーム › Networking.WinHttp › WinHttpReadDataEx

WinHttpReadDataEx

関数

HTTP応答から拡張フラグ付きでデータを読み取る。

DLLWINHTTP.dll呼出規約winapi

シグネチャ

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

DWORD WinHttpReadDataEx(
    void* hRequest,
    void* lpBuffer,
    DWORD dwNumberOfBytesToRead,
    DWORD* lpdwNumberOfBytesRead,
    ULONGLONG ullFlags,
    DWORD cbProperty,
    void* pvProperty   // optional
);

パラメーター

名前	型	方向	説明
hRequest	void*	inout	以前の WinHttpOpenRequest の呼び出しから返された HINTERNET ハンドルです。 WinHttpReadDataEx を呼び出す前に、このハンドルに対して WinHttpReceiveResponse または WinHttpQueryDataAvailable を呼び出し、その処理が完了している必要があります。WinHttpReceiveResponse の完了直後に WinHttpReadDataEx を呼び出すとバッファコピーのコストを回避できますが、その場合はアプリケーションで読み取りに固定長バッファを使用する必要があります。
lpBuffer	void*	out	読み取ったデータを受け取るバッファへのポインターです。このバッファは WinHttpReadDataEx が完了するまで有効なまま保持してください。
dwNumberOfBytesToRead	DWORD	in	読み取るバイト数を含む符号なし長整数値です。
lpdwNumberOfBytesRead	DWORD*	inout	読み取られたバイト数を受け取る符号なし長整数変数へのポインターです。 WinHttpReadDataEx は、何らかの処理やエラーチェックを行う前にこの値をゼロに設定します。WinHTTP を非同期で使用する場合は、常にこのパラメーターを NULL に設定し、コールバック関数内で情報を取得してください。これを行わないとメモリフォールトが発生する可能性があります。
ullFlags	ULONGLONG	in	WINHTTP_READ_DATA_EX_FLAG_FILL_BUFFER を渡すと、指定したデータバッファが満たされるか、または応答が完了するまで、WinHttp は WinHttpReadDataEx の呼び出しを完了しません。このフラグを渡すと、この API の動作は WinHttpReadData と同等になります。
cbProperty	DWORD	in	予約済みです。0 を渡してください。
pvProperty	void*	inoptional	予約済みです。NULL を渡してください。

戻り値の型: DWORD

公式ドキュメント

WinHttpOpenRequest 関数によって開かれたハンドルからデータを読み取ります。

戻り値

操作の結果を示すステータスコードです。返されるエラーコードには次のものがあります。

エラーコード	説明
ERROR_WINHTTP_CONNECTION_ERROR	サーバーとの接続がリセットまたは終了されたか、互換性のない SSL プロトコルが検出されました。たとえば、WinHTTP 5.1 はクライアントが明示的に有効化しない限り SSL2 をサポートしません。
ERROR_WINHTTP_INCORRECT_HANDLE_STATE	指定されたハンドルが正しい状態にないため、要求された操作を実行できません。
ERROR_WINHTTP_INCORRECT_HANDLE_TYPE	指定されたハンドルの種類がこの操作に対して正しくありません。
ERROR_WINHTTP_INTERNAL_ERROR	内部エラーが発生しました。
ERROR_WINHTTP_OPERATION_CANCELLED	操作がキャンセルされました。通常は、操作が完了する前に、要求を処理していたハンドルが閉じられたことが原因です。
ERROR_WINHTTP_RESPONSE_DRAIN_OVERFLOW	受信した応答が WinHTTP の内部サイズ制限を超えた場合に返されます。
ERROR_WINHTTP_TIMEOUT	要求がタイムアウトしました。
ERROR_NOT_ENOUGH_MEMORY	要求された操作を完了するための十分なメモリがありませんでした。(Windows エラーコード)

解説(Remarks)

既定では、WinHttpReadDataEx は、指定したバッファに何らかの量のデータが書き込まれた時点で返ります(この関数が指定したバッファを常に完全に満たすとは限りません)。

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

各言語での呼び出し定義

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

DWORD WinHttpReadDataEx(
    void* hRequest,
    void* lpBuffer,
    DWORD dwNumberOfBytesToRead,
    DWORD* lpdwNumberOfBytesRead,
    ULONGLONG ullFlags,
    DWORD cbProperty,
    void* pvProperty   // optional
);

[DllImport("WINHTTP.dll", ExactSpelling = true)]
static extern uint WinHttpReadDataEx(
    IntPtr hRequest,   // void* in/out
    IntPtr lpBuffer,   // void* out
    uint dwNumberOfBytesToRead,   // DWORD
    ref uint lpdwNumberOfBytesRead,   // DWORD* in/out
    ulong ullFlags,   // ULONGLONG
    uint cbProperty,   // DWORD
    IntPtr pvProperty   // void* optional
);

<DllImport("WINHTTP.dll", ExactSpelling:=True)>
Public Shared Function WinHttpReadDataEx(
    hRequest As IntPtr,   ' void* in/out
    lpBuffer As IntPtr,   ' void* out
    dwNumberOfBytesToRead As UInteger,   ' DWORD
    ByRef lpdwNumberOfBytesRead As UInteger,   ' DWORD* in/out
    ullFlags As ULong,   ' ULONGLONG
    cbProperty As UInteger,   ' DWORD
    pvProperty As IntPtr   ' void* optional
) As UInteger
End Function

' hRequest : void* in/out
' lpBuffer : void* out
' dwNumberOfBytesToRead : DWORD
' lpdwNumberOfBytesRead : DWORD* in/out
' ullFlags : ULONGLONG
' cbProperty : DWORD
' pvProperty : void* optional
Declare PtrSafe Function WinHttpReadDataEx Lib "winhttp" ( _
    ByVal hRequest As LongPtr, _
    ByVal lpBuffer As LongPtr, _
    ByVal dwNumberOfBytesToRead As Long, _
    ByRef lpdwNumberOfBytesRead As Long, _
    ByVal ullFlags As LongLong, _
    ByVal cbProperty As Long, _
    ByVal pvProperty As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

WinHttpReadDataEx = ctypes.windll.winhttp.WinHttpReadDataEx
WinHttpReadDataEx.restype = wintypes.DWORD
WinHttpReadDataEx.argtypes = [
    ctypes.POINTER(None),  # hRequest : void* in/out
    ctypes.POINTER(None),  # lpBuffer : void* out
    wintypes.DWORD,  # dwNumberOfBytesToRead : DWORD
    ctypes.POINTER(wintypes.DWORD),  # lpdwNumberOfBytesRead : DWORD* in/out
    ctypes.c_ulonglong,  # ullFlags : ULONGLONG
    wintypes.DWORD,  # cbProperty : DWORD
    ctypes.POINTER(None),  # pvProperty : void* optional
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WINHTTP.dll')
WinHttpReadDataEx = Fiddle::Function.new(
  lib['WinHttpReadDataEx'],
  [
    Fiddle::TYPE_VOIDP,  # hRequest : void* in/out
    Fiddle::TYPE_VOIDP,  # lpBuffer : void* out
    -Fiddle::TYPE_INT,  # dwNumberOfBytesToRead : DWORD
    Fiddle::TYPE_VOIDP,  # lpdwNumberOfBytesRead : DWORD* in/out
    -Fiddle::TYPE_LONG_LONG,  # ullFlags : ULONGLONG
    -Fiddle::TYPE_INT,  # cbProperty : DWORD
    Fiddle::TYPE_VOIDP,  # pvProperty : void* optional
  ],
  -Fiddle::TYPE_INT)

#[link(name = "winhttp")]
extern "system" {
    fn WinHttpReadDataEx(
        hRequest: *mut (),  // void* in/out
        lpBuffer: *mut (),  // void* out
        dwNumberOfBytesToRead: u32,  // DWORD
        lpdwNumberOfBytesRead: *mut u32,  // DWORD* in/out
        ullFlags: u64,  // ULONGLONG
        cbProperty: u32,  // DWORD
        pvProperty: *mut ()  // void* optional
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("WINHTTP.dll")]
public static extern uint WinHttpReadDataEx(IntPtr hRequest, IntPtr lpBuffer, uint dwNumberOfBytesToRead, ref uint lpdwNumberOfBytesRead, ulong ullFlags, uint cbProperty, IntPtr pvProperty);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WINHTTP_WinHttpReadDataEx' -Namespace Win32 -PassThru
# $api::WinHttpReadDataEx(hRequest, lpBuffer, dwNumberOfBytesToRead, lpdwNumberOfBytesRead, ullFlags, cbProperty, pvProperty)

#uselib "WINHTTP.dll"
#func global WinHttpReadDataEx "WinHttpReadDataEx" sptr, sptr, sptr, sptr, sptr, sptr, sptr
; WinHttpReadDataEx hRequest, lpBuffer, dwNumberOfBytesToRead, varptr(lpdwNumberOfBytesRead), ullFlags, cbProperty, pvProperty   ; 戻り値は stat
; hRequest : void* in/out -> "sptr"
; lpBuffer : void* out -> "sptr"
; dwNumberOfBytesToRead : DWORD -> "sptr"
; lpdwNumberOfBytesRead : DWORD* in/out -> "sptr"
; ullFlags : ULONGLONG -> "sptr"
; cbProperty : DWORD -> "sptr"
; pvProperty : void* optional -> "sptr"
; ※HSP3.7は int64 引数(64bit値渡し)に非対応です。
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "WINHTTP.dll"
#cfunc global WinHttpReadDataEx "WinHttpReadDataEx" sptr, sptr, int, var, int64, int, sptr
; res = WinHttpReadDataEx(hRequest, lpBuffer, dwNumberOfBytesToRead, lpdwNumberOfBytesRead, ullFlags, cbProperty, pvProperty)
; hRequest : void* in/out -> "sptr"
; lpBuffer : void* out -> "sptr"
; dwNumberOfBytesToRead : DWORD -> "int"
; lpdwNumberOfBytesRead : DWORD* in/out -> "var"
; ullFlags : ULONGLONG -> "int64"
; cbProperty : DWORD -> "int"
; pvProperty : void* optional -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
; ※int64 引数の DLL 値渡しは x64 ランタイム(hsp3_64)のみ対応(x86 は未対応)。#uselib "WINHTTP.dll"
#cfunc global WinHttpReadDataEx "WinHttpReadDataEx" sptr, sptr, int, sptr, int64, int, sptr
; res = WinHttpReadDataEx(hRequest, lpBuffer, dwNumberOfBytesToRead, varptr(lpdwNumberOfBytesRead), ullFlags, cbProperty, pvProperty)
; hRequest : void* in/out -> "sptr"
; lpBuffer : void* out -> "sptr"
; dwNumberOfBytesToRead : DWORD -> "int"
; lpdwNumberOfBytesRead : DWORD* in/out -> "sptr"
; ullFlags : ULONGLONG -> "int64"
; cbProperty : DWORD -> "int"
; pvProperty : void* optional -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※int64 引数の DLL 値渡しは x64 ランタイム(hsp3_64)のみ対応(x86 は未対応)。