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

HttpSetRequestProperty

関数
個々のHTTPリクエストのプロパティを設定する。
DLLHTTPAPI.dll呼出規約winapi

シグネチャ

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

DWORD HttpSetRequestProperty(
    HANDLE RequestQueueHandle,
    ULONGLONG Id,
    HTTP_REQUEST_PROPERTY PropertyId,
    void* Input,   // optional
    DWORD InputPropertySize,
    OVERLAPPED* Overlapped
);

パラメーター

名前方向説明
RequestQueueHandleHANDLEinリクエストを受信したリクエストキューへのハンドル。リクエストキューは HttpCreateRequestQueue 関数の呼び出しによって作成され、そのハンドルが返されます。
IdULONGLONGinリクエストの不透明な ID。この ID は、HttpReceiveHttpRequest が返す HTTP_REQUEST 構造体の RequestId メンバーにあります。
PropertyIdHTTP_REQUEST_PROPERTYin

設定するプロパティの種類を表す HTTP_REQUEST_PROPERTY 列挙体のメンバー。次のいずれかである必要があります。

| Property | 意味 | | HttpRequestPropertyStreamError | リクエストにストリームエラーを設定します。 |

Inputvoid*inoptional

プロパティ情報を含むバッファーへのポインター。

設定するプロパティに応じて、次のプロパティ情報型のいずれかを指す必要があります。

| Property | 構成型 | | HttpRequestPropertyStreamError | HTTP_REQUEST_PROPERTY_STREAM_ERROR 構造体 |

InputPropertySizeDWORDinInput パラメーターが指すバッファーの長さ(バイト単位)。
OverlappedOVERLAPPED*in

非同期呼び出しの場合は、pOverlappedOVERLAPPED 構造体を指すように設定します。同期呼び出しの場合は NULL に設定します。

同期呼び出しは操作が完了するまでブロックされますが、非同期呼び出しは直ちに ERROR_IO_PENDING を返し、呼び出し元のアプリケーションは GetOverlappedResult または I/O 完了ポートを使用して操作が完了したタイミングを判断します。同期に OVERLAPPED 構造体を使用する方法の詳細については、Synchronization and Overlapped Input and Output を参照してください。

戻り値の型: DWORD

公式ドキュメント

指定したリクエストに新しいプロパティを設定するか、既存のプロパティを変更します。

戻り値

関数が成功した場合は ERROR_SUCCESS を返します。

関数が失敗した場合は システムエラーコード を返します。

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

各言語での呼び出し定義

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

DWORD HttpSetRequestProperty(
    HANDLE RequestQueueHandle,
    ULONGLONG Id,
    HTTP_REQUEST_PROPERTY PropertyId,
    void* Input,   // optional
    DWORD InputPropertySize,
    OVERLAPPED* Overlapped
);
[DllImport("HTTPAPI.dll", ExactSpelling = true)]
static extern uint HttpSetRequestProperty(
    IntPtr RequestQueueHandle,   // HANDLE
    ulong Id,   // ULONGLONG
    int PropertyId,   // HTTP_REQUEST_PROPERTY
    IntPtr Input,   // void* optional
    uint InputPropertySize,   // DWORD
    IntPtr Overlapped   // OVERLAPPED*
);
<DllImport("HTTPAPI.dll", ExactSpelling:=True)>
Public Shared Function HttpSetRequestProperty(
    RequestQueueHandle As IntPtr,   ' HANDLE
    Id As ULong,   ' ULONGLONG
    PropertyId As Integer,   ' HTTP_REQUEST_PROPERTY
    Input As IntPtr,   ' void* optional
    InputPropertySize As UInteger,   ' DWORD
    Overlapped As IntPtr   ' OVERLAPPED*
) As UInteger
End Function
' RequestQueueHandle : HANDLE
' Id : ULONGLONG
' PropertyId : HTTP_REQUEST_PROPERTY
' Input : void* optional
' InputPropertySize : DWORD
' Overlapped : OVERLAPPED*
Declare PtrSafe Function HttpSetRequestProperty Lib "httpapi" ( _
    ByVal RequestQueueHandle As LongPtr, _
    ByVal Id As LongLong, _
    ByVal PropertyId As Long, _
    ByVal Input As LongPtr, _
    ByVal InputPropertySize As Long, _
    ByVal Overlapped As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

HttpSetRequestProperty = ctypes.windll.httpapi.HttpSetRequestProperty
HttpSetRequestProperty.restype = wintypes.DWORD
HttpSetRequestProperty.argtypes = [
    wintypes.HANDLE,  # RequestQueueHandle : HANDLE
    ctypes.c_ulonglong,  # Id : ULONGLONG
    ctypes.c_int,  # PropertyId : HTTP_REQUEST_PROPERTY
    ctypes.POINTER(None),  # Input : void* optional
    wintypes.DWORD,  # InputPropertySize : DWORD
    ctypes.c_void_p,  # Overlapped : OVERLAPPED*
]
require 'fiddle'
require 'fiddle/import'

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

var (
	httpapi = windows.NewLazySystemDLL("HTTPAPI.dll")
	procHttpSetRequestProperty = httpapi.NewProc("HttpSetRequestProperty")
)

// RequestQueueHandle (HANDLE), Id (ULONGLONG), PropertyId (HTTP_REQUEST_PROPERTY), Input (void* optional), InputPropertySize (DWORD), Overlapped (OVERLAPPED*)
r1, _, err := procHttpSetRequestProperty.Call(
	uintptr(RequestQueueHandle),
	uintptr(Id),
	uintptr(PropertyId),
	uintptr(Input),
	uintptr(InputPropertySize),
	uintptr(Overlapped),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function HttpSetRequestProperty(
  RequestQueueHandle: THandle;   // HANDLE
  Id: UInt64;   // ULONGLONG
  PropertyId: Integer;   // HTTP_REQUEST_PROPERTY
  Input: Pointer;   // void* optional
  InputPropertySize: DWORD;   // DWORD
  Overlapped: Pointer   // OVERLAPPED*
): DWORD; stdcall;
  external 'HTTPAPI.dll' name 'HttpSetRequestProperty';
result := DllCall("HTTPAPI\HttpSetRequestProperty"
    , "Ptr", RequestQueueHandle   ; HANDLE
    , "Int64", Id   ; ULONGLONG
    , "Int", PropertyId   ; HTTP_REQUEST_PROPERTY
    , "Ptr", Input   ; void* optional
    , "UInt", InputPropertySize   ; DWORD
    , "Ptr", Overlapped   ; OVERLAPPED*
    , "UInt")   ; return: DWORD
●HttpSetRequestProperty(RequestQueueHandle, Id, PropertyId, Input, InputPropertySize, Overlapped) = DLL("HTTPAPI.dll", "dword HttpSetRequestProperty(void*, qword, int, void*, dword, void*)")
# 呼び出し: HttpSetRequestProperty(RequestQueueHandle, Id, PropertyId, Input, InputPropertySize, Overlapped)
# RequestQueueHandle : HANDLE -> "void*"
# Id : ULONGLONG -> "qword"
# PropertyId : HTTP_REQUEST_PROPERTY -> "int"
# Input : void* optional -> "void*"
# InputPropertySize : DWORD -> "dword"
# Overlapped : OVERLAPPED* -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef HttpSetRequestPropertyNative = Uint32 Function(Pointer<Void>, Uint64, Int32, Pointer<Void>, Uint32, Pointer<Void>);
typedef HttpSetRequestPropertyDart = int Function(Pointer<Void>, int, int, Pointer<Void>, int, Pointer<Void>);
final HttpSetRequestProperty = DynamicLibrary.open('HTTPAPI.dll')
    .lookupFunction<HttpSetRequestPropertyNative, HttpSetRequestPropertyDart>('HttpSetRequestProperty');
// RequestQueueHandle : HANDLE -> Pointer<Void>
// Id : ULONGLONG -> Uint64
// PropertyId : HTTP_REQUEST_PROPERTY -> Int32
// Input : void* optional -> Pointer<Void>
// InputPropertySize : DWORD -> Uint32
// Overlapped : OVERLAPPED* -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function HttpSetRequestProperty(
  RequestQueueHandle: THandle;   // HANDLE
  Id: UInt64;   // ULONGLONG
  PropertyId: Integer;   // HTTP_REQUEST_PROPERTY
  Input: Pointer;   // void* optional
  InputPropertySize: DWORD;   // DWORD
  Overlapped: Pointer   // OVERLAPPED*
): DWORD; stdcall;
  external 'HTTPAPI.dll' name 'HttpSetRequestProperty';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "HttpSetRequestProperty"
  c_HttpSetRequestProperty :: Ptr () -> Word64 -> Int32 -> Ptr () -> Word32 -> Ptr () -> IO Word32
-- RequestQueueHandle : HANDLE -> Ptr ()
-- Id : ULONGLONG -> Word64
-- PropertyId : HTTP_REQUEST_PROPERTY -> Int32
-- Input : void* optional -> Ptr ()
-- InputPropertySize : DWORD -> Word32
-- Overlapped : OVERLAPPED* -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let httpsetrequestproperty =
  foreign "HttpSetRequestProperty"
    ((ptr void) @-> uint64_t @-> int32_t @-> (ptr void) @-> uint32_t @-> (ptr void) @-> returning uint32_t)
(* RequestQueueHandle : HANDLE -> (ptr void) *)
(* Id : ULONGLONG -> uint64_t *)
(* PropertyId : HTTP_REQUEST_PROPERTY -> int32_t *)
(* Input : void* optional -> (ptr void) *)
(* InputPropertySize : DWORD -> uint32_t *)
(* Overlapped : OVERLAPPED* -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library httpapi (t "HTTPAPI.dll"))
(cffi:use-foreign-library httpapi)

(cffi:defcfun ("HttpSetRequestProperty" http-set-request-property :convention :stdcall) :uint32
  (request-queue-handle :pointer)   ; HANDLE
  (id :uint64)   ; ULONGLONG
  (property-id :int32)   ; HTTP_REQUEST_PROPERTY
  (input :pointer)   ; void* optional
  (input-property-size :uint32)   ; DWORD
  (overlapped :pointer))   ; OVERLAPPED*
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $HttpSetRequestProperty = Win32::API::More->new('HTTPAPI',
    'DWORD HttpSetRequestProperty(HANDLE RequestQueueHandle, UINT64 Id, int PropertyId, LPVOID Input, DWORD InputPropertySize, LPVOID Overlapped)');
# my $ret = $HttpSetRequestProperty->Call($RequestQueueHandle, $Id, $PropertyId, $Input, $InputPropertySize, $Overlapped);
# RequestQueueHandle : HANDLE -> HANDLE
# Id : ULONGLONG -> UINT64
# PropertyId : HTTP_REQUEST_PROPERTY -> int
# Input : void* optional -> LPVOID
# InputPropertySize : DWORD -> DWORD
# Overlapped : OVERLAPPED* -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型