WinHttpAddRequestHeaders
関数シグネチャ
// WINHTTP.dll
#include <windows.h>
BOOL WinHttpAddRequestHeaders(
void* hRequest,
LPCWSTR lpszHeaders,
DWORD dwHeadersLength,
DWORD dwModifiers
);パラメーター
| 名前 | 型 | 方向 | 説明 | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| hRequest | void* | inout | WinHttpOpenRequest 関数の呼び出しによって返された HINTERNET ハンドルです。 | ||||||||||||||
| lpszHeaders | LPCWSTR | in | 要求に追加するヘッダーを格納する文字列変数へのポインターです。最後のヘッダーを除く各ヘッダーは、復帰/改行 (CR/LF) で終端する必要があります。 | ||||||||||||||
| dwHeadersLength | DWORD | in | pwszHeaders の長さを文字数で表す unsigned long 整数値です。このパラメーターが -1L の場合、関数は pwszHeaders がゼロ終端 (ASCIIZ) であると見なし、長さを計算します。 | ||||||||||||||
| dwModifiers | DWORD | in | この関数の動作を変更するために使用するフラグを格納する unsigned long 整数値です。次のフラグを 1 つ以上指定できます。
|
戻り値の型: BOOL
公式ドキュメント
1 つ以上の HTTP 要求ヘッダーを HTTP 要求ハンドルに追加します。(WinHttpAddRequestHeaders)
戻り値
成功した場合は TRUE を、それ以外の場合は FALSE を返します。拡張エラー情報を取得するには、GetLastError を呼び出します。返されるエラーコードには次のものがあります。
| エラーコード | 説明 |
|---|---|
| 指定されたハンドルが正しい状態にないため、要求された操作を実行できません。 | |
| 指定されたハンドルの種類がこの操作には正しくありません。 | |
| 内部エラーが発生しました。 | |
| 要求された操作を完了するのに十分なメモリがありませんでした。 |
解説(Remarks)
ヘッダーはリダイレクトをまたいで転送されます。これはセキュリティ上の問題となる可能性があります。リダイレクトの発生時にヘッダーが転送されないようにするには、WINHTTP_STATUS_CALLBACK コールバックを使用して、リダイレクトの発生時に該当するヘッダーを修正します。
WinHTTP を非同期モードで使用している場合 (つまり、WinHttpOpen で WINHTTP_FLAG_ASYNC を設定している場合) でも、この関数は同期的に動作します。戻り値は成功または失敗を示します。拡張エラー情報を取得するには、GetLastError を呼び出します。
WinHttpAddRequestHeaders 関数は、自由形式の追加ヘッダーを HTTP 要求ハンドルに付加します。HTTP サーバーに送信される要求を正確に細かく制御する必要がある高度なクライアントでの使用を想定しています。
この関数で追加された要求ヘッダーの名前と値は検証されます。ヘッダーは正しい形式である必要があります。有効な HTTP ヘッダーの詳細については、RFC 2616 を参照してください。無効なヘッダーが使用された場合、この関数は失敗し、GetLastError は ERROR_INVALID_PARAMETER を返します。無効なヘッダーは追加されません。
Date: 要求ヘッダーを送信する場合は、WinHttpTimeFromSystemTime 関数を使用してヘッダー用の構造を作成できます。
基本的な WinHttpAddRequestHeaders では、アプリケーションは単一のバッファーで複数のヘッダーを渡すことができます。
また、アプリケーションは WinHttpSendRequest を使用して、要求を送信する前に HTTP 要求ハンドルに追加のヘッダーを加えることもできます。
例
次のコード例では、要求に If-Modified-Since ヘッダーを含めています。応答ヘッダーを解釈して、対象ドキュメントが更新されているかどうかを判断します。
DWORD dwSize = sizeof(DWORD);
DWORD dwStatusCode = 0;
BOOL bResults = FALSE;
HINTERNET hSession = NULL,
hConnect = NULL,
hRequest = NULL;
// Use WinHttpOpen to obtain a session handle.
hSession = WinHttpOpen( L"A WinHTTP Example Program/1.0",
WINHTTP_ACCESS_TYPE_DEFAULT_PROXY,
WINHTTP_NO_PROXY_NAME,
WINHTTP_NO_PROXY_BYPASS,
0 );
// Specify an HTTP server.
if( hSession )
hConnect = WinHttpConnect( hSession,
L"www.microsoft.com",
INTERNET_DEFAULT_HTTP_PORT,
0 );
// Create an HTTP Request handle.
if( hConnect )
hRequest = WinHttpOpenRequest( hConnect,
L"GET",
NULL,
NULL,
WINHTTP_NO_REFERER,
WINHTTP_DEFAULT_ACCEPT_TYPES,
0 );
// Add a request header.
if( hRequest )
bResults = WinHttpAddRequestHeaders( hRequest,
L"If-Modified-Since: Mon, 20 Nov 2000 20:00:00 GMT",
(ULONG)-1L,
WINHTTP_ADDREQ_FLAG_ADD );
// Send a Request.
if( bResults )
bResults = WinHttpSendRequest( hRequest,
WINHTTP_NO_ADDITIONAL_HEADERS,
0,
WINHTTP_NO_REQUEST_DATA,
0,
0,
0 );
// End the request.
if( bResults )
bResults = WinHttpReceiveResponse( hRequest, NULL);
// Use WinHttpQueryHeaders to obtain the header buffer.
if( bResults )
bResults = WinHttpQueryHeaders( hRequest,
WINHTTP_QUERY_STATUS_CODE | WINHTTP_QUERY_FLAG_NUMBER,
NULL,
&dwStatusCode,
&dwSize,
WINHTTP_NO_HEADER_INDEX );
// Based on the status code, determine whether
// the document was recently updated.
if( bResults )
{
if( dwStatusCode == 304 )
printf( "Document has not been updated.\n" );
else if( dwStatusCode == 200 )
printf( "Document has been updated.\n" );
else
printf( "Status code = %u.\n",dwStatusCode );
}
// Report any errors.
if( !bResults )
printf( "Error %d has occurred.\n", GetLastError( ) );
// Close open handles.
if( hRequest ) WinHttpCloseHandle( hRequest );
if( hConnect ) WinHttpCloseHandle( hConnect );
if( hSession ) WinHttpCloseHandle( hSession );
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// WINHTTP.dll
#include <windows.h>
BOOL WinHttpAddRequestHeaders(
void* hRequest,
LPCWSTR lpszHeaders,
DWORD dwHeadersLength,
DWORD dwModifiers
);[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WINHTTP.dll", SetLastError = true, ExactSpelling = true)]
static extern bool WinHttpAddRequestHeaders(
IntPtr hRequest, // void* in/out
[MarshalAs(UnmanagedType.LPWStr)] string lpszHeaders, // LPCWSTR
uint dwHeadersLength, // DWORD
uint dwModifiers // DWORD
);<DllImport("WINHTTP.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function WinHttpAddRequestHeaders(
hRequest As IntPtr, ' void* in/out
<MarshalAs(UnmanagedType.LPWStr)> lpszHeaders As String, ' LPCWSTR
dwHeadersLength As UInteger, ' DWORD
dwModifiers As UInteger ' DWORD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function' hRequest : void* in/out
' lpszHeaders : LPCWSTR
' dwHeadersLength : DWORD
' dwModifiers : DWORD
Declare PtrSafe Function WinHttpAddRequestHeaders Lib "winhttp" ( _
ByVal hRequest As LongPtr, _
ByVal lpszHeaders As LongPtr, _
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
WinHttpAddRequestHeaders = ctypes.windll.winhttp.WinHttpAddRequestHeaders
WinHttpAddRequestHeaders.restype = wintypes.BOOL
WinHttpAddRequestHeaders.argtypes = [
ctypes.POINTER(None), # hRequest : void* in/out
wintypes.LPCWSTR, # lpszHeaders : LPCWSTR
wintypes.DWORD, # dwHeadersLength : DWORD
wintypes.DWORD, # dwModifiers : DWORD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('WINHTTP.dll')
WinHttpAddRequestHeaders = Fiddle::Function.new(
lib['WinHttpAddRequestHeaders'],
[
Fiddle::TYPE_VOIDP, # hRequest : void* in/out
Fiddle::TYPE_VOIDP, # lpszHeaders : LPCWSTR
-Fiddle::TYPE_INT, # dwHeadersLength : DWORD
-Fiddle::TYPE_INT, # dwModifiers : DWORD
],
Fiddle::TYPE_INT)#[link(name = "winhttp")]
extern "system" {
fn WinHttpAddRequestHeaders(
hRequest: *mut (), // void* in/out
lpszHeaders: *const u16, // LPCWSTR
dwHeadersLength: u32, // DWORD
dwModifiers: u32 // DWORD
) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WINHTTP.dll", SetLastError = true)]
public static extern bool WinHttpAddRequestHeaders(IntPtr hRequest, [MarshalAs(UnmanagedType.LPWStr)] string lpszHeaders, uint dwHeadersLength, uint dwModifiers);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WINHTTP_WinHttpAddRequestHeaders' -Namespace Win32 -PassThru
# $api::WinHttpAddRequestHeaders(hRequest, lpszHeaders, dwHeadersLength, dwModifiers)#uselib "WINHTTP.dll"
#func global WinHttpAddRequestHeaders "WinHttpAddRequestHeaders" sptr, sptr, sptr, sptr
; WinHttpAddRequestHeaders hRequest, lpszHeaders, dwHeadersLength, dwModifiers ; 戻り値は stat
; hRequest : void* in/out -> "sptr"
; lpszHeaders : LPCWSTR -> "sptr"
; dwHeadersLength : DWORD -> "sptr"
; dwModifiers : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "WINHTTP.dll"
#cfunc global WinHttpAddRequestHeaders "WinHttpAddRequestHeaders" sptr, wstr, int, int
; res = WinHttpAddRequestHeaders(hRequest, lpszHeaders, dwHeadersLength, dwModifiers)
; hRequest : void* in/out -> "sptr"
; lpszHeaders : LPCWSTR -> "wstr"
; dwHeadersLength : DWORD -> "int"
; dwModifiers : DWORD -> "int"; BOOL WinHttpAddRequestHeaders(void* hRequest, LPCWSTR lpszHeaders, DWORD dwHeadersLength, DWORD dwModifiers)
#uselib "WINHTTP.dll"
#cfunc global WinHttpAddRequestHeaders "WinHttpAddRequestHeaders" intptr, wstr, int, int
; res = WinHttpAddRequestHeaders(hRequest, lpszHeaders, dwHeadersLength, dwModifiers)
; hRequest : void* in/out -> "intptr"
; lpszHeaders : LPCWSTR -> "wstr"
; dwHeadersLength : DWORD -> "int"
; dwModifiers : DWORD -> "int"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
winhttp = windows.NewLazySystemDLL("WINHTTP.dll")
procWinHttpAddRequestHeaders = winhttp.NewProc("WinHttpAddRequestHeaders")
)
// hRequest (void* in/out), lpszHeaders (LPCWSTR), dwHeadersLength (DWORD), dwModifiers (DWORD)
r1, _, err := procWinHttpAddRequestHeaders.Call(
uintptr(hRequest),
uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpszHeaders))),
uintptr(dwHeadersLength),
uintptr(dwModifiers),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // BOOLfunction WinHttpAddRequestHeaders(
hRequest: Pointer; // void* in/out
lpszHeaders: PWideChar; // LPCWSTR
dwHeadersLength: DWORD; // DWORD
dwModifiers: DWORD // DWORD
): BOOL; stdcall;
external 'WINHTTP.dll' name 'WinHttpAddRequestHeaders';result := DllCall("WINHTTP\WinHttpAddRequestHeaders"
, "Ptr", hRequest ; void* in/out
, "WStr", lpszHeaders ; LPCWSTR
, "UInt", dwHeadersLength ; DWORD
, "UInt", dwModifiers ; DWORD
, "Int") ; return: BOOL●WinHttpAddRequestHeaders(hRequest, lpszHeaders, dwHeadersLength, dwModifiers) = DLL("WINHTTP.dll", "bool WinHttpAddRequestHeaders(void*, char*, dword, dword)")
# 呼び出し: WinHttpAddRequestHeaders(hRequest, lpszHeaders, dwHeadersLength, dwModifiers)
# hRequest : void* in/out -> "void*"
# lpszHeaders : LPCWSTR -> "char*"
# dwHeadersLength : DWORD -> "dword"
# dwModifiers : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "winhttp" fn WinHttpAddRequestHeaders(
hRequest: ?*anyopaque, // void* in/out
lpszHeaders: [*c]const u16, // LPCWSTR
dwHeadersLength: u32, // DWORD
dwModifiers: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;proc WinHttpAddRequestHeaders(
hRequest: pointer, # void* in/out
lpszHeaders: WideCString, # LPCWSTR
dwHeadersLength: uint32, # DWORD
dwModifiers: uint32 # DWORD
): int32 {.importc: "WinHttpAddRequestHeaders", stdcall, dynlib: "WINHTTP.dll".}pragma(lib, "winhttp");
extern(Windows)
int WinHttpAddRequestHeaders(
void* hRequest, // void* in/out
const(wchar)* lpszHeaders, // LPCWSTR
uint dwHeadersLength, // DWORD
uint dwModifiers // DWORD
);ccall((:WinHttpAddRequestHeaders, "WINHTTP.dll"), stdcall, Int32,
(Ptr{Cvoid}, Cwstring, UInt32, UInt32),
hRequest, lpszHeaders, dwHeadersLength, dwModifiers)
# hRequest : void* in/out -> Ptr{Cvoid}
# lpszHeaders : LPCWSTR -> Cwstring
# dwHeadersLength : DWORD -> UInt32
# dwModifiers : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t WinHttpAddRequestHeaders(
void* hRequest,
const uint16_t* lpszHeaders,
uint32_t dwHeadersLength,
uint32_t dwModifiers);
]]
local winhttp = ffi.load("winhttp")
-- winhttp.WinHttpAddRequestHeaders(hRequest, lpszHeaders, dwHeadersLength, dwModifiers)
-- hRequest : void* in/out
-- lpszHeaders : LPCWSTR
-- dwHeadersLength : DWORD
-- dwModifiers : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('WINHTTP.dll');
const WinHttpAddRequestHeaders = lib.func('__stdcall', 'WinHttpAddRequestHeaders', 'int32_t', ['void *', 'str16', 'uint32_t', 'uint32_t']);
// WinHttpAddRequestHeaders(hRequest, lpszHeaders, dwHeadersLength, dwModifiers)
// hRequest : void* in/out -> 'void *'
// lpszHeaders : LPCWSTR -> 'str16'
// dwHeadersLength : DWORD -> 'uint32_t'
// dwModifiers : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("WINHTTP.dll", {
WinHttpAddRequestHeaders: { parameters: ["pointer", "buffer", "u32", "u32"], result: "i32" },
});
// lib.symbols.WinHttpAddRequestHeaders(hRequest, lpszHeaders, dwHeadersLength, dwModifiers)
// hRequest : void* in/out -> "pointer"
// lpszHeaders : LPCWSTR -> "buffer"
// dwHeadersLength : DWORD -> "u32"
// dwModifiers : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t WinHttpAddRequestHeaders(
void* hRequest,
const uint16_t* lpszHeaders,
uint32_t dwHeadersLength,
uint32_t dwModifiers);
C, "WINHTTP.dll");
// $ffi->WinHttpAddRequestHeaders(hRequest, lpszHeaders, dwHeadersLength, dwModifiers);
// hRequest : void* in/out
// lpszHeaders : LPCWSTR
// dwHeadersLength : DWORD
// dwModifiers : DWORD
// 構造体/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);
boolean WinHttpAddRequestHeaders(
Pointer hRequest, // void* in/out
WString lpszHeaders, // LPCWSTR
int dwHeadersLength, // DWORD
int dwModifiers // DWORD
);
}@[Link("winhttp")]
lib LibWINHTTP
fun WinHttpAddRequestHeaders = WinHttpAddRequestHeaders(
hRequest : Void*, # void* in/out
lpszHeaders : UInt16*, # LPCWSTR
dwHeadersLength : UInt32, # DWORD
dwModifiers : UInt32 # DWORD
) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef WinHttpAddRequestHeadersNative = Int32 Function(Pointer<Void>, Pointer<Utf16>, Uint32, Uint32);
typedef WinHttpAddRequestHeadersDart = int Function(Pointer<Void>, Pointer<Utf16>, int, int);
final WinHttpAddRequestHeaders = DynamicLibrary.open('WINHTTP.dll')
.lookupFunction<WinHttpAddRequestHeadersNative, WinHttpAddRequestHeadersDart>('WinHttpAddRequestHeaders');
// hRequest : void* in/out -> Pointer<Void>
// lpszHeaders : LPCWSTR -> Pointer<Utf16>
// dwHeadersLength : DWORD -> Uint32
// dwModifiers : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function WinHttpAddRequestHeaders(
hRequest: Pointer; // void* in/out
lpszHeaders: PWideChar; // LPCWSTR
dwHeadersLength: DWORD; // DWORD
dwModifiers: DWORD // DWORD
): BOOL; stdcall;
external 'WINHTTP.dll' name 'WinHttpAddRequestHeaders';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "WinHttpAddRequestHeaders"
c_WinHttpAddRequestHeaders :: Ptr () -> CWString -> Word32 -> Word32 -> IO CInt
-- hRequest : void* in/out -> Ptr ()
-- lpszHeaders : LPCWSTR -> CWString
-- dwHeadersLength : DWORD -> Word32
-- dwModifiers : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let winhttpaddrequestheaders =
foreign "WinHttpAddRequestHeaders"
((ptr void) @-> (ptr uint16_t) @-> uint32_t @-> uint32_t @-> returning int32_t)
(* hRequest : void* in/out -> (ptr void) *)
(* lpszHeaders : LPCWSTR -> (ptr uint16_t) *)
(* dwHeadersLength : DWORD -> uint32_t *)
(* dwModifiers : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library winhttp (t "WINHTTP.dll"))
(cffi:use-foreign-library winhttp)
(cffi:defcfun ("WinHttpAddRequestHeaders" win-http-add-request-headers :convention :stdcall) :int32
(h-request :pointer) ; void* in/out
(lpsz-headers (:string :encoding :utf-16le)) ; LPCWSTR
(dw-headers-length :uint32) ; DWORD
(dw-modifiers :uint32)) ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $WinHttpAddRequestHeaders = Win32::API::More->new('WINHTTP',
'BOOL WinHttpAddRequestHeaders(LPVOID hRequest, LPCWSTR lpszHeaders, DWORD dwHeadersLength, DWORD dwModifiers)');
# my $ret = $WinHttpAddRequestHeaders->Call($hRequest, $lpszHeaders, $dwHeadersLength, $dwModifiers);
# hRequest : void* in/out -> LPVOID
# lpszHeaders : LPCWSTR -> LPCWSTR
# dwHeadersLength : DWORD -> DWORD
# dwModifiers : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
- f WinHttpAddRequestHeadersEx — HTTP要求に拡張形式の要求ヘッダーを追加する。
- f WinHttpOpenRequest — HTTP要求ハンドルを作成する。
- f WinHttpSendRequest — HTTP要求をサーバーへ送信する。