Win32 API 日本語リファレンス
ホームNetworking.WinHttp › WinHttpReadData

WinHttpReadData

関数
HTTP応答からデータをバッファへ読み取る。
DLLWINHTTP.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

BOOL WinHttpReadData(
    void* hRequest,
    void* lpBuffer,
    DWORD dwNumberOfBytesToRead,
    DWORD* lpdwNumberOfBytesRead
);

パラメーター

名前方向説明
hRequestvoid*inout直前の WinHttpOpenRequest の呼び出しによって返された、有効な HINTERNET ハンドル。WinHttpReadData を呼び出す前に、このハンドルに対して WinHttpReceiveResponse または WinHttpQueryDataAvailable が呼び出され、かつ完了している必要があります。WinHttpReceiveResponse の完了直後に WinHttpReadData を呼び出すとバッファコピーのコストを回避できますが、その場合はアプリケーションが読み取りに固定長バッファを使用する必要があります。
lpBuffervoid*out読み取ったデータを受け取るバッファへのポインター。このバッファは WinHttpReadData が完了するまで有効であり続けるようにしてください。
dwNumberOfBytesToReadDWORDin読み取るバイト数を格納する符号なしロング整数値。
lpdwNumberOfBytesReadDWORD*inout読み取られたバイト数を受け取る符号なしロング整数変数へのポインター。 WinHttpReadData は、何らかの処理やエラーチェックを行う前にこの値をゼロに設定します。WinHTTP を非同期で使用する場合は、常にこのパラメーターを NULL に設定し、情報はコールバック関数内で取得してください。これを行わないとメモリフォールトが発生する可能性があります。

戻り値の型: BOOL

公式ドキュメント

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

戻り値

成功した場合は TRUE を、それ以外の場合は FALSE を返します。拡張エラー情報を取得するには GetLastError を呼び出します。返されるエラーコードを次の表に示します。

エラーコード 説明
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)

Windows Vista および Windows Server 2008 以降、WinHttp はアプリケーションがサーバーに送信するデータに対してチャンク転送エンコードを実行できるようにします。WinHttp の応答に Transfer-Encoding ヘッダーが存在する場合、WinHttpReadData はデータをアプリケーションに渡す前にチャンク情報を取り除きます。

WinHTTP が非同期モードで使用されている場合(つまり WinHttpOpenWINHTTP_FLAG_ASYNC が設定されている場合)でも、この関数は同期的にも非同期的にも動作できます。この関数が FALSE を返した場合は失敗しており、 GetLastError を呼び出して拡張エラー情報を取得できます。この関数が TRUE を返した場合は、WINHTTP_CALLBACK_STATUS_READ_COMPLETE 完了通知を使用して、この関数が成功したかどうかおよびパラメーターの値を判断します。WINHTTP_CALLBACK_STATUS_REQUEST_ERROR 完了通知は、操作が非同期的に完了したが失敗したことを示します。

警告 WinHTTP を非同期モードで使用する場合は、常に lpdwNumberOfBytesRead パラメーターを NULL に設定し、読み取られたバイト数はコールバック関数内で取得してください。そうしないとメモリフォールトが発生する可能性があります。
読み取りバッファが非常に小さい場合、 WinHttpReadData は同期的に完了することがあります。WINHTTP_CALLBACK_STATUS_READ_COMPLETE 完了通知が WinHttpReadData の別の呼び出しを引き起こすと、スタックオーバーフローを招く可能性があります。一般的には、WinHTTP が使用する内部読み取りバッファ(8 KB)と同等以上のサイズの読み取りバッファを使用することをお勧めします。

WinHttpReadData を同期的に使用していて、戻り値が TRUE かつ読み取られたバイト数がゼロの場合、転送は完了しており、ハンドルから読み取るバイトはこれ以上ありません。これはローカルファイルでファイル終端に到達することに相当します。この関数を非同期的に使用している場合は、応答の終端が見つかったときに WINHTTP_CALLBACK_STATUS_READ_COMPLETE コールバックが dwStatusInformationLength パラメーターをゼロに設定して呼び出されます。

WinHttpReadData は、応答から利用可能なデータがなくなるまで lpBuffer が指すバッファを満たそうとします。サーバーから十分なデータが到着していない場合、バッファは満たされません。

WinHttpOpenRequest 関数によって作成され WinHttpSendRequest によって送信された HINTERNET ハンドルの場合、 WinHttpReadData を使用する前に、そのハンドルに対して WinHttpReceiveResponse を呼び出す必要があります。

WinHttpReadData で取得されるシングルバイト文字は、マルチバイト文字に変換されません。

読み取りバッファが非常に小さい場合、WinHttpReadData は同期的に完了することがあり、その際に WINHTTP_CALLBACK_STATUS_READ_COMPLETE 完了通知が WinHttpReadData の別の呼び出しを引き起こすと、スタックオーバーフローが発生する可能性があります。8 キロバイト以上のサイズの読み取りバッファを使用することをお勧めします。

サーバーから十分なデータが到着していない場合、WinHttpReadDatalpBuffer が指すバッファを完全には満たしません。バッファは、最初の読み取り時に少なくとも HTTP ヘッダーを保持できる大きさである必要があり、HTML エンコードされたディレクトリエントリを読み取る場合は、少なくとも 1 つの完全なエントリを保持できる大きさである必要があります。

WinHttpSetStatusCallback を使用してステータスコールバック関数がインストールされている場合、WinHttpSetStatusCallbackdwNotificationFlags パラメーターで設定された次の通知のうち、設定されたものが、利用可能なデータの確認の進行状況を示します。

注意 Windows XP および Windows 2000 については、WinHttp スタートページの Run-Time Requirements セクションを参照してください。

次の例は、セキュアトランザクションのセマンティクスを使用して、Secure Hypertext Transfer Protocol (HTTPS) サーバーからリソースをダウンロードする方法を示しています。このサンプルコードは、WinHTTP アプリケーションプログラミングインターフェイス (API) を初期化し、ターゲットの HTTPS サーバーを選択してから、このセキュアリソースに対する要求を開いて送信します。 WinHttpQueryDataAvailable を要求ハンドルとともに使用してダウンロード可能なデータ量を判断し、次に WinHttpReadData を使用してそのデータを読み取ります。この処理は、ドキュメント全体が取得されて表示されるまで繰り返されます。

    DWORD dwSize = 0;
    DWORD dwDownloaded = 0;
    LPSTR pszOutBuffer;
    BOOL  bResults = FALSE;
    HINTERNET  hSession = NULL, 
               hConnect = NULL,
               hRequest = NULL;

    // Use WinHttpOpen to obtain a session handle.
    hSession = WinHttpOpen( L"WinHTTP Example/1.0",  
                            WINHTTP_ACCESS_TYPE_DEFAULT_PROXY,
                            WINHTTP_NO_PROXY_NAME, 
                            WINHTTP_NO_PROXY_BYPASS, 0);

    // Specify an HTTP server.
    if (hSession)
        hConnect = WinHttpConnect( hSession, L"www.microsoft.com",
                                   INTERNET_DEFAULT_HTTPS_PORT, 0);

    // Create an HTTP request handle.
    if (hConnect)
        hRequest = WinHttpOpenRequest( hConnect, L"GET", NULL,
                                       NULL, WINHTTP_NO_REFERER, 
                                       WINHTTP_DEFAULT_ACCEPT_TYPES, 
                                       WINHTTP_FLAG_SECURE);

    // Send a request.
    if (hRequest)
        bResults = WinHttpSendRequest( hRequest,
                                       WINHTTP_NO_ADDITIONAL_HEADERS,
                                       0, WINHTTP_NO_REQUEST_DATA, 0, 
                                       0, 0);

 
    // End the request.
    if (bResults)
        bResults = WinHttpReceiveResponse( hRequest, NULL);

    // Keep checking for data until there is nothing left.
    if (bResults)
    {
        do 
        {
            // Check for available data.
            dwSize = 0;
            if (!WinHttpQueryDataAvailable( hRequest, &dwSize)) 
            {
                printf( "Error %u in WinHttpQueryDataAvailable.\n",
                        GetLastError());
                break;
            }
            
            // No more available data.
            if (!dwSize)
                break;

            // Allocate space for the buffer.
            pszOutBuffer = new char[dwSize+1];
            if (!pszOutBuffer)
            {
                printf("Out of memory\n");
                break;
            }
            
            // Read the Data.
            ZeroMemory(pszOutBuffer, dwSize+1);

            if (!WinHttpReadData( hRequest, (LPVOID)pszOutBuffer, 
                                  dwSize, &dwDownloaded))
            {                                  
                printf( "Error %u in WinHttpReadData.\n", GetLastError());
            }
            else
            {
                printf("%s", pszOutBuffer);
            }
        
            // Free the memory allocated to the buffer.
            delete [] pszOutBuffer;

            // This condition should never be reached since WinHttpQueryDataAvailable
            // reported that there are bits to read.
            if (!dwDownloaded)
                break;
                
        } while (dwSize > 0);
    }
    else
    {
        // Report any errors.
        printf( "Error %d has occurred.\n", GetLastError() );
    }

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

各言語での呼び出し定義

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

BOOL WinHttpReadData(
    void* hRequest,
    void* lpBuffer,
    DWORD dwNumberOfBytesToRead,
    DWORD* lpdwNumberOfBytesRead
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WINHTTP.dll", SetLastError = true, ExactSpelling = true)]
static extern bool WinHttpReadData(
    IntPtr hRequest,   // void* in/out
    IntPtr lpBuffer,   // void* out
    uint dwNumberOfBytesToRead,   // DWORD
    ref uint lpdwNumberOfBytesRead   // DWORD* in/out
);
<DllImport("WINHTTP.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function WinHttpReadData(
    hRequest As IntPtr,   ' void* in/out
    lpBuffer As IntPtr,   ' void* out
    dwNumberOfBytesToRead As UInteger,   ' DWORD
    ByRef lpdwNumberOfBytesRead As UInteger   ' DWORD* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' hRequest : void* in/out
' lpBuffer : void* out
' dwNumberOfBytesToRead : DWORD
' lpdwNumberOfBytesRead : DWORD* in/out
Declare PtrSafe Function WinHttpReadData Lib "winhttp" ( _
    ByVal hRequest 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

WinHttpReadData = ctypes.windll.winhttp.WinHttpReadData
WinHttpReadData.restype = wintypes.BOOL
WinHttpReadData.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
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WINHTTP.dll')
WinHttpReadData = Fiddle::Function.new(
  lib['WinHttpReadData'],
  [
    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_INT)
#[link(name = "winhttp")]
extern "system" {
    fn WinHttpReadData(
        hRequest: *mut (),  // void* in/out
        lpBuffer: *mut (),  // void* out
        dwNumberOfBytesToRead: u32,  // DWORD
        lpdwNumberOfBytesRead: *mut u32  // DWORD* in/out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WINHTTP.dll", SetLastError = true)]
public static extern bool WinHttpReadData(IntPtr hRequest, IntPtr lpBuffer, uint dwNumberOfBytesToRead, ref uint lpdwNumberOfBytesRead);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WINHTTP_WinHttpReadData' -Namespace Win32 -PassThru
# $api::WinHttpReadData(hRequest, lpBuffer, dwNumberOfBytesToRead, lpdwNumberOfBytesRead)
#uselib "WINHTTP.dll"
#func global WinHttpReadData "WinHttpReadData" sptr, sptr, sptr, sptr
; WinHttpReadData hRequest, lpBuffer, dwNumberOfBytesToRead, varptr(lpdwNumberOfBytesRead)   ; 戻り値は stat
; hRequest : void* in/out -> "sptr"
; lpBuffer : void* out -> "sptr"
; dwNumberOfBytesToRead : DWORD -> "sptr"
; lpdwNumberOfBytesRead : DWORD* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "WINHTTP.dll"
#cfunc global WinHttpReadData "WinHttpReadData" sptr, sptr, int, var
; res = WinHttpReadData(hRequest, lpBuffer, dwNumberOfBytesToRead, lpdwNumberOfBytesRead)
; hRequest : void* in/out -> "sptr"
; lpBuffer : void* out -> "sptr"
; dwNumberOfBytesToRead : DWORD -> "int"
; lpdwNumberOfBytesRead : DWORD* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL WinHttpReadData(void* hRequest, void* lpBuffer, DWORD dwNumberOfBytesToRead, DWORD* lpdwNumberOfBytesRead)
#uselib "WINHTTP.dll"
#cfunc global WinHttpReadData "WinHttpReadData" intptr, intptr, int, var
; res = WinHttpReadData(hRequest, lpBuffer, dwNumberOfBytesToRead, lpdwNumberOfBytesRead)
; hRequest : void* in/out -> "intptr"
; lpBuffer : void* out -> "intptr"
; dwNumberOfBytesToRead : DWORD -> "int"
; lpdwNumberOfBytesRead : DWORD* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	winhttp = windows.NewLazySystemDLL("WINHTTP.dll")
	procWinHttpReadData = winhttp.NewProc("WinHttpReadData")
)

// hRequest (void* in/out), lpBuffer (void* out), dwNumberOfBytesToRead (DWORD), lpdwNumberOfBytesRead (DWORD* in/out)
r1, _, err := procWinHttpReadData.Call(
	uintptr(hRequest),
	uintptr(lpBuffer),
	uintptr(dwNumberOfBytesToRead),
	uintptr(lpdwNumberOfBytesRead),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function WinHttpReadData(
  hRequest: Pointer;   // void* in/out
  lpBuffer: Pointer;   // void* out
  dwNumberOfBytesToRead: DWORD;   // DWORD
  lpdwNumberOfBytesRead: Pointer   // DWORD* in/out
): BOOL; stdcall;
  external 'WINHTTP.dll' name 'WinHttpReadData';
result := DllCall("WINHTTP\WinHttpReadData"
    , "Ptr", hRequest   ; void* in/out
    , "Ptr", lpBuffer   ; void* out
    , "UInt", dwNumberOfBytesToRead   ; DWORD
    , "Ptr", lpdwNumberOfBytesRead   ; DWORD* in/out
    , "Int")   ; return: BOOL
●WinHttpReadData(hRequest, lpBuffer, dwNumberOfBytesToRead, lpdwNumberOfBytesRead) = DLL("WINHTTP.dll", "bool WinHttpReadData(void*, void*, dword, void*)")
# 呼び出し: WinHttpReadData(hRequest, lpBuffer, dwNumberOfBytesToRead, lpdwNumberOfBytesRead)
# hRequest : void* in/out -> "void*"
# lpBuffer : void* out -> "void*"
# dwNumberOfBytesToRead : DWORD -> "dword"
# lpdwNumberOfBytesRead : DWORD* in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "winhttp" fn WinHttpReadData(
    hRequest: ?*anyopaque, // void* in/out
    lpBuffer: ?*anyopaque, // void* out
    dwNumberOfBytesToRead: u32, // DWORD
    lpdwNumberOfBytesRead: [*c]u32 // DWORD* in/out
) callconv(std.os.windows.WINAPI) i32;
proc WinHttpReadData(
    hRequest: pointer,  # void* in/out
    lpBuffer: pointer,  # void* out
    dwNumberOfBytesToRead: uint32,  # DWORD
    lpdwNumberOfBytesRead: ptr uint32  # DWORD* in/out
): int32 {.importc: "WinHttpReadData", stdcall, dynlib: "WINHTTP.dll".}
pragma(lib, "winhttp");
extern(Windows)
int WinHttpReadData(
    void* hRequest,   // void* in/out
    void* lpBuffer,   // void* out
    uint dwNumberOfBytesToRead,   // DWORD
    uint* lpdwNumberOfBytesRead   // DWORD* in/out
);
ccall((:WinHttpReadData, "WINHTTP.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Ptr{Cvoid}, UInt32, Ptr{UInt32}),
      hRequest, lpBuffer, dwNumberOfBytesToRead, lpdwNumberOfBytesRead)
# hRequest : void* in/out -> Ptr{Cvoid}
# lpBuffer : void* out -> Ptr{Cvoid}
# dwNumberOfBytesToRead : DWORD -> UInt32
# lpdwNumberOfBytesRead : DWORD* in/out -> Ptr{UInt32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t WinHttpReadData(
    void* hRequest,
    void* lpBuffer,
    uint32_t dwNumberOfBytesToRead,
    uint32_t* lpdwNumberOfBytesRead);
]]
local winhttp = ffi.load("winhttp")
-- winhttp.WinHttpReadData(hRequest, lpBuffer, dwNumberOfBytesToRead, lpdwNumberOfBytesRead)
-- hRequest : void* in/out
-- lpBuffer : void* out
-- dwNumberOfBytesToRead : DWORD
-- lpdwNumberOfBytesRead : DWORD* in/out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('WINHTTP.dll');
const WinHttpReadData = lib.func('__stdcall', 'WinHttpReadData', 'int32_t', ['void *', 'void *', 'uint32_t', 'uint32_t *']);
// WinHttpReadData(hRequest, lpBuffer, dwNumberOfBytesToRead, lpdwNumberOfBytesRead)
// hRequest : void* in/out -> 'void *'
// lpBuffer : void* out -> 'void *'
// dwNumberOfBytesToRead : DWORD -> 'uint32_t'
// lpdwNumberOfBytesRead : DWORD* in/out -> 'uint32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("WINHTTP.dll", {
  WinHttpReadData: { parameters: ["pointer", "pointer", "u32", "pointer"], result: "i32" },
});
// lib.symbols.WinHttpReadData(hRequest, lpBuffer, dwNumberOfBytesToRead, lpdwNumberOfBytesRead)
// hRequest : void* in/out -> "pointer"
// lpBuffer : void* out -> "pointer"
// dwNumberOfBytesToRead : DWORD -> "u32"
// lpdwNumberOfBytesRead : DWORD* in/out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t WinHttpReadData(
    void* hRequest,
    void* lpBuffer,
    uint32_t dwNumberOfBytesToRead,
    uint32_t* lpdwNumberOfBytesRead);
C, "WINHTTP.dll");
// $ffi->WinHttpReadData(hRequest, lpBuffer, dwNumberOfBytesToRead, lpdwNumberOfBytesRead);
// hRequest : void* in/out
// lpBuffer : void* out
// dwNumberOfBytesToRead : DWORD
// lpdwNumberOfBytesRead : DWORD* 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 Winhttp extends StdCallLibrary {
    Winhttp INSTANCE = Native.load("winhttp", Winhttp.class);
    boolean WinHttpReadData(
        Pointer hRequest,   // void* in/out
        Pointer lpBuffer,   // void* out
        int dwNumberOfBytesToRead,   // DWORD
        IntByReference lpdwNumberOfBytesRead   // DWORD* in/out
    );
}
@[Link("winhttp")]
lib LibWINHTTP
  fun WinHttpReadData = WinHttpReadData(
    hRequest : Void*,   # void* in/out
    lpBuffer : Void*,   # void* out
    dwNumberOfBytesToRead : UInt32,   # DWORD
    lpdwNumberOfBytesRead : UInt32*   # DWORD* 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 WinHttpReadDataNative = Int32 Function(Pointer<Void>, Pointer<Void>, Uint32, Pointer<Uint32>);
typedef WinHttpReadDataDart = int Function(Pointer<Void>, Pointer<Void>, int, Pointer<Uint32>);
final WinHttpReadData = DynamicLibrary.open('WINHTTP.dll')
    .lookupFunction<WinHttpReadDataNative, WinHttpReadDataDart>('WinHttpReadData');
// hRequest : void* in/out -> Pointer<Void>
// lpBuffer : void* out -> Pointer<Void>
// dwNumberOfBytesToRead : DWORD -> Uint32
// lpdwNumberOfBytesRead : DWORD* in/out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function WinHttpReadData(
  hRequest: Pointer;   // void* in/out
  lpBuffer: Pointer;   // void* out
  dwNumberOfBytesToRead: DWORD;   // DWORD
  lpdwNumberOfBytesRead: Pointer   // DWORD* in/out
): BOOL; stdcall;
  external 'WINHTTP.dll' name 'WinHttpReadData';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "WinHttpReadData"
  c_WinHttpReadData :: Ptr () -> Ptr () -> Word32 -> Ptr Word32 -> IO CInt
-- hRequest : void* in/out -> Ptr ()
-- lpBuffer : void* out -> Ptr ()
-- dwNumberOfBytesToRead : DWORD -> Word32
-- lpdwNumberOfBytesRead : DWORD* in/out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let winhttpreaddata =
  foreign "WinHttpReadData"
    ((ptr void) @-> (ptr void) @-> uint32_t @-> (ptr uint32_t) @-> returning int32_t)
(* hRequest : void* in/out -> (ptr void) *)
(* lpBuffer : void* out -> (ptr void) *)
(* dwNumberOfBytesToRead : DWORD -> uint32_t *)
(* lpdwNumberOfBytesRead : DWORD* in/out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library winhttp (t "WINHTTP.dll"))
(cffi:use-foreign-library winhttp)

(cffi:defcfun ("WinHttpReadData" win-http-read-data :convention :stdcall) :int32
  (h-request :pointer)   ; void* in/out
  (lp-buffer :pointer)   ; void* out
  (dw-number-of-bytes-to-read :uint32)   ; DWORD
  (lpdw-number-of-bytes-read :pointer))   ; DWORD* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $WinHttpReadData = Win32::API::More->new('WINHTTP',
    'BOOL WinHttpReadData(LPVOID hRequest, LPVOID lpBuffer, DWORD dwNumberOfBytesToRead, LPVOID lpdwNumberOfBytesRead)');
# my $ret = $WinHttpReadData->Call($hRequest, $lpBuffer, $dwNumberOfBytesToRead, $lpdwNumberOfBytesRead);
# hRequest : void* in/out -> LPVOID
# lpBuffer : void* out -> LPVOID
# dwNumberOfBytesToRead : DWORD -> DWORD
# lpdwNumberOfBytesRead : DWORD* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

類似 API
公式の関連項目