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

HttpAddRequestHeadersA

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

シグネチャ

// WININET.dll  (ANSI / -A)
#include <windows.h>

BOOL HttpAddRequestHeadersA(
    void* hRequest,
    LPCSTR lpszHeaders,
    DWORD dwHeadersLength,
    HTTP_ADDREQ_FLAG dwModifiers
);

パラメーター

名前方向説明
hRequestvoid*inHttpOpenRequest 関数の呼び出しによって返されたハンドル。
lpszHeadersLPCSTRinリクエストに追加するヘッダーを含む文字列変数へのポインター。各ヘッダーは 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 リクエストハンドルに追加します。(HttpAddRequestHeadersA)

戻り値

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

解説(Remarks)

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

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

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

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

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

各言語での呼び出し定義

// WININET.dll  (ANSI / -A)
#include <windows.h>

BOOL HttpAddRequestHeadersA(
    void* hRequest,
    LPCSTR lpszHeaders,
    DWORD dwHeadersLength,
    HTTP_ADDREQ_FLAG dwModifiers
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WININET.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool HttpAddRequestHeadersA(
    IntPtr hRequest,   // void*
    [MarshalAs(UnmanagedType.LPStr)] string lpszHeaders,   // LPCSTR
    uint dwHeadersLength,   // DWORD
    uint dwModifiers   // HTTP_ADDREQ_FLAG
);
<DllImport("WININET.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function HttpAddRequestHeadersA(
    hRequest As IntPtr,   ' void*
    <MarshalAs(UnmanagedType.LPStr)> lpszHeaders As String,   ' LPCSTR
    dwHeadersLength As UInteger,   ' DWORD
    dwModifiers As UInteger   ' HTTP_ADDREQ_FLAG
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' hRequest : void*
' lpszHeaders : LPCSTR
' dwHeadersLength : DWORD
' dwModifiers : HTTP_ADDREQ_FLAG
Declare PtrSafe Function HttpAddRequestHeadersA Lib "wininet" ( _
    ByVal hRequest As LongPtr, _
    ByVal lpszHeaders As String, _
    ByVal dwHeadersLength As Long, _
    ByVal dwModifiers As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

HttpAddRequestHeadersA = ctypes.windll.wininet.HttpAddRequestHeadersA
HttpAddRequestHeadersA.restype = wintypes.BOOL
HttpAddRequestHeadersA.argtypes = [
    ctypes.POINTER(None),  # hRequest : void*
    wintypes.LPCSTR,  # lpszHeaders : LPCSTR
    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')
HttpAddRequestHeadersA = Fiddle::Function.new(
  lib['HttpAddRequestHeadersA'],
  [
    Fiddle::TYPE_VOIDP,  # hRequest : void*
    Fiddle::TYPE_VOIDP,  # lpszHeaders : LPCSTR
    -Fiddle::TYPE_INT,  # dwHeadersLength : DWORD
    -Fiddle::TYPE_INT,  # dwModifiers : HTTP_ADDREQ_FLAG
  ],
  Fiddle::TYPE_INT)
#[link(name = "wininet")]
extern "system" {
    fn HttpAddRequestHeadersA(
        hRequest: *mut (),  // void*
        lpszHeaders: *const u8,  // LPCSTR
        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.Ansi, SetLastError = true)]
public static extern bool HttpAddRequestHeadersA(IntPtr hRequest, [MarshalAs(UnmanagedType.LPStr)] string lpszHeaders, uint dwHeadersLength, uint dwModifiers);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WININET_HttpAddRequestHeadersA' -Namespace Win32 -PassThru
# $api::HttpAddRequestHeadersA(hRequest, lpszHeaders, dwHeadersLength, dwModifiers)
#uselib "WININET.dll"
#func global HttpAddRequestHeadersA "HttpAddRequestHeadersA" sptr, sptr, sptr, sptr
; HttpAddRequestHeadersA hRequest, lpszHeaders, dwHeadersLength, dwModifiers   ; 戻り値は stat
; hRequest : void* -> "sptr"
; lpszHeaders : LPCSTR -> "sptr"
; dwHeadersLength : DWORD -> "sptr"
; dwModifiers : HTTP_ADDREQ_FLAG -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "WININET.dll"
#cfunc global HttpAddRequestHeadersA "HttpAddRequestHeadersA" sptr, str, int, int
; res = HttpAddRequestHeadersA(hRequest, lpszHeaders, dwHeadersLength, dwModifiers)
; hRequest : void* -> "sptr"
; lpszHeaders : LPCSTR -> "str"
; dwHeadersLength : DWORD -> "int"
; dwModifiers : HTTP_ADDREQ_FLAG -> "int"
; BOOL HttpAddRequestHeadersA(void* hRequest, LPCSTR lpszHeaders, DWORD dwHeadersLength, HTTP_ADDREQ_FLAG dwModifiers)
#uselib "WININET.dll"
#cfunc global HttpAddRequestHeadersA "HttpAddRequestHeadersA" intptr, str, int, int
; res = HttpAddRequestHeadersA(hRequest, lpszHeaders, dwHeadersLength, dwModifiers)
; hRequest : void* -> "intptr"
; lpszHeaders : LPCSTR -> "str"
; dwHeadersLength : DWORD -> "int"
; dwModifiers : HTTP_ADDREQ_FLAG -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	wininet = windows.NewLazySystemDLL("WININET.dll")
	procHttpAddRequestHeadersA = wininet.NewProc("HttpAddRequestHeadersA")
)

// hRequest (void*), lpszHeaders (LPCSTR), dwHeadersLength (DWORD), dwModifiers (HTTP_ADDREQ_FLAG)
r1, _, err := procHttpAddRequestHeadersA.Call(
	uintptr(hRequest),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(lpszHeaders))),
	uintptr(dwHeadersLength),
	uintptr(dwModifiers),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function HttpAddRequestHeadersA(
  hRequest: Pointer;   // void*
  lpszHeaders: PAnsiChar;   // LPCSTR
  dwHeadersLength: DWORD;   // DWORD
  dwModifiers: DWORD   // HTTP_ADDREQ_FLAG
): BOOL; stdcall;
  external 'WININET.dll' name 'HttpAddRequestHeadersA';
result := DllCall("WININET\HttpAddRequestHeadersA"
    , "Ptr", hRequest   ; void*
    , "AStr", lpszHeaders   ; LPCSTR
    , "UInt", dwHeadersLength   ; DWORD
    , "UInt", dwModifiers   ; HTTP_ADDREQ_FLAG
    , "Int")   ; return: BOOL
●HttpAddRequestHeadersA(hRequest, lpszHeaders, dwHeadersLength, dwModifiers) = DLL("WININET.dll", "bool HttpAddRequestHeadersA(void*, char*, dword, dword)")
# 呼び出し: HttpAddRequestHeadersA(hRequest, lpszHeaders, dwHeadersLength, dwModifiers)
# hRequest : void* -> "void*"
# lpszHeaders : LPCSTR -> "char*"
# dwHeadersLength : DWORD -> "dword"
# dwModifiers : HTTP_ADDREQ_FLAG -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "wininet" fn HttpAddRequestHeadersA(
    hRequest: ?*anyopaque, // void*
    lpszHeaders: [*c]const u8, // LPCSTR
    dwHeadersLength: u32, // DWORD
    dwModifiers: u32 // HTTP_ADDREQ_FLAG
) callconv(std.os.windows.WINAPI) i32;
proc HttpAddRequestHeadersA(
    hRequest: pointer,  # void*
    lpszHeaders: cstring,  # LPCSTR
    dwHeadersLength: uint32,  # DWORD
    dwModifiers: uint32  # HTTP_ADDREQ_FLAG
): int32 {.importc: "HttpAddRequestHeadersA", stdcall, dynlib: "WININET.dll".}
pragma(lib, "wininet");
extern(Windows)
int HttpAddRequestHeadersA(
    void* hRequest,   // void*
    const(char)* lpszHeaders,   // LPCSTR
    uint dwHeadersLength,   // DWORD
    uint dwModifiers   // HTTP_ADDREQ_FLAG
);
ccall((:HttpAddRequestHeadersA, "WININET.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Cstring, UInt32, UInt32),
      hRequest, lpszHeaders, dwHeadersLength, dwModifiers)
# hRequest : void* -> Ptr{Cvoid}
# lpszHeaders : LPCSTR -> Cstring
# dwHeadersLength : DWORD -> UInt32
# dwModifiers : HTTP_ADDREQ_FLAG -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t HttpAddRequestHeadersA(
    void* hRequest,
    const char* lpszHeaders,
    uint32_t dwHeadersLength,
    uint32_t dwModifiers);
]]
local wininet = ffi.load("wininet")
-- wininet.HttpAddRequestHeadersA(hRequest, lpszHeaders, dwHeadersLength, dwModifiers)
-- hRequest : void*
-- lpszHeaders : LPCSTR
-- dwHeadersLength : DWORD
-- dwModifiers : HTTP_ADDREQ_FLAG
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('WININET.dll');
const HttpAddRequestHeadersA = lib.func('__stdcall', 'HttpAddRequestHeadersA', 'int32_t', ['void *', 'str', 'uint32_t', 'uint32_t']);
// HttpAddRequestHeadersA(hRequest, lpszHeaders, dwHeadersLength, dwModifiers)
// hRequest : void* -> 'void *'
// lpszHeaders : LPCSTR -> 'str'
// dwHeadersLength : DWORD -> 'uint32_t'
// dwModifiers : HTTP_ADDREQ_FLAG -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("WININET.dll", {
  HttpAddRequestHeadersA: { parameters: ["pointer", "buffer", "u32", "u32"], result: "i32" },
});
// lib.symbols.HttpAddRequestHeadersA(hRequest, lpszHeaders, dwHeadersLength, dwModifiers)
// hRequest : void* -> "pointer"
// lpszHeaders : LPCSTR -> "buffer"
// dwHeadersLength : DWORD -> "u32"
// dwModifiers : HTTP_ADDREQ_FLAG -> "u32"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t HttpAddRequestHeadersA(
    void* hRequest,
    const char* lpszHeaders,
    uint32_t dwHeadersLength,
    uint32_t dwModifiers);
C, "WININET.dll");
// $ffi->HttpAddRequestHeadersA(hRequest, lpszHeaders, dwHeadersLength, dwModifiers);
// hRequest : void*
// lpszHeaders : LPCSTR
// 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.ASCII_OPTIONS);
    boolean HttpAddRequestHeadersA(
        Pointer hRequest,   // void*
        String lpszHeaders,   // LPCSTR
        int dwHeadersLength,   // DWORD
        int dwModifiers   // HTTP_ADDREQ_FLAG
    );
}
@[Link("wininet")]
lib LibWININET
  fun HttpAddRequestHeadersA = HttpAddRequestHeadersA(
    hRequest : Void*,   # void*
    lpszHeaders : UInt8*,   # LPCSTR
    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 HttpAddRequestHeadersANative = Int32 Function(Pointer<Void>, Pointer<Utf8>, Uint32, Uint32);
typedef HttpAddRequestHeadersADart = int Function(Pointer<Void>, Pointer<Utf8>, int, int);
final HttpAddRequestHeadersA = DynamicLibrary.open('WININET.dll')
    .lookupFunction<HttpAddRequestHeadersANative, HttpAddRequestHeadersADart>('HttpAddRequestHeadersA');
// hRequest : void* -> Pointer<Void>
// lpszHeaders : LPCSTR -> Pointer<Utf8>
// dwHeadersLength : DWORD -> Uint32
// dwModifiers : HTTP_ADDREQ_FLAG -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function HttpAddRequestHeadersA(
  hRequest: Pointer;   // void*
  lpszHeaders: PAnsiChar;   // LPCSTR
  dwHeadersLength: DWORD;   // DWORD
  dwModifiers: DWORD   // HTTP_ADDREQ_FLAG
): BOOL; stdcall;
  external 'WININET.dll' name 'HttpAddRequestHeadersA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let httpaddrequestheadersa =
  foreign "HttpAddRequestHeadersA"
    ((ptr void) @-> string @-> uint32_t @-> uint32_t @-> returning int32_t)
(* hRequest : void* -> (ptr void) *)
(* lpszHeaders : LPCSTR -> string *)
(* 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 ("HttpAddRequestHeadersA" http-add-request-headers-a :convention :stdcall) :int32
  (h-request :pointer)   ; void*
  (lpsz-headers :string)   ; LPCSTR
  (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 $HttpAddRequestHeadersA = Win32::API::More->new('WININET',
    'BOOL HttpAddRequestHeadersA(LPVOID hRequest, LPCSTR lpszHeaders, DWORD dwHeadersLength, DWORD dwModifiers)');
# my $ret = $HttpAddRequestHeadersA->Call($hRequest, $lpszHeaders, $dwHeadersLength, $dwModifiers);
# hRequest : void* -> LPVOID
# lpszHeaders : LPCSTR -> LPCSTR
# dwHeadersLength : DWORD -> DWORD
# dwModifiers : HTTP_ADDREQ_FLAG -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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