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

HttpAddRequestHeadersW

関数
HTTPリクエストに要求ヘッダーを追加する(Unicode版)。
DLLWININET.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

// WININET.dll  (Unicode / -W)
#include <windows.h>

BOOL HttpAddRequestHeadersW(
    void* hRequest,
    LPCWSTR lpszHeaders,
    DWORD dwHeadersLength,
    HTTP_ADDREQ_FLAG dwModifiers
);

パラメーター

名前方向説明
hRequestvoid*inHttpOpenRequest 関数の呼び出しによって返されたハンドル。
lpszHeadersLPCWSTRinリクエストに追加するヘッダーを格納した文字列変数へのポインター。各ヘッダーは CR/LF(キャリッジリターン/ラインフィード)のペアで終了している必要があります。
dwHeadersLengthDWORDinlpszHeaders のサイズ(TCHAR 単位)。このパラメーターが -1L の場合、関数は lpszHeaders がゼロ終端(ASCIIZ)であると見なし、長さを計算します。
dwModifiersHTTP_ADDREQ_FLAGin

この関数の動作を制御する修飾子のセット。このパラメーターには、次の値の組み合わせを指定できます。

意味
HTTP_ADDREQ_FLAG_ADD
ヘッダーが存在しない場合に追加します。HTTP_ADDREQ_FLAG_REPLACE と併用します。
HTTP_ADDREQ_FLAG_ADD_IF_NEW
ヘッダーがまだ存在しない場合にのみ追加します。それ以外の場合はエラーが返されます。
HTTP_ADDREQ_FLAG_COALESCE
同じ名前のヘッダーを結合します。
HTTP_ADDREQ_FLAG_COALESCE_WITH_COMMA
同じ名前のヘッダーをカンマで結合します。たとえば、このフラグを指定して "Accept: text/*" を追加した後に "Accept: audio/*" を追加すると、単一のヘッダー "Accept: text/*, audio/*" が形成されます。これにより、最初に見つかったヘッダーが結合されます。結合されたヘッダーと個別のヘッダーに関して一貫した方式を確保するのは、呼び出し側アプリケーションの責任です。
HTTP_ADDREQ_FLAG_COALESCE_WITH_SEMICOLON
同じ名前のヘッダーをセミコロンで結合します。
HTTP_ADDREQ_FLAG_REPLACE
ヘッダーを置換または削除します。ヘッダー値が空でヘッダーが見つかった場合、そのヘッダーは削除されます。空でない場合は、ヘッダー値が置換されます。

戻り値の型: BOOL

公式ドキュメント

1 つ以上の HTTP リクエストヘッダーを HTTP リクエストハンドルに追加します。(HttpAddRequestHeadersW)

戻り値

成功した場合は TRUE を、それ以外の場合は FALSE を返します。拡張エラー情報を取得するには、 GetLastError を呼び出します。

解説(Remarks)

HttpAddRequestHeaders は、追加の自由形式ヘッダーを HTTP リクエストハンドルに付加します。これは、HTTP サーバーに送信される正確なリクエストを詳細に制御する必要がある高度なクライアントでの使用を想定しています。

基本的な HttpAddRequestHeaders では、アプリケーションは単一のバッファーで複数のヘッダーを渡すことができる点に注意してください。アプリケーションがヘッダーの削除または置換を試みる場合は、 lpszHeaders に指定できるヘッダーは 1 つだけです。

HttpAddRequestHeadersA 関数は、ヘッダーを ANSI 文字ではなく ISO-8859-1 文字として表現します。HttpAddRequestHeadersW 関数は、ヘッダーを ISO-8859-1 文字から UTF-16LE 文字に変換して表現します。そのため、追加するヘッダーに非 ASCII 文字が含まれる可能性がある場合に HttpAddRequestHeadersW 関数を使用することは決して安全ではありません。 その代わりに、アプリケーションは Codepage パラメーターに 28591 を設定した MultiByteToWideChar 関数および WideCharToMultiByte 関数を使用して、ANSI 文字と UTF-16LE 文字の間でマッピングできます。
WinINet API の他のすべての側面と同様に、この関数を DllMain 内、またはグローバルオブジェクトのコンストラクターやデストラクターの中から安全に呼び出すことはできません。
WinINet はサーバー実装をサポートしていません。また、サービスから使用しないでください。サーバー実装またはサービスでは、Microsoft Windows HTTP Services (WinHTTP) を使用してください。
メモ

wininet.h ヘッダーは、UNICODE プリプロセッサー定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして HttpAddRequestHeaders を定義します。エンコード中立のエイリアスの使用を、エンコード中立でないコードと混在させると、コンパイルエラーまたは実行時エラーを引き起こす不一致につながる可能性があります。詳細については、Conventions for Function Prototypes を参照してください。

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

各言語での呼び出し定義

// WININET.dll  (Unicode / -W)
#include <windows.h>

BOOL HttpAddRequestHeadersW(
    void* hRequest,
    LPCWSTR lpszHeaders,
    DWORD dwHeadersLength,
    HTTP_ADDREQ_FLAG dwModifiers
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WININET.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool HttpAddRequestHeadersW(
    IntPtr hRequest,   // void*
    [MarshalAs(UnmanagedType.LPWStr)] string lpszHeaders,   // LPCWSTR
    uint dwHeadersLength,   // DWORD
    uint dwModifiers   // HTTP_ADDREQ_FLAG
);
<DllImport("WININET.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function HttpAddRequestHeadersW(
    hRequest As IntPtr,   ' void*
    <MarshalAs(UnmanagedType.LPWStr)> lpszHeaders As String,   ' LPCWSTR
    dwHeadersLength As UInteger,   ' DWORD
    dwModifiers As UInteger   ' HTTP_ADDREQ_FLAG
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' hRequest : void*
' lpszHeaders : LPCWSTR
' dwHeadersLength : DWORD
' dwModifiers : HTTP_ADDREQ_FLAG
Declare PtrSafe Function HttpAddRequestHeadersW Lib "wininet" ( _
    ByVal hRequest As LongPtr, _
    ByVal lpszHeaders As LongPtr, _
    ByVal dwHeadersLength As Long, _
    ByVal dwModifiers As Long) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

HttpAddRequestHeadersW = ctypes.windll.wininet.HttpAddRequestHeadersW
HttpAddRequestHeadersW.restype = wintypes.BOOL
HttpAddRequestHeadersW.argtypes = [
    ctypes.POINTER(None),  # hRequest : void*
    wintypes.LPCWSTR,  # lpszHeaders : LPCWSTR
    wintypes.DWORD,  # dwHeadersLength : DWORD
    wintypes.DWORD,  # dwModifiers : HTTP_ADDREQ_FLAG
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WININET.dll')
HttpAddRequestHeadersW = Fiddle::Function.new(
  lib['HttpAddRequestHeadersW'],
  [
    Fiddle::TYPE_VOIDP,  # hRequest : void*
    Fiddle::TYPE_VOIDP,  # lpszHeaders : LPCWSTR
    -Fiddle::TYPE_INT,  # dwHeadersLength : DWORD
    -Fiddle::TYPE_INT,  # dwModifiers : HTTP_ADDREQ_FLAG
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "wininet")]
extern "system" {
    fn HttpAddRequestHeadersW(
        hRequest: *mut (),  // void*
        lpszHeaders: *const u16,  // LPCWSTR
        dwHeadersLength: u32,  // DWORD
        dwModifiers: u32  // HTTP_ADDREQ_FLAG
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WININET.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern bool HttpAddRequestHeadersW(IntPtr hRequest, [MarshalAs(UnmanagedType.LPWStr)] string lpszHeaders, uint dwHeadersLength, uint dwModifiers);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WININET_HttpAddRequestHeadersW' -Namespace Win32 -PassThru
# $api::HttpAddRequestHeadersW(hRequest, lpszHeaders, dwHeadersLength, dwModifiers)
#uselib "WININET.dll"
#func global HttpAddRequestHeadersW "HttpAddRequestHeadersW" wptr, wptr, wptr, wptr
; HttpAddRequestHeadersW hRequest, lpszHeaders, dwHeadersLength, dwModifiers   ; 戻り値は stat
; hRequest : void* -> "wptr"
; lpszHeaders : LPCWSTR -> "wptr"
; dwHeadersLength : DWORD -> "wptr"
; dwModifiers : HTTP_ADDREQ_FLAG -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "WININET.dll"
#cfunc global HttpAddRequestHeadersW "HttpAddRequestHeadersW" sptr, wstr, int, int
; res = HttpAddRequestHeadersW(hRequest, lpszHeaders, dwHeadersLength, dwModifiers)
; hRequest : void* -> "sptr"
; lpszHeaders : LPCWSTR -> "wstr"
; dwHeadersLength : DWORD -> "int"
; dwModifiers : HTTP_ADDREQ_FLAG -> "int"
; BOOL HttpAddRequestHeadersW(void* hRequest, LPCWSTR lpszHeaders, DWORD dwHeadersLength, HTTP_ADDREQ_FLAG dwModifiers)
#uselib "WININET.dll"
#cfunc global HttpAddRequestHeadersW "HttpAddRequestHeadersW" intptr, wstr, int, int
; res = HttpAddRequestHeadersW(hRequest, lpszHeaders, dwHeadersLength, dwModifiers)
; hRequest : void* -> "intptr"
; lpszHeaders : LPCWSTR -> "wstr"
; dwHeadersLength : DWORD -> "int"
; dwModifiers : HTTP_ADDREQ_FLAG -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	wininet = windows.NewLazySystemDLL("WININET.dll")
	procHttpAddRequestHeadersW = wininet.NewProc("HttpAddRequestHeadersW")
)

// hRequest (void*), lpszHeaders (LPCWSTR), dwHeadersLength (DWORD), dwModifiers (HTTP_ADDREQ_FLAG)
r1, _, err := procHttpAddRequestHeadersW.Call(
	uintptr(hRequest),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpszHeaders))),
	uintptr(dwHeadersLength),
	uintptr(dwModifiers),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function HttpAddRequestHeadersW(
  hRequest: Pointer;   // void*
  lpszHeaders: PWideChar;   // LPCWSTR
  dwHeadersLength: DWORD;   // DWORD
  dwModifiers: DWORD   // HTTP_ADDREQ_FLAG
): BOOL; stdcall;
  external 'WININET.dll' name 'HttpAddRequestHeadersW';
result := DllCall("WININET\HttpAddRequestHeadersW"
    , "Ptr", hRequest   ; void*
    , "WStr", lpszHeaders   ; LPCWSTR
    , "UInt", dwHeadersLength   ; DWORD
    , "UInt", dwModifiers   ; HTTP_ADDREQ_FLAG
    , "Int")   ; return: BOOL
●HttpAddRequestHeadersW(hRequest, lpszHeaders, dwHeadersLength, dwModifiers) = DLL("WININET.dll", "bool HttpAddRequestHeadersW(void*, char*, dword, dword)")
# 呼び出し: HttpAddRequestHeadersW(hRequest, lpszHeaders, dwHeadersLength, dwModifiers)
# hRequest : void* -> "void*"
# lpszHeaders : LPCWSTR -> "char*"
# dwHeadersLength : DWORD -> "dword"
# dwModifiers : HTTP_ADDREQ_FLAG -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "wininet" fn HttpAddRequestHeadersW(
    hRequest: ?*anyopaque, // void*
    lpszHeaders: [*c]const u16, // LPCWSTR
    dwHeadersLength: u32, // DWORD
    dwModifiers: u32 // HTTP_ADDREQ_FLAG
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc HttpAddRequestHeadersW(
    hRequest: pointer,  # void*
    lpszHeaders: WideCString,  # LPCWSTR
    dwHeadersLength: uint32,  # DWORD
    dwModifiers: uint32  # HTTP_ADDREQ_FLAG
): int32 {.importc: "HttpAddRequestHeadersW", stdcall, dynlib: "WININET.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "wininet");
extern(Windows)
int HttpAddRequestHeadersW(
    void* hRequest,   // void*
    const(wchar)* lpszHeaders,   // LPCWSTR
    uint dwHeadersLength,   // DWORD
    uint dwModifiers   // HTTP_ADDREQ_FLAG
);
ccall((:HttpAddRequestHeadersW, "WININET.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Cwstring, UInt32, UInt32),
      hRequest, lpszHeaders, dwHeadersLength, dwModifiers)
# hRequest : void* -> Ptr{Cvoid}
# lpszHeaders : LPCWSTR -> Cwstring
# dwHeadersLength : DWORD -> UInt32
# dwModifiers : HTTP_ADDREQ_FLAG -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t HttpAddRequestHeadersW(
    void* hRequest,
    const uint16_t* lpszHeaders,
    uint32_t dwHeadersLength,
    uint32_t dwModifiers);
]]
local wininet = ffi.load("wininet")
-- wininet.HttpAddRequestHeadersW(hRequest, lpszHeaders, dwHeadersLength, dwModifiers)
-- hRequest : void*
-- lpszHeaders : LPCWSTR
-- dwHeadersLength : DWORD
-- dwModifiers : HTTP_ADDREQ_FLAG
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('WININET.dll');
const HttpAddRequestHeadersW = lib.func('__stdcall', 'HttpAddRequestHeadersW', 'int32_t', ['void *', 'str16', 'uint32_t', 'uint32_t']);
// HttpAddRequestHeadersW(hRequest, lpszHeaders, dwHeadersLength, dwModifiers)
// hRequest : void* -> 'void *'
// lpszHeaders : LPCWSTR -> 'str16'
// dwHeadersLength : DWORD -> 'uint32_t'
// dwModifiers : HTTP_ADDREQ_FLAG -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("WININET.dll", {
  HttpAddRequestHeadersW: { parameters: ["pointer", "buffer", "u32", "u32"], result: "i32" },
});
// lib.symbols.HttpAddRequestHeadersW(hRequest, lpszHeaders, dwHeadersLength, dwModifiers)
// hRequest : void* -> "pointer"
// lpszHeaders : LPCWSTR -> "buffer"
// dwHeadersLength : DWORD -> "u32"
// dwModifiers : HTTP_ADDREQ_FLAG -> "u32"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t HttpAddRequestHeadersW(
    void* hRequest,
    const uint16_t* lpszHeaders,
    uint32_t dwHeadersLength,
    uint32_t dwModifiers);
C, "WININET.dll");
// $ffi->HttpAddRequestHeadersW(hRequest, lpszHeaders, dwHeadersLength, dwModifiers);
// hRequest : void*
// lpszHeaders : LPCWSTR
// dwHeadersLength : DWORD
// dwModifiers : HTTP_ADDREQ_FLAG
// 構造体/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 Wininet extends StdCallLibrary {
    Wininet INSTANCE = Native.load("wininet", Wininet.class, W32APIOptions.UNICODE_OPTIONS);
    boolean HttpAddRequestHeadersW(
        Pointer hRequest,   // void*
        WString lpszHeaders,   // LPCWSTR
        int dwHeadersLength,   // DWORD
        int dwModifiers   // HTTP_ADDREQ_FLAG
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("wininet")]
lib LibWININET
  fun HttpAddRequestHeadersW = HttpAddRequestHeadersW(
    hRequest : Void*,   # void*
    lpszHeaders : UInt16*,   # LPCWSTR
    dwHeadersLength : UInt32,   # DWORD
    dwModifiers : UInt32   # HTTP_ADDREQ_FLAG
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef HttpAddRequestHeadersWNative = Int32 Function(Pointer<Void>, Pointer<Utf16>, Uint32, Uint32);
typedef HttpAddRequestHeadersWDart = int Function(Pointer<Void>, Pointer<Utf16>, int, int);
final HttpAddRequestHeadersW = DynamicLibrary.open('WININET.dll')
    .lookupFunction<HttpAddRequestHeadersWNative, HttpAddRequestHeadersWDart>('HttpAddRequestHeadersW');
// hRequest : void* -> Pointer<Void>
// lpszHeaders : LPCWSTR -> Pointer<Utf16>
// dwHeadersLength : DWORD -> Uint32
// dwModifiers : HTTP_ADDREQ_FLAG -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function HttpAddRequestHeadersW(
  hRequest: Pointer;   // void*
  lpszHeaders: PWideChar;   // LPCWSTR
  dwHeadersLength: DWORD;   // DWORD
  dwModifiers: DWORD   // HTTP_ADDREQ_FLAG
): BOOL; stdcall;
  external 'WININET.dll' name 'HttpAddRequestHeadersW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "HttpAddRequestHeadersW"
  c_HttpAddRequestHeadersW :: Ptr () -> CWString -> Word32 -> Word32 -> IO CInt
-- hRequest : void* -> Ptr ()
-- lpszHeaders : LPCWSTR -> CWString
-- dwHeadersLength : DWORD -> Word32
-- dwModifiers : HTTP_ADDREQ_FLAG -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let httpaddrequestheadersw =
  foreign "HttpAddRequestHeadersW"
    ((ptr void) @-> (ptr uint16_t) @-> uint32_t @-> uint32_t @-> returning int32_t)
(* hRequest : void* -> (ptr void) *)
(* lpszHeaders : LPCWSTR -> (ptr uint16_t) *)
(* dwHeadersLength : DWORD -> uint32_t *)
(* dwModifiers : HTTP_ADDREQ_FLAG -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library wininet (t "WININET.dll"))
(cffi:use-foreign-library wininet)

(cffi:defcfun ("HttpAddRequestHeadersW" http-add-request-headers-w :convention :stdcall) :int32
  (h-request :pointer)   ; void*
  (lpsz-headers (:string :encoding :utf-16le))   ; LPCWSTR
  (dw-headers-length :uint32)   ; DWORD
  (dw-modifiers :uint32))   ; HTTP_ADDREQ_FLAG
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $HttpAddRequestHeadersW = Win32::API::More->new('WININET',
    'BOOL HttpAddRequestHeadersW(LPVOID hRequest, LPCWSTR lpszHeaders, DWORD dwHeadersLength, DWORD dwModifiers)');
# my $ret = $HttpAddRequestHeadersW->Call($hRequest, $lpszHeaders, $dwHeadersLength, $dwModifiers);
# hRequest : void* -> LPVOID
# lpszHeaders : LPCWSTR -> LPCWSTR
# dwHeadersLength : DWORD -> DWORD
# dwModifiers : HTTP_ADDREQ_FLAG -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い
使用する型