ホーム › Networking.HttpServer › HttpQueryRequestProperty

HttpQueryRequestProperty

関数

個々のHTTPリクエストのプロパティを取得する。

DLLHTTPAPI.dll呼出規約winapi

シグネチャ

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

DWORD HttpQueryRequestProperty(
    HANDLE RequestQueueHandle,
    ULONGLONG Id,
    HTTP_REQUEST_PROPERTY PropertyId,
    const void* Qualifier,   // optional
    DWORD QualifierSize,
    void* Output,   // optional
    DWORD OutputBufferSize,
    DWORD* BytesReturned,   // optional
    OVERLAPPED* Overlapped   // optional
);

パラメーター

名前	型	方向
RequestQueueHandle	HANDLE	in
Id	ULONGLONG	in
PropertyId	HTTP_REQUEST_PROPERTY	in
Qualifier	void*	inoptional
QualifierSize	DWORD	in
Output	void*	outoptional
OutputBufferSize	DWORD	in
BytesReturned	DWORD*	outoptional
Overlapped	OVERLAPPED*	inoptional

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD HttpQueryRequestProperty(
    HANDLE RequestQueueHandle,
    ULONGLONG Id,
    HTTP_REQUEST_PROPERTY PropertyId,
    const void* Qualifier,   // optional
    DWORD QualifierSize,
    void* Output,   // optional
    DWORD OutputBufferSize,
    DWORD* BytesReturned,   // optional
    OVERLAPPED* Overlapped   // optional
);

[DllImport("HTTPAPI.dll", ExactSpelling = true)]
static extern uint HttpQueryRequestProperty(
    IntPtr RequestQueueHandle,   // HANDLE
    ulong Id,   // ULONGLONG
    int PropertyId,   // HTTP_REQUEST_PROPERTY
    IntPtr Qualifier,   // void* optional
    uint QualifierSize,   // DWORD
    IntPtr Output,   // void* optional, out
    uint OutputBufferSize,   // DWORD
    IntPtr BytesReturned,   // DWORD* optional, out
    IntPtr Overlapped   // OVERLAPPED* optional
);

<DllImport("HTTPAPI.dll", ExactSpelling:=True)>
Public Shared Function HttpQueryRequestProperty(
    RequestQueueHandle As IntPtr,   ' HANDLE
    Id As ULong,   ' ULONGLONG
    PropertyId As Integer,   ' HTTP_REQUEST_PROPERTY
    Qualifier As IntPtr,   ' void* optional
    QualifierSize As UInteger,   ' DWORD
    Output As IntPtr,   ' void* optional, out
    OutputBufferSize As UInteger,   ' DWORD
    BytesReturned As IntPtr,   ' DWORD* optional, out
    Overlapped As IntPtr   ' OVERLAPPED* optional
) As UInteger
End Function

' RequestQueueHandle : HANDLE
' Id : ULONGLONG
' PropertyId : HTTP_REQUEST_PROPERTY
' Qualifier : void* optional
' QualifierSize : DWORD
' Output : void* optional, out
' OutputBufferSize : DWORD
' BytesReturned : DWORD* optional, out
' Overlapped : OVERLAPPED* optional
Declare PtrSafe Function HttpQueryRequestProperty Lib "httpapi" ( _
    ByVal RequestQueueHandle As LongPtr, _
    ByVal Id As LongLong, _
    ByVal PropertyId As Long, _
    ByVal Qualifier As LongPtr, _
    ByVal QualifierSize As Long, _
    ByVal Output As LongPtr, _
    ByVal OutputBufferSize 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

HttpQueryRequestProperty = ctypes.windll.httpapi.HttpQueryRequestProperty
HttpQueryRequestProperty.restype = wintypes.DWORD
HttpQueryRequestProperty.argtypes = [
    wintypes.HANDLE,  # RequestQueueHandle : HANDLE
    ctypes.c_ulonglong,  # Id : ULONGLONG
    ctypes.c_int,  # PropertyId : HTTP_REQUEST_PROPERTY
    ctypes.POINTER(None),  # Qualifier : void* optional
    wintypes.DWORD,  # QualifierSize : DWORD
    ctypes.POINTER(None),  # Output : void* optional, out
    wintypes.DWORD,  # OutputBufferSize : DWORD
    ctypes.POINTER(wintypes.DWORD),  # BytesReturned : DWORD* optional, out
    ctypes.c_void_p,  # Overlapped : OVERLAPPED* optional
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('HTTPAPI.dll')
HttpQueryRequestProperty = Fiddle::Function.new(
  lib['HttpQueryRequestProperty'],
  [
    Fiddle::TYPE_VOIDP,  # RequestQueueHandle : HANDLE
    -Fiddle::TYPE_LONG_LONG,  # Id : ULONGLONG
    Fiddle::TYPE_INT,  # PropertyId : HTTP_REQUEST_PROPERTY
    Fiddle::TYPE_VOIDP,  # Qualifier : void* optional
    -Fiddle::TYPE_INT,  # QualifierSize : DWORD
    Fiddle::TYPE_VOIDP,  # Output : void* optional, out
    -Fiddle::TYPE_INT,  # OutputBufferSize : DWORD
    Fiddle::TYPE_VOIDP,  # BytesReturned : DWORD* optional, out
    Fiddle::TYPE_VOIDP,  # Overlapped : OVERLAPPED* optional
  ],
  -Fiddle::TYPE_INT)

#[link(name = "httpapi")]
extern "system" {
    fn HttpQueryRequestProperty(
        RequestQueueHandle: *mut core::ffi::c_void,  // HANDLE
        Id: u64,  // ULONGLONG
        PropertyId: i32,  // HTTP_REQUEST_PROPERTY
        Qualifier: *const (),  // void* optional
        QualifierSize: u32,  // DWORD
        Output: *mut (),  // void* optional, out
        OutputBufferSize: u32,  // DWORD
        BytesReturned: *mut u32,  // DWORD* optional, out
        Overlapped: *mut OVERLAPPED  // OVERLAPPED* optional
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("HTTPAPI.dll")]
public static extern uint HttpQueryRequestProperty(IntPtr RequestQueueHandle, ulong Id, int PropertyId, IntPtr Qualifier, uint QualifierSize, IntPtr Output, uint OutputBufferSize, IntPtr BytesReturned, IntPtr Overlapped);
"@
$api = Add-Type -MemberDefinition $sig -Name 'HTTPAPI_HttpQueryRequestProperty' -Namespace Win32 -PassThru
# $api::HttpQueryRequestProperty(RequestQueueHandle, Id, PropertyId, Qualifier, QualifierSize, Output, OutputBufferSize, BytesReturned, Overlapped)

#uselib "HTTPAPI.dll"
#func global HttpQueryRequestProperty "HttpQueryRequestProperty" sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr
; HttpQueryRequestProperty RequestQueueHandle, Id, PropertyId, Qualifier, QualifierSize, Output, OutputBufferSize, varptr(BytesReturned), varptr(Overlapped)   ; 戻り値は stat
; RequestQueueHandle : HANDLE -> "sptr"
; Id : ULONGLONG -> "sptr"
; PropertyId : HTTP_REQUEST_PROPERTY -> "sptr"
; Qualifier : void* optional -> "sptr"
; QualifierSize : DWORD -> "sptr"
; Output : void* optional, out -> "sptr"
; OutputBufferSize : DWORD -> "sptr"
; BytesReturned : DWORD* optional, out -> "sptr"
; Overlapped : OVERLAPPED* optional -> "sptr"
; ※HSP3.7は int64 引数(64bit値渡し)に非対応です。
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "HTTPAPI.dll"
#cfunc global HttpQueryRequestProperty "HttpQueryRequestProperty" sptr, int64, int, sptr, int, sptr, int, var, var
; res = HttpQueryRequestProperty(RequestQueueHandle, Id, PropertyId, Qualifier, QualifierSize, Output, OutputBufferSize, BytesReturned, Overlapped)
; RequestQueueHandle : HANDLE -> "sptr"
; Id : ULONGLONG -> "int64"
; PropertyId : HTTP_REQUEST_PROPERTY -> "int"
; Qualifier : void* optional -> "sptr"
; QualifierSize : DWORD -> "int"
; Output : void* optional, out -> "sptr"
; OutputBufferSize : DWORD -> "int"
; BytesReturned : DWORD* optional, out -> "var"
; Overlapped : OVERLAPPED* optional -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
; ※int64 引数の DLL 値渡しは x64 ランタイム(hsp3_64)のみ対応(x86 は未対応)。#uselib "HTTPAPI.dll"
#cfunc global HttpQueryRequestProperty "HttpQueryRequestProperty" sptr, int64, int, sptr, int, sptr, int, sptr, sptr
; res = HttpQueryRequestProperty(RequestQueueHandle, Id, PropertyId, Qualifier, QualifierSize, Output, OutputBufferSize, varptr(BytesReturned), varptr(Overlapped))
; RequestQueueHandle : HANDLE -> "sptr"
; Id : ULONGLONG -> "int64"
; PropertyId : HTTP_REQUEST_PROPERTY -> "int"
; Qualifier : void* optional -> "sptr"
; QualifierSize : DWORD -> "int"
; Output : void* optional, out -> "sptr"
; OutputBufferSize : DWORD -> "int"
; BytesReturned : DWORD* optional, out -> "sptr"
; Overlapped : OVERLAPPED* optional -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※int64 引数の DLL 値渡しは x64 ランタイム(hsp3_64)のみ対応(x86 は未対応)。

出力引数:

; DWORD HttpQueryRequestProperty(HANDLE RequestQueueHandle, ULONGLONG Id, HTTP_REQUEST_PROPERTY PropertyId, void* Qualifier, DWORD QualifierSize, void* Output, DWORD OutputBufferSize, DWORD* BytesReturned, OVERLAPPED* Overlapped)
#uselib "HTTPAPI.dll"
#cfunc global HttpQueryRequestProperty "HttpQueryRequestProperty" intptr, int64, int, intptr, int, intptr, int, var, var
; res = HttpQueryRequestProperty(RequestQueueHandle, Id, PropertyId, Qualifier, QualifierSize, Output, OutputBufferSize, BytesReturned, Overlapped)
; RequestQueueHandle : HANDLE -> "intptr"
; Id : ULONGLONG -> "int64"
; PropertyId : HTTP_REQUEST_PROPERTY -> "int"
; Qualifier : void* optional -> "intptr"
; QualifierSize : DWORD -> "int"
; Output : void* optional, out -> "intptr"
; OutputBufferSize : DWORD -> "int"
; BytesReturned : DWORD* optional, out -> "var"
; Overlapped : OVERLAPPED* optional -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; DWORD HttpQueryRequestProperty(HANDLE RequestQueueHandle, ULONGLONG Id, HTTP_REQUEST_PROPERTY PropertyId, void* Qualifier, DWORD QualifierSize, void* Output, DWORD OutputBufferSize, DWORD* BytesReturned, OVERLAPPED* Overlapped)
#uselib "HTTPAPI.dll"
#cfunc global HttpQueryRequestProperty "HttpQueryRequestProperty" intptr, int64, int, intptr, int, intptr, int, intptr, intptr
; res = HttpQueryRequestProperty(RequestQueueHandle, Id, PropertyId, Qualifier, QualifierSize, Output, OutputBufferSize, varptr(BytesReturned), varptr(Overlapped))
; RequestQueueHandle : HANDLE -> "intptr"
; Id : ULONGLONG -> "int64"
; PropertyId : HTTP_REQUEST_PROPERTY -> "int"
; Qualifier : void* optional -> "intptr"
; QualifierSize : DWORD -> "int"
; Output : void* optional, out -> "intptr"
; OutputBufferSize : DWORD -> "int"
; BytesReturned : DWORD* optional, out -> "intptr"
; Overlapped : OVERLAPPED* optional -> "intptr"
; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。

import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	httpapi = windows.NewLazySystemDLL("HTTPAPI.dll")
	procHttpQueryRequestProperty = httpapi.NewProc("HttpQueryRequestProperty")
)

// RequestQueueHandle (HANDLE), Id (ULONGLONG), PropertyId (HTTP_REQUEST_PROPERTY), Qualifier (void* optional), QualifierSize (DWORD), Output (void* optional, out), OutputBufferSize (DWORD), BytesReturned (DWORD* optional, out), Overlapped (OVERLAPPED* optional)
r1, _, err := procHttpQueryRequestProperty.Call(
	uintptr(RequestQueueHandle),
	uintptr(Id),
	uintptr(PropertyId),
	uintptr(Qualifier),
	uintptr(QualifierSize),
	uintptr(Output),
	uintptr(OutputBufferSize),
	uintptr(BytesReturned),
	uintptr(Overlapped),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD

function HttpQueryRequestProperty(
  RequestQueueHandle: THandle;   // HANDLE
  Id: UInt64;   // ULONGLONG
  PropertyId: Integer;   // HTTP_REQUEST_PROPERTY
  Qualifier: Pointer;   // void* optional
  QualifierSize: DWORD;   // DWORD
  Output: Pointer;   // void* optional, out
  OutputBufferSize: DWORD;   // DWORD
  BytesReturned: Pointer;   // DWORD* optional, out
  Overlapped: Pointer   // OVERLAPPED* optional
): DWORD; stdcall;
  external 'HTTPAPI.dll' name 'HttpQueryRequestProperty';

result := DllCall("HTTPAPI\HttpQueryRequestProperty"
    , "Ptr", RequestQueueHandle   ; HANDLE
    , "Int64", Id   ; ULONGLONG
    , "Int", PropertyId   ; HTTP_REQUEST_PROPERTY
    , "Ptr", Qualifier   ; void* optional
    , "UInt", QualifierSize   ; DWORD
    , "Ptr", Output   ; void* optional, out
    , "UInt", OutputBufferSize   ; DWORD
    , "Ptr", BytesReturned   ; DWORD* optional, out
    , "Ptr", Overlapped   ; OVERLAPPED* optional
    , "UInt")   ; return: DWORD

●HttpQueryRequestProperty(RequestQueueHandle, Id, PropertyId, Qualifier, QualifierSize, Output, OutputBufferSize, BytesReturned, Overlapped) = DLL("HTTPAPI.dll", "dword HttpQueryRequestProperty(void*, qword, int, void*, dword, void*, dword, void*, void*)")
# 呼び出し: HttpQueryRequestProperty(RequestQueueHandle, Id, PropertyId, Qualifier, QualifierSize, Output, OutputBufferSize, BytesReturned, Overlapped)
# RequestQueueHandle : HANDLE -> "void*"
# Id : ULONGLONG -> "qword"
# PropertyId : HTTP_REQUEST_PROPERTY -> "int"
# Qualifier : void* optional -> "void*"
# QualifierSize : DWORD -> "dword"
# Output : void* optional, out -> "void*"
# OutputBufferSize : DWORD -> "dword"
# BytesReturned : DWORD* optional, out -> "void*"
# Overlapped : OVERLAPPED* optional -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。