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

WinHttpProtocolReceive

関数
昇格したプロトコル接続からデータを受信する。
DLLWINHTTP.dll呼出規約winapi

シグネチャ

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

DWORD WinHttpProtocolReceive(
    void* ProtocolHandle,
    ULONGLONG Flags,
    void* pvBuffer,
    DWORD dwBufferLength,
    DWORD* pdwBytesRead
);

パラメーター

名前方向説明
ProtocolHandlevoid*inCompleteUpgradeで取得した汎用プロトコルハンドル。受信対象。
FlagsULONGLONGin受信動作を制御する64ビットフラグ。
pvBuffervoid*out受信データを格納するバッファへのポインタ。出力用。
dwBufferLengthDWORDinpvBufferが受け入れ可能な最大バイト数。
pdwBytesReadDWORD*inout実際に受信したバイト数を受け取るDWORDポインタ。

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD WinHttpProtocolReceive(
    void* ProtocolHandle,
    ULONGLONG Flags,
    void* pvBuffer,
    DWORD dwBufferLength,
    DWORD* pdwBytesRead
);
[DllImport("WINHTTP.dll", ExactSpelling = true)]
static extern uint WinHttpProtocolReceive(
    IntPtr ProtocolHandle,   // void*
    ulong Flags,   // ULONGLONG
    IntPtr pvBuffer,   // void* out
    uint dwBufferLength,   // DWORD
    ref uint pdwBytesRead   // DWORD* in/out
);
<DllImport("WINHTTP.dll", ExactSpelling:=True)>
Public Shared Function WinHttpProtocolReceive(
    ProtocolHandle As IntPtr,   ' void*
    Flags As ULong,   ' ULONGLONG
    pvBuffer As IntPtr,   ' void* out
    dwBufferLength As UInteger,   ' DWORD
    ByRef pdwBytesRead As UInteger   ' DWORD* in/out
) As UInteger
End Function
' ProtocolHandle : void*
' Flags : ULONGLONG
' pvBuffer : void* out
' dwBufferLength : DWORD
' pdwBytesRead : DWORD* in/out
Declare PtrSafe Function WinHttpProtocolReceive Lib "winhttp" ( _
    ByVal ProtocolHandle As LongPtr, _
    ByVal Flags As LongLong, _
    ByVal pvBuffer As LongPtr, _
    ByVal dwBufferLength As Long, _
    ByRef pdwBytesRead As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

WinHttpProtocolReceive = ctypes.windll.winhttp.WinHttpProtocolReceive
WinHttpProtocolReceive.restype = wintypes.DWORD
WinHttpProtocolReceive.argtypes = [
    ctypes.POINTER(None),  # ProtocolHandle : void*
    ctypes.c_ulonglong,  # Flags : ULONGLONG
    ctypes.POINTER(None),  # pvBuffer : void* out
    wintypes.DWORD,  # dwBufferLength : DWORD
    ctypes.POINTER(wintypes.DWORD),  # pdwBytesRead : DWORD* in/out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WINHTTP.dll')
WinHttpProtocolReceive = Fiddle::Function.new(
  lib['WinHttpProtocolReceive'],
  [
    Fiddle::TYPE_VOIDP,  # ProtocolHandle : void*
    -Fiddle::TYPE_LONG_LONG,  # Flags : ULONGLONG
    Fiddle::TYPE_VOIDP,  # pvBuffer : void* out
    -Fiddle::TYPE_INT,  # dwBufferLength : DWORD
    Fiddle::TYPE_VOIDP,  # pdwBytesRead : DWORD* in/out
  ],
  -Fiddle::TYPE_INT)
#[link(name = "winhttp")]
extern "system" {
    fn WinHttpProtocolReceive(
        ProtocolHandle: *mut (),  // void*
        Flags: u64,  // ULONGLONG
        pvBuffer: *mut (),  // void* out
        dwBufferLength: u32,  // DWORD
        pdwBytesRead: *mut u32  // DWORD* in/out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("WINHTTP.dll")]
public static extern uint WinHttpProtocolReceive(IntPtr ProtocolHandle, ulong Flags, IntPtr pvBuffer, uint dwBufferLength, ref uint pdwBytesRead);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WINHTTP_WinHttpProtocolReceive' -Namespace Win32 -PassThru
# $api::WinHttpProtocolReceive(ProtocolHandle, Flags, pvBuffer, dwBufferLength, pdwBytesRead)
#uselib "WINHTTP.dll"
#func global WinHttpProtocolReceive "WinHttpProtocolReceive" sptr, sptr, sptr, sptr, sptr
; WinHttpProtocolReceive ProtocolHandle, Flags, pvBuffer, dwBufferLength, varptr(pdwBytesRead)   ; 戻り値は stat
; ProtocolHandle : void* -> "sptr"
; Flags : ULONGLONG -> "sptr"
; pvBuffer : void* out -> "sptr"
; dwBufferLength : DWORD -> "sptr"
; pdwBytesRead : DWORD* in/out -> "sptr"
; ※HSP3.7は int64 引数(64bit値渡し)に非対応です。
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "WINHTTP.dll"
#cfunc global WinHttpProtocolReceive "WinHttpProtocolReceive" sptr, int64, sptr, int, var
; res = WinHttpProtocolReceive(ProtocolHandle, Flags, pvBuffer, dwBufferLength, pdwBytesRead)
; ProtocolHandle : void* -> "sptr"
; Flags : ULONGLONG -> "int64"
; pvBuffer : void* out -> "sptr"
; dwBufferLength : DWORD -> "int"
; pdwBytesRead : DWORD* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
; ※int64 引数の DLL 値渡しは x64 ランタイム(hsp3_64)のみ対応(x86 は未対応)。
出力引数:
; DWORD WinHttpProtocolReceive(void* ProtocolHandle, ULONGLONG Flags, void* pvBuffer, DWORD dwBufferLength, DWORD* pdwBytesRead)
#uselib "WINHTTP.dll"
#cfunc global WinHttpProtocolReceive "WinHttpProtocolReceive" intptr, int64, intptr, int, var
; res = WinHttpProtocolReceive(ProtocolHandle, Flags, pvBuffer, dwBufferLength, pdwBytesRead)
; ProtocolHandle : void* -> "intptr"
; Flags : ULONGLONG -> "int64"
; pvBuffer : void* out -> "intptr"
; dwBufferLength : DWORD -> "int"
; pdwBytesRead : DWORD* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	winhttp = windows.NewLazySystemDLL("WINHTTP.dll")
	procWinHttpProtocolReceive = winhttp.NewProc("WinHttpProtocolReceive")
)

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

extern "winhttp" fn WinHttpProtocolReceive(
    ProtocolHandle: ?*anyopaque, // void*
    Flags: u64, // ULONGLONG
    pvBuffer: ?*anyopaque, // void* out
    dwBufferLength: u32, // DWORD
    pdwBytesRead: [*c]u32 // DWORD* in/out
) callconv(std.os.windows.WINAPI) u32;
proc WinHttpProtocolReceive(
    ProtocolHandle: pointer,  # void*
    Flags: uint64,  # ULONGLONG
    pvBuffer: pointer,  # void* out
    dwBufferLength: uint32,  # DWORD
    pdwBytesRead: ptr uint32  # DWORD* in/out
): uint32 {.importc: "WinHttpProtocolReceive", stdcall, dynlib: "WINHTTP.dll".}
pragma(lib, "winhttp");
extern(Windows)
uint WinHttpProtocolReceive(
    void* ProtocolHandle,   // void*
    ulong Flags,   // ULONGLONG
    void* pvBuffer,   // void* out
    uint dwBufferLength,   // DWORD
    uint* pdwBytesRead   // DWORD* in/out
);
ccall((:WinHttpProtocolReceive, "WINHTTP.dll"), stdcall, UInt32,
      (Ptr{Cvoid}, UInt64, Ptr{Cvoid}, UInt32, Ptr{UInt32}),
      ProtocolHandle, Flags, pvBuffer, dwBufferLength, pdwBytesRead)
# ProtocolHandle : void* -> Ptr{Cvoid}
# Flags : ULONGLONG -> UInt64
# pvBuffer : void* out -> Ptr{Cvoid}
# dwBufferLength : DWORD -> UInt32
# pdwBytesRead : DWORD* in/out -> Ptr{UInt32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t WinHttpProtocolReceive(
    void* ProtocolHandle,
    uint64_t Flags,
    void* pvBuffer,
    uint32_t dwBufferLength,
    uint32_t* pdwBytesRead);
]]
local winhttp = ffi.load("winhttp")
-- winhttp.WinHttpProtocolReceive(ProtocolHandle, Flags, pvBuffer, dwBufferLength, pdwBytesRead)
-- ProtocolHandle : void*
-- Flags : ULONGLONG
-- pvBuffer : void* out
-- dwBufferLength : DWORD
-- pdwBytesRead : DWORD* in/out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('WINHTTP.dll');
const WinHttpProtocolReceive = lib.func('__stdcall', 'WinHttpProtocolReceive', 'uint32_t', ['void *', 'uint64_t', 'void *', 'uint32_t', 'uint32_t *']);
// WinHttpProtocolReceive(ProtocolHandle, Flags, pvBuffer, dwBufferLength, pdwBytesRead)
// ProtocolHandle : void* -> 'void *'
// Flags : ULONGLONG -> 'uint64_t'
// pvBuffer : void* out -> 'void *'
// dwBufferLength : DWORD -> 'uint32_t'
// pdwBytesRead : DWORD* in/out -> 'uint32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("WINHTTP.dll", {
  WinHttpProtocolReceive: { parameters: ["pointer", "u64", "pointer", "u32", "pointer"], result: "u32" },
});
// lib.symbols.WinHttpProtocolReceive(ProtocolHandle, Flags, pvBuffer, dwBufferLength, pdwBytesRead)
// ProtocolHandle : void* -> "pointer"
// Flags : ULONGLONG -> "u64"
// pvBuffer : void* out -> "pointer"
// dwBufferLength : DWORD -> "u32"
// pdwBytesRead : DWORD* in/out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t WinHttpProtocolReceive(
    void* ProtocolHandle,
    uint64_t Flags,
    void* pvBuffer,
    uint32_t dwBufferLength,
    uint32_t* pdwBytesRead);
C, "WINHTTP.dll");
// $ffi->WinHttpProtocolReceive(ProtocolHandle, Flags, pvBuffer, dwBufferLength, pdwBytesRead);
// ProtocolHandle : void*
// Flags : ULONGLONG
// pvBuffer : void* out
// dwBufferLength : DWORD
// pdwBytesRead : 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);
    int WinHttpProtocolReceive(
        Pointer ProtocolHandle,   // void*
        long Flags,   // ULONGLONG
        Pointer pvBuffer,   // void* out
        int dwBufferLength,   // DWORD
        IntByReference pdwBytesRead   // DWORD* in/out
    );
}
@[Link("winhttp")]
lib LibWINHTTP
  fun WinHttpProtocolReceive = WinHttpProtocolReceive(
    ProtocolHandle : Void*,   # void*
    Flags : UInt64,   # ULONGLONG
    pvBuffer : Void*,   # void* out
    dwBufferLength : UInt32,   # DWORD
    pdwBytesRead : UInt32*   # DWORD* in/out
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef WinHttpProtocolReceiveNative = Uint32 Function(Pointer<Void>, Uint64, Pointer<Void>, Uint32, Pointer<Uint32>);
typedef WinHttpProtocolReceiveDart = int Function(Pointer<Void>, int, Pointer<Void>, int, Pointer<Uint32>);
final WinHttpProtocolReceive = DynamicLibrary.open('WINHTTP.dll')
    .lookupFunction<WinHttpProtocolReceiveNative, WinHttpProtocolReceiveDart>('WinHttpProtocolReceive');
// ProtocolHandle : void* -> Pointer<Void>
// Flags : ULONGLONG -> Uint64
// pvBuffer : void* out -> Pointer<Void>
// dwBufferLength : DWORD -> Uint32
// pdwBytesRead : DWORD* in/out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function WinHttpProtocolReceive(
  ProtocolHandle: Pointer;   // void*
  Flags: UInt64;   // ULONGLONG
  pvBuffer: Pointer;   // void* out
  dwBufferLength: DWORD;   // DWORD
  pdwBytesRead: Pointer   // DWORD* in/out
): DWORD; stdcall;
  external 'WINHTTP.dll' name 'WinHttpProtocolReceive';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "WinHttpProtocolReceive"
  c_WinHttpProtocolReceive :: Ptr () -> Word64 -> Ptr () -> Word32 -> Ptr Word32 -> IO Word32
-- ProtocolHandle : void* -> Ptr ()
-- Flags : ULONGLONG -> Word64
-- pvBuffer : void* out -> Ptr ()
-- dwBufferLength : DWORD -> Word32
-- pdwBytesRead : DWORD* in/out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let winhttpprotocolreceive =
  foreign "WinHttpProtocolReceive"
    ((ptr void) @-> uint64_t @-> (ptr void) @-> uint32_t @-> (ptr uint32_t) @-> returning uint32_t)
(* ProtocolHandle : void* -> (ptr void) *)
(* Flags : ULONGLONG -> uint64_t *)
(* pvBuffer : void* out -> (ptr void) *)
(* dwBufferLength : DWORD -> uint32_t *)
(* pdwBytesRead : 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 ("WinHttpProtocolReceive" win-http-protocol-receive :convention :stdcall) :uint32
  (protocol-handle :pointer)   ; void*
  (flags :uint64)   ; ULONGLONG
  (pv-buffer :pointer)   ; void* out
  (dw-buffer-length :uint32)   ; DWORD
  (pdw-bytes-read :pointer))   ; DWORD* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $WinHttpProtocolReceive = Win32::API::More->new('WINHTTP',
    'DWORD WinHttpProtocolReceive(LPVOID ProtocolHandle, UINT64 Flags, LPVOID pvBuffer, DWORD dwBufferLength, LPVOID pdwBytesRead)');
# my $ret = $WinHttpProtocolReceive->Call($ProtocolHandle, $Flags, $pvBuffer, $dwBufferLength, $pdwBytesRead);
# ProtocolHandle : void* -> LPVOID
# Flags : ULONGLONG -> UINT64
# pvBuffer : void* out -> LPVOID
# dwBufferLength : DWORD -> DWORD
# pdwBytesRead : DWORD* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。