ホーム › Networking.WinHttp › WinHttpQueryHeadersEx

WinHttpQueryHeadersEx

関数

HTTP応答から拡張形式でヘッダー情報を取得する。

DLLWINHTTP.dll呼出規約winapi

シグネチャ

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

DWORD WinHttpQueryHeadersEx(
    void* hRequest,
    DWORD dwInfoLevel,
    ULONGLONG ullFlags,
    DWORD uiCodePage,
    DWORD* pdwIndex,   // optional
    WINHTTP_HEADER_NAME* pHeaderName,   // optional
    void* pBuffer,   // optional
    DWORD* pdwBufferLength,
    WINHTTP_EXTENDED_HEADER** ppHeaders,   // optional
    DWORD* pdwHeadersCount
);

パラメーター

名前	型	方向	説明
hRequest	void*	in	WinHttpOpenRequest によって返されたリクエストハンドル。WinHttpQueryHeadersEx を呼び出す前に、このハンドルに対する WinHttpReceiveResponse の呼び出しが完了している必要があります。トレーラーを照会する場合は、WinHttpQueryHeadersEx を呼び出す前に、このハンドルに対する WinHttpReadData の呼び出しが読み取りバイト数 0 を返している必要があります。
dwInfoLevel	DWORD	in	Query info flags トピックに記載されている属性フラグと修飾フラグの組み合わせを指定する DWORD 型の値です。これらの属性フラグおよび修飾フラグは、要求する情報と、その情報をどのように整形するかを示します。メモ次のフラグを使用すると ERROR_INVALID_PARAMETER が返されます: WINHTTP_QUERY_VERSION、WINHTTP_QUERY_STATUS_CODE、WINHTTP_QUERY_STATUS_TEXT、WINHTTP_QUERY_FLAG_NUMBER、WINHTTP_QUERY_FLAG_NUMBER64、WINHTTP_QUERY_FLAG_SYSTEMTIME、および WINHTTP_QUERY_RAW_HEADERS_CRLF。 WINHTTP_QUERY_EX_ALL_HEADERS フラグはすべてのヘッダーを返します。すべてのヘッダーを照会するのではない場合は、特定の既知のヘッダーに対応するフラグを渡すか、または WINHTTP_QUERY_CUSTOM を pHeaderName パラメーターのヘッダー名文字列とともに渡すことができます。 WINHTTP_QUERY_FLAG_WIRE_ENCODING を渡すと、ワイヤー上で送受信される形式のままヘッダーが返されます(この場合は WINHTTP_EXTENDED_HEADER および WINHTTP_HEADER_NAME の psz* メンバーにアクセス/設定します)。ワイヤーエンコーディングフラグを設定しない場合、既定の動作では Unicode 形式でヘッダーが返されます(この場合は WINHTTP_EXTENDED_HEADER および WINHTTP_HEADER_NAME の pwsz* メンバーにアクセス/設定します)。
ullFlags	ULONGLONG	in	予約済みです。0 を設定してください。
uiCodePage	DWORD	in	Unicode 変換に使用するコードページです。既定の動作(CP_ACP)とする場合、または WINHTTP_QUERY_FLAG_WIRE_ENCODING を使用する場合は 0 を渡してください。このパラメーターに対する検証は行われません。
pdwIndex	DWORD*	inoutoptional	同名の複数のヘッダーを列挙するために使用する 0 起点のインデックスのアドレスです。関数を呼び出すとき、このパラメーターは返す対象のヘッダーのインデックスを表します。関数が戻るとき、このパラメーターは次のヘッダーのインデックスを表します。指定したヘッダーの最初のインスタンスにアクセスするには NULL を渡してください。
pHeaderName	WINHTTP_HEADER_NAME*	inoptional	WINHTTP_HEADER_NAME 構造体のアドレスです。すべてのヘッダーを取得する場合は pHeaderName に NULL を設定してください。このパラメーターが NULL でなく、dwInfoLevel に WINHTTP_QUERY_CUSTOM を渡した場合、WinHttpQueryHeadersEx はこのパラメーターで指定されたヘッダーのみを取得します。dwInfoLevel に WINHTTP_QUERY_FLAG_WIRE_ENCODING を渡した場合は pszName メンバーを使用してください(このフラグを設定しない場合は pwszName メンバーを使用します)。
pBuffer	void*	outoptional	解析済みのヘッダーポインターおよびヘッダーを格納するための、呼び出し側が用意するバッファーです。このパラメーターが NULL であるか小さすぎる場合、WinHttpQueryHeadersEx は ERROR_INSUFFICIENT_BUFFER を返し、pdwBufferLength パラメーターに必要なバッファーサイズ(バイト単位)が格納されます。
pdwBufferLength	DWORD*	inout	呼び出し側が用意したバッファーの長さです。pBuffer が NULL であるか小さすぎる場合、WinHttpQueryHeadersEx は必要なバッファーサイズ(バイト単位)をこのパラメーターに書き込みます。
ppHeaders	WINHTTP_EXTENDED_HEADER**	outoptional	解析済みのヘッダー名/値にアクセスするための WINHTTP_EXTENDED_HEADER 配列へのハンドルです。NULL で初期化した WINHTTP_EXTENDED_HEADER ポインターのアドレスを渡してください。完了後は、WINHTTP_QUERY_FLAG_WIRE_ENCODING を使用している場合は pszName/pszValue パラメーターに、それ以外の場合は pwszName/pwszValue にアクセスします。
pdwHeadersCount	DWORD*	out	返されたヘッダーの数です。`ppHeaders[cHeaders - 1]` を超えてアクセスしないでください。配列の範囲外となるためです。

戻り値の型: DWORD

公式ドキュメント

HTTP リクエストに関連付けられたヘッダー情報を取得します。解析済みのヘッダー名と値の文字列を取得する手段を提供します。

戻り値

操作の結果を示すステータスコードです。返されるエラーコードには次のものがあります。

Error Code	Description
ERROR_WINHTTP_HEADER_NOT_FOUND	要求されたヘッダーが見つかりませんでした。
ERROR_WINHTTP_INCORRECT_HANDLE_STATE	指定されたハンドルが正しい状態にないため、要求された操作を実行できません。
ERROR_WINHTTP_INCORRECT_HANDLE_TYPE	指定されたハンドルの種類がこの操作に対して正しくありません。
ERROR_WINHTTP_INTERNAL_ERROR	内部エラーが発生しました。
ERROR_NOT_ENOUGH_MEMORY	要求された操作を完了するための十分なメモリがありませんでした。(Windows エラーコード)

解説(Remarks)

WinHttpQueryHeadersEx は WinHttpQueryHeaders の機能を基にしています。WinHttpQueryHeaders では、リクエストまたはレスポンスのヘッダー(あるいはレスポンスのトレーラー)を、文字列、数値(DWORD)、またはタイムスタンプ(SYSTEMTIME)の形式で照会できます。すべてのヘッダーを照会すると、各ヘッダーを CRLF または NULL 文字で区切った単一のシリアライズされた文字列が返されます。例えば "Name1: value1\r\nName2: value2\r\n\r\n" や "Name1: value1\0Name2: value2\0\0" のようになります。文字列の終端を示すために二重の区切り文字が使用されます。

WinHttpQueryHeadersEx は、解析済みのヘッダー名と値の文字列を取得する手段を提供します。

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

各言語での呼び出し定義

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

DWORD WinHttpQueryHeadersEx(
    void* hRequest,
    DWORD dwInfoLevel,
    ULONGLONG ullFlags,
    DWORD uiCodePage,
    DWORD* pdwIndex,   // optional
    WINHTTP_HEADER_NAME* pHeaderName,   // optional
    void* pBuffer,   // optional
    DWORD* pdwBufferLength,
    WINHTTP_EXTENDED_HEADER** ppHeaders,   // optional
    DWORD* pdwHeadersCount
);

[DllImport("WINHTTP.dll", ExactSpelling = true)]
static extern uint WinHttpQueryHeadersEx(
    IntPtr hRequest,   // void*
    uint dwInfoLevel,   // DWORD
    ulong ullFlags,   // ULONGLONG
    uint uiCodePage,   // DWORD
    IntPtr pdwIndex,   // DWORD* optional, in/out
    IntPtr pHeaderName,   // WINHTTP_HEADER_NAME* optional
    IntPtr pBuffer,   // void* optional, out
    ref uint pdwBufferLength,   // DWORD* in/out
    IntPtr ppHeaders,   // WINHTTP_EXTENDED_HEADER** optional, out
    out uint pdwHeadersCount   // DWORD* out
);

<DllImport("WINHTTP.dll", ExactSpelling:=True)>
Public Shared Function WinHttpQueryHeadersEx(
    hRequest As IntPtr,   ' void*
    dwInfoLevel As UInteger,   ' DWORD
    ullFlags As ULong,   ' ULONGLONG
    uiCodePage As UInteger,   ' DWORD
    pdwIndex As IntPtr,   ' DWORD* optional, in/out
    pHeaderName As IntPtr,   ' WINHTTP_HEADER_NAME* optional
    pBuffer As IntPtr,   ' void* optional, out
    ByRef pdwBufferLength As UInteger,   ' DWORD* in/out
    ppHeaders As IntPtr,   ' WINHTTP_EXTENDED_HEADER** optional, out
    <Out> ByRef pdwHeadersCount As UInteger   ' DWORD* out
) As UInteger
End Function

' hRequest : void*
' dwInfoLevel : DWORD
' ullFlags : ULONGLONG
' uiCodePage : DWORD
' pdwIndex : DWORD* optional, in/out
' pHeaderName : WINHTTP_HEADER_NAME* optional
' pBuffer : void* optional, out
' pdwBufferLength : DWORD* in/out
' ppHeaders : WINHTTP_EXTENDED_HEADER** optional, out
' pdwHeadersCount : DWORD* out
Declare PtrSafe Function WinHttpQueryHeadersEx Lib "winhttp" ( _
    ByVal hRequest As LongPtr, _
    ByVal dwInfoLevel As Long, _
    ByVal ullFlags As LongLong, _
    ByVal uiCodePage As Long, _
    ByVal pdwIndex As LongPtr, _
    ByVal pHeaderName As LongPtr, _
    ByVal pBuffer As LongPtr, _
    ByRef pdwBufferLength As Long, _
    ByVal ppHeaders As LongPtr, _
    ByRef pdwHeadersCount As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

WinHttpQueryHeadersEx = ctypes.windll.winhttp.WinHttpQueryHeadersEx
WinHttpQueryHeadersEx.restype = wintypes.DWORD
WinHttpQueryHeadersEx.argtypes = [
    ctypes.POINTER(None),  # hRequest : void*
    wintypes.DWORD,  # dwInfoLevel : DWORD
    ctypes.c_ulonglong,  # ullFlags : ULONGLONG
    wintypes.DWORD,  # uiCodePage : DWORD
    ctypes.POINTER(wintypes.DWORD),  # pdwIndex : DWORD* optional, in/out
    ctypes.c_void_p,  # pHeaderName : WINHTTP_HEADER_NAME* optional
    ctypes.POINTER(None),  # pBuffer : void* optional, out
    ctypes.POINTER(wintypes.DWORD),  # pdwBufferLength : DWORD* in/out
    ctypes.c_void_p,  # ppHeaders : WINHTTP_EXTENDED_HEADER** optional, out
    ctypes.POINTER(wintypes.DWORD),  # pdwHeadersCount : DWORD* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WINHTTP.dll')
WinHttpQueryHeadersEx = Fiddle::Function.new(
  lib['WinHttpQueryHeadersEx'],
  [
    Fiddle::TYPE_VOIDP,  # hRequest : void*
    -Fiddle::TYPE_INT,  # dwInfoLevel : DWORD
    -Fiddle::TYPE_LONG_LONG,  # ullFlags : ULONGLONG
    -Fiddle::TYPE_INT,  # uiCodePage : DWORD
    Fiddle::TYPE_VOIDP,  # pdwIndex : DWORD* optional, in/out
    Fiddle::TYPE_VOIDP,  # pHeaderName : WINHTTP_HEADER_NAME* optional
    Fiddle::TYPE_VOIDP,  # pBuffer : void* optional, out
    Fiddle::TYPE_VOIDP,  # pdwBufferLength : DWORD* in/out
    Fiddle::TYPE_VOIDP,  # ppHeaders : WINHTTP_EXTENDED_HEADER** optional, out
    Fiddle::TYPE_VOIDP,  # pdwHeadersCount : DWORD* out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "winhttp")]
extern "system" {
    fn WinHttpQueryHeadersEx(
        hRequest: *mut (),  // void*
        dwInfoLevel: u32,  // DWORD
        ullFlags: u64,  // ULONGLONG
        uiCodePage: u32,  // DWORD
        pdwIndex: *mut u32,  // DWORD* optional, in/out
        pHeaderName: *mut WINHTTP_HEADER_NAME,  // WINHTTP_HEADER_NAME* optional
        pBuffer: *mut (),  // void* optional, out
        pdwBufferLength: *mut u32,  // DWORD* in/out
        ppHeaders: *mut *mut WINHTTP_EXTENDED_HEADER,  // WINHTTP_EXTENDED_HEADER** optional, out
        pdwHeadersCount: *mut u32  // DWORD* out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("WINHTTP.dll")]
public static extern uint WinHttpQueryHeadersEx(IntPtr hRequest, uint dwInfoLevel, ulong ullFlags, uint uiCodePage, IntPtr pdwIndex, IntPtr pHeaderName, IntPtr pBuffer, ref uint pdwBufferLength, IntPtr ppHeaders, out uint pdwHeadersCount);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WINHTTP_WinHttpQueryHeadersEx' -Namespace Win32 -PassThru
# $api::WinHttpQueryHeadersEx(hRequest, dwInfoLevel, ullFlags, uiCodePage, pdwIndex, pHeaderName, pBuffer, pdwBufferLength, ppHeaders, pdwHeadersCount)

#uselib "WINHTTP.dll"
#func global WinHttpQueryHeadersEx "WinHttpQueryHeadersEx" sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr
; WinHttpQueryHeadersEx hRequest, dwInfoLevel, ullFlags, uiCodePage, varptr(pdwIndex), varptr(pHeaderName), pBuffer, varptr(pdwBufferLength), varptr(ppHeaders), varptr(pdwHeadersCount)   ; 戻り値は stat
; hRequest : void* -> "sptr"
; dwInfoLevel : DWORD -> "sptr"
; ullFlags : ULONGLONG -> "sptr"
; uiCodePage : DWORD -> "sptr"
; pdwIndex : DWORD* optional, in/out -> "sptr"
; pHeaderName : WINHTTP_HEADER_NAME* optional -> "sptr"
; pBuffer : void* optional, out -> "sptr"
; pdwBufferLength : DWORD* in/out -> "sptr"
; ppHeaders : WINHTTP_EXTENDED_HEADER** optional, out -> "sptr"
; pdwHeadersCount : DWORD* out -> "sptr"
; ※HSP3.7は int64 引数(64bit値渡し)に非対応です。
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "WINHTTP.dll"
#cfunc global WinHttpQueryHeadersEx "WinHttpQueryHeadersEx" sptr, int, int64, int, var, var, sptr, var, var, var
; res = WinHttpQueryHeadersEx(hRequest, dwInfoLevel, ullFlags, uiCodePage, pdwIndex, pHeaderName, pBuffer, pdwBufferLength, ppHeaders, pdwHeadersCount)
; hRequest : void* -> "sptr"
; dwInfoLevel : DWORD -> "int"
; ullFlags : ULONGLONG -> "int64"
; uiCodePage : DWORD -> "int"
; pdwIndex : DWORD* optional, in/out -> "var"
; pHeaderName : WINHTTP_HEADER_NAME* optional -> "var"
; pBuffer : void* optional, out -> "sptr"
; pdwBufferLength : DWORD* in/out -> "var"
; ppHeaders : WINHTTP_EXTENDED_HEADER** optional, out -> "var"
; pdwHeadersCount : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
; ※int64 引数の DLL 値渡しは x64 ランタイム(hsp3_64)のみ対応(x86 は未対応)。#uselib "WINHTTP.dll"
#cfunc global WinHttpQueryHeadersEx "WinHttpQueryHeadersEx" sptr, int, int64, int, sptr, sptr, sptr, sptr, sptr, sptr
; res = WinHttpQueryHeadersEx(hRequest, dwInfoLevel, ullFlags, uiCodePage, varptr(pdwIndex), varptr(pHeaderName), pBuffer, varptr(pdwBufferLength), varptr(ppHeaders), varptr(pdwHeadersCount))
; hRequest : void* -> "sptr"
; dwInfoLevel : DWORD -> "int"
; ullFlags : ULONGLONG -> "int64"
; uiCodePage : DWORD -> "int"
; pdwIndex : DWORD* optional, in/out -> "sptr"
; pHeaderName : WINHTTP_HEADER_NAME* optional -> "sptr"
; pBuffer : void* optional, out -> "sptr"
; pdwBufferLength : DWORD* in/out -> "sptr"
; ppHeaders : WINHTTP_EXTENDED_HEADER** optional, out -> "sptr"
; pdwHeadersCount : DWORD* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※int64 引数の DLL 値渡しは x64 ランタイム(hsp3_64)のみ対応(x86 は未対応)。