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

WinHttpAddRequestHeadersEx

関数
HTTP要求に拡張形式の要求ヘッダーを追加する。
DLLWINHTTP.dll呼出規約winapi

シグネチャ

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

DWORD WinHttpAddRequestHeadersEx(
    void* hRequest,
    DWORD dwModifiers,
    ULONGLONG ullFlags,
    ULONGLONG ullExtra,
    DWORD cHeaders,
    WINHTTP_EXTENDED_HEADER* pHeaders
);

パラメーター

名前方向説明
hRequestvoid*inoutヘッダーを追加する対象の要求ハンドル。
dwModifiersDWORDin追加/置換などの動作を示すWINHTTP_ADDREQ_FLAG_*フラグ。
ullFlagsULONGLONGin拡張動作を制御するフラグ。通常は0を指定する。
ullExtraULONGLONGinフラグに付随する追加情報。通常は0を指定する。
cHeadersDWORDinpHeaders配列の要素数を指定する。
pHeadersWINHTTP_EXTENDED_HEADER*in追加するヘッダーの配列WINHTTP_EXTENDED_HEADER。

戻り値の型: DWORD

各言語での呼び出し定義

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

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

WinHttpAddRequestHeadersEx = ctypes.windll.winhttp.WinHttpAddRequestHeadersEx
WinHttpAddRequestHeadersEx.restype = wintypes.DWORD
WinHttpAddRequestHeadersEx.argtypes = [
    ctypes.POINTER(None),  # hRequest : void* in/out
    wintypes.DWORD,  # dwModifiers : DWORD
    ctypes.c_ulonglong,  # ullFlags : ULONGLONG
    ctypes.c_ulonglong,  # ullExtra : ULONGLONG
    wintypes.DWORD,  # cHeaders : DWORD
    ctypes.c_void_p,  # pHeaders : WINHTTP_EXTENDED_HEADER*
]
require 'fiddle'
require 'fiddle/import'

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

var (
	winhttp = windows.NewLazySystemDLL("WINHTTP.dll")
	procWinHttpAddRequestHeadersEx = winhttp.NewProc("WinHttpAddRequestHeadersEx")
)

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

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

typedef WinHttpAddRequestHeadersExNative = Uint32 Function(Pointer<Void>, Uint32, Uint64, Uint64, Uint32, Pointer<Void>);
typedef WinHttpAddRequestHeadersExDart = int Function(Pointer<Void>, int, int, int, int, Pointer<Void>);
final WinHttpAddRequestHeadersEx = DynamicLibrary.open('WINHTTP.dll')
    .lookupFunction<WinHttpAddRequestHeadersExNative, WinHttpAddRequestHeadersExDart>('WinHttpAddRequestHeadersEx');
// hRequest : void* in/out -> Pointer<Void>
// dwModifiers : DWORD -> Uint32
// ullFlags : ULONGLONG -> Uint64
// ullExtra : ULONGLONG -> Uint64
// cHeaders : DWORD -> Uint32
// pHeaders : WINHTTP_EXTENDED_HEADER* -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function WinHttpAddRequestHeadersEx(
  hRequest: Pointer;   // void* in/out
  dwModifiers: DWORD;   // DWORD
  ullFlags: UInt64;   // ULONGLONG
  ullExtra: UInt64;   // ULONGLONG
  cHeaders: DWORD;   // DWORD
  pHeaders: Pointer   // WINHTTP_EXTENDED_HEADER*
): DWORD; stdcall;
  external 'WINHTTP.dll' name 'WinHttpAddRequestHeadersEx';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "WinHttpAddRequestHeadersEx"
  c_WinHttpAddRequestHeadersEx :: Ptr () -> Word32 -> Word64 -> Word64 -> Word32 -> Ptr () -> IO Word32
-- hRequest : void* in/out -> Ptr ()
-- dwModifiers : DWORD -> Word32
-- ullFlags : ULONGLONG -> Word64
-- ullExtra : ULONGLONG -> Word64
-- cHeaders : DWORD -> Word32
-- pHeaders : WINHTTP_EXTENDED_HEADER* -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let winhttpaddrequestheadersex =
  foreign "WinHttpAddRequestHeadersEx"
    ((ptr void) @-> uint32_t @-> uint64_t @-> uint64_t @-> uint32_t @-> (ptr void) @-> returning uint32_t)
(* hRequest : void* in/out -> (ptr void) *)
(* dwModifiers : DWORD -> uint32_t *)
(* ullFlags : ULONGLONG -> uint64_t *)
(* ullExtra : ULONGLONG -> uint64_t *)
(* cHeaders : DWORD -> uint32_t *)
(* pHeaders : WINHTTP_EXTENDED_HEADER* -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library winhttp (t "WINHTTP.dll"))
(cffi:use-foreign-library winhttp)

(cffi:defcfun ("WinHttpAddRequestHeadersEx" win-http-add-request-headers-ex :convention :stdcall) :uint32
  (h-request :pointer)   ; void* in/out
  (dw-modifiers :uint32)   ; DWORD
  (ull-flags :uint64)   ; ULONGLONG
  (ull-extra :uint64)   ; ULONGLONG
  (c-headers :uint32)   ; DWORD
  (p-headers :pointer))   ; WINHTTP_EXTENDED_HEADER*
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $WinHttpAddRequestHeadersEx = Win32::API::More->new('WINHTTP',
    'DWORD WinHttpAddRequestHeadersEx(LPVOID hRequest, DWORD dwModifiers, UINT64 ullFlags, UINT64 ullExtra, DWORD cHeaders, LPVOID pHeaders)');
# my $ret = $WinHttpAddRequestHeadersEx->Call($hRequest, $dwModifiers, $ullFlags, $ullExtra, $cHeaders, $pHeaders);
# hRequest : void* in/out -> LPVOID
# dwModifiers : DWORD -> DWORD
# ullFlags : ULONGLONG -> UINT64
# ullExtra : ULONGLONG -> UINT64
# cHeaders : DWORD -> DWORD
# pHeaders : WINHTTP_EXTENDED_HEADER* -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

類似 API
使用する型