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

HttpReceiveHttpRequest

関数
キューからHTTPリクエストを受信する。
DLLHTTPAPI.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

DWORD HttpReceiveHttpRequest(
    HANDLE RequestQueueHandle,
    ULONGLONG RequestId,
    HTTP_RECEIVE_HTTP_REQUEST_FLAGS Flags,
    HTTP_REQUEST_V2* RequestBuffer,
    DWORD RequestBufferLength,
    DWORD* BytesReturned,   // optional
    OVERLAPPED* Overlapped   // optional
);

パラメーター

名前方向
RequestQueueHandleHANDLEin
RequestIdULONGLONGin
FlagsHTTP_RECEIVE_HTTP_REQUEST_FLAGSin
RequestBufferHTTP_REQUEST_V2*out
RequestBufferLengthDWORDin
BytesReturnedDWORD*outoptional
OverlappedOVERLAPPED*inoutoptional

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD HttpReceiveHttpRequest(
    HANDLE RequestQueueHandle,
    ULONGLONG RequestId,
    HTTP_RECEIVE_HTTP_REQUEST_FLAGS Flags,
    HTTP_REQUEST_V2* RequestBuffer,
    DWORD RequestBufferLength,
    DWORD* BytesReturned,   // optional
    OVERLAPPED* Overlapped   // optional
);
[DllImport("HTTPAPI.dll", ExactSpelling = true)]
static extern uint HttpReceiveHttpRequest(
    IntPtr RequestQueueHandle,   // HANDLE
    ulong RequestId,   // ULONGLONG
    uint Flags,   // HTTP_RECEIVE_HTTP_REQUEST_FLAGS
    IntPtr RequestBuffer,   // HTTP_REQUEST_V2* out
    uint RequestBufferLength,   // DWORD
    IntPtr BytesReturned,   // DWORD* optional, out
    IntPtr Overlapped   // OVERLAPPED* optional, in/out
);
<DllImport("HTTPAPI.dll", ExactSpelling:=True)>
Public Shared Function HttpReceiveHttpRequest(
    RequestQueueHandle As IntPtr,   ' HANDLE
    RequestId As ULong,   ' ULONGLONG
    Flags As UInteger,   ' HTTP_RECEIVE_HTTP_REQUEST_FLAGS
    RequestBuffer As IntPtr,   ' HTTP_REQUEST_V2* out
    RequestBufferLength As UInteger,   ' DWORD
    BytesReturned As IntPtr,   ' DWORD* optional, out
    Overlapped As IntPtr   ' OVERLAPPED* optional, in/out
) As UInteger
End Function
' RequestQueueHandle : HANDLE
' RequestId : ULONGLONG
' Flags : HTTP_RECEIVE_HTTP_REQUEST_FLAGS
' RequestBuffer : HTTP_REQUEST_V2* out
' RequestBufferLength : DWORD
' BytesReturned : DWORD* optional, out
' Overlapped : OVERLAPPED* optional, in/out
Declare PtrSafe Function HttpReceiveHttpRequest Lib "httpapi" ( _
    ByVal RequestQueueHandle As LongPtr, _
    ByVal RequestId As LongLong, _
    ByVal Flags As Long, _
    ByVal RequestBuffer As LongPtr, _
    ByVal RequestBufferLength As Long, _
    ByVal BytesReturned As LongPtr, _
    ByVal Overlapped As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

HttpReceiveHttpRequest = ctypes.windll.httpapi.HttpReceiveHttpRequest
HttpReceiveHttpRequest.restype = wintypes.DWORD
HttpReceiveHttpRequest.argtypes = [
    wintypes.HANDLE,  # RequestQueueHandle : HANDLE
    ctypes.c_ulonglong,  # RequestId : ULONGLONG
    wintypes.DWORD,  # Flags : HTTP_RECEIVE_HTTP_REQUEST_FLAGS
    ctypes.c_void_p,  # RequestBuffer : HTTP_REQUEST_V2* out
    wintypes.DWORD,  # RequestBufferLength : DWORD
    ctypes.POINTER(wintypes.DWORD),  # BytesReturned : DWORD* optional, out
    ctypes.c_void_p,  # Overlapped : OVERLAPPED* optional, in/out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	httpapi = windows.NewLazySystemDLL("HTTPAPI.dll")
	procHttpReceiveHttpRequest = httpapi.NewProc("HttpReceiveHttpRequest")
)

// RequestQueueHandle (HANDLE), RequestId (ULONGLONG), Flags (HTTP_RECEIVE_HTTP_REQUEST_FLAGS), RequestBuffer (HTTP_REQUEST_V2* out), RequestBufferLength (DWORD), BytesReturned (DWORD* optional, out), Overlapped (OVERLAPPED* optional, in/out)
r1, _, err := procHttpReceiveHttpRequest.Call(
	uintptr(RequestQueueHandle),
	uintptr(RequestId),
	uintptr(Flags),
	uintptr(RequestBuffer),
	uintptr(RequestBufferLength),
	uintptr(BytesReturned),
	uintptr(Overlapped),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function HttpReceiveHttpRequest(
  RequestQueueHandle: THandle;   // HANDLE
  RequestId: UInt64;   // ULONGLONG
  Flags: DWORD;   // HTTP_RECEIVE_HTTP_REQUEST_FLAGS
  RequestBuffer: Pointer;   // HTTP_REQUEST_V2* out
  RequestBufferLength: DWORD;   // DWORD
  BytesReturned: Pointer;   // DWORD* optional, out
  Overlapped: Pointer   // OVERLAPPED* optional, in/out
): DWORD; stdcall;
  external 'HTTPAPI.dll' name 'HttpReceiveHttpRequest';
result := DllCall("HTTPAPI\HttpReceiveHttpRequest"
    , "Ptr", RequestQueueHandle   ; HANDLE
    , "Int64", RequestId   ; ULONGLONG
    , "UInt", Flags   ; HTTP_RECEIVE_HTTP_REQUEST_FLAGS
    , "Ptr", RequestBuffer   ; HTTP_REQUEST_V2* out
    , "UInt", RequestBufferLength   ; DWORD
    , "Ptr", BytesReturned   ; DWORD* optional, out
    , "Ptr", Overlapped   ; OVERLAPPED* optional, in/out
    , "UInt")   ; return: DWORD
●HttpReceiveHttpRequest(RequestQueueHandle, RequestId, Flags, RequestBuffer, RequestBufferLength, BytesReturned, Overlapped) = DLL("HTTPAPI.dll", "dword HttpReceiveHttpRequest(void*, qword, dword, void*, dword, void*, void*)")
# 呼び出し: HttpReceiveHttpRequest(RequestQueueHandle, RequestId, Flags, RequestBuffer, RequestBufferLength, BytesReturned, Overlapped)
# RequestQueueHandle : HANDLE -> "void*"
# RequestId : ULONGLONG -> "qword"
# Flags : HTTP_RECEIVE_HTTP_REQUEST_FLAGS -> "dword"
# RequestBuffer : HTTP_REQUEST_V2* out -> "void*"
# RequestBufferLength : DWORD -> "dword"
# BytesReturned : DWORD* optional, out -> "void*"
# Overlapped : OVERLAPPED* optional, in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。