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

WinHttpAddRequestHeaders

関数
HTTP要求に要求ヘッダーを追加する。
DLLWINHTTP.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

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

パラメーター

名前方向
hRequestvoid*inout
lpszHeadersLPCWSTRin
dwHeadersLengthDWORDin
dwModifiersDWORDin

戻り値の型: BOOL

各言語での呼び出し定義

// 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 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   // BOOL
function 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)。