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
lpBuffervoid*out
dwNumberOfBytesToReadDWORDin
lpdwNumberOfBytesReadDWORD*inout

戻り値の型: BOOL

各言語での呼び出し定義

// 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 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)。