ホーム › Networking.WinHttp › WinHttpQueryHeaders

WinHttpQueryHeaders

関数

HTTP応答から指定したヘッダー情報を取得する。

DLLWINHTTP.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

BOOL WinHttpQueryHeaders(
    void* hRequest,
    DWORD dwInfoLevel,
    LPCWSTR pwszName,
    void* lpBuffer,   // optional
    DWORD* lpdwBufferLength,
    DWORD* lpdwIndex
);

パラメーター

名前	型	方向	説明
hRequest	void*	inout	HINTERNET リクエストハンドル。 WinHttpOpenRequest によって返されます。 WinHttpQueryHeaders を呼び出す前に、このハンドルに対して WinHttpReceiveResponse が呼び出され、完了している必要があります。
dwInfoLevel	DWORD	in	Query Info Flags ページに記載されている属性フラグと修飾フラグの組み合わせを指定する DWORD 型の値です。これらの属性フラグと修飾フラグは、要求する情報と、その情報をどのように整形するかを指定します。
pwszName	LPCWSTR	in	ヘッダー名を含む文字列へのポインターです。 dwInfoLevel のフラグが WINHTTP_QUERY_CUSTOM でない場合は、このパラメーターに WINHTTP_HEADER_NAME_BY_INDEX を設定します。
lpBuffer	void*	outoptional	情報を受け取るバッファーへのポインターです。このパラメーターに WINHTTP_NO_OUTPUT_BUFFER を設定すると、この関数は FALSE を返します。その後 GetLastError を呼び出すと ERROR_INSUFFICIENT_BUFFER が返され、 lpdwBufferLength には要求された情報を格納するために必要なバイト数が格納されます。
lpdwBufferLength	DWORD*	inout	データバッファーの長さ(バイト単位)を指定する DWORD 型の値へのポインターです。関数が返るとき、このパラメーターはバッファーに書き込まれた情報の長さを指定する値へのポインターを格納します。関数が文字列を返す場合、次の規則が適用されます。関数が成功した場合、 lpdwBufferLength には文字列の長さ(バイト単位)から終端の null 分の 2 を引いた値が指定されます。関数が失敗し、 ERROR_INSUFFICIENT_BUFFER が返された場合、 lpdwBufferLength には文字列を受け取るためにアプリケーションが割り当てなければならないバイト数が指定されます。
lpdwIndex	DWORD*	inout	同じ名前を持つ複数のヘッダーを列挙するために使用される、0 から始まるヘッダーインデックスへのポインターです。関数を呼び出すとき、このパラメーターは返す対象のヘッダーのインデックスです。関数が返るとき、このパラメーターは次のヘッダーのインデックスになります。次のインデックスが見つからない場合は ERROR_WINHTTP_HEADER_NOT_FOUND が返されます。ヘッダーの最初の出現のみを返すように指定するには、このパラメーターに WINHTTP_NO_HEADER_INDEX を設定します。

戻り値の型: BOOL

公式ドキュメント

WinHttpQueryHeaders 関数は、HTTP リクエストに関連付けられたヘッダー情報を取得します。

戻り値

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

エラーコード	説明
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)

WinHTTP が非同期モードで使用されている場合(つまり WinHttpOpen で WINHTTP_FLAG_ASYNC が設定されている場合)でも、この関数は同期的に動作します。戻り値は成功または失敗を示します。拡張エラー情報を取得するには、 GetLastError を呼び出します。

既定では、 WinHttpQueryHeaders は文字列を返します。ただし、 dwInfoLevel に適切な修飾フラグを含めることで、 SYSTEMTIME 構造体または DWORD の形式でデータを要求できます。次の表は、 WinHttpQueryHeaders が返すことのできるデータ型と、そのデータ型を選択するために使用する修飾フラグを示しています。

データ型	修飾フラグ
LPCWSTR	既定。修飾フラグは不要です。
SYSTEMTIME	WINHTTP_QUERY_FLAG_SYSTEMTIME
DWORD	WINHTTP_QUERY_FLAG_NUMBER

注意 Windows XP および Windows 2000 については、WinHttp スタートページの Run-Time Requirements セクションを参照してください。

例

次の例は、 HINTERNET ハンドルを取得し、HTTP セッションを開き、リクエストヘッダーを作成して送信し、返されたレスポンスヘッダーを調べる方法を示しています。

    DWORD dwSize = 0;
    LPVOID lpOutBuffer = NULL;
    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);

    // Send a request.
    if (hRequest)
        bResults = WinHttpSendRequest( hRequest,
                                       WINHTTP_NO_ADDITIONAL_HEADERS,
                                       0, WINHTTP_NO_REQUEST_DATA, 0,
                                       0, 0);

    // End the request.
    if (bResults)
        bResults = WinHttpReceiveResponse( hRequest, NULL);

    // First, use WinHttpQueryHeaders to obtain the size of the buffer.
    if (bResults)
    {
        WinHttpQueryHeaders( hRequest, WINHTTP_QUERY_RAW_HEADERS_CRLF,
                             WINHTTP_HEADER_NAME_BY_INDEX, NULL,
                             &dwSize, WINHTTP_NO_HEADER_INDEX);

        // Allocate memory for the buffer.
        if( GetLastError( ) == ERROR_INSUFFICIENT_BUFFER )
        {
            lpOutBuffer = new WCHAR[dwSize/sizeof(WCHAR)];

            // Now, use WinHttpQueryHeaders to retrieve the header.
            bResults = WinHttpQueryHeaders( hRequest,
                                       WINHTTP_QUERY_RAW_HEADERS_CRLF,
                                       WINHTTP_HEADER_NAME_BY_INDEX,
                                       lpOutBuffer, &dwSize,
                                       WINHTTP_NO_HEADER_INDEX);
        }
    }

    // Print the header contents.
    if (bResults)
        printf("Header contents: \n%S",lpOutBuffer);

    // Free the allocated memory.
    delete [] lpOutBuffer;

    // Report any errors.
    if (!bResults)
        printf("Error %d has occurred.\n",GetLastError());

    // Close any open handles.
    if (hRequest) WinHttpCloseHandle(hRequest);
    if (hConnect) WinHttpCloseHandle(hConnect);
    if (hSession) WinHttpCloseHandle(hSession);

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

各言語での呼び出し定義

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

BOOL WinHttpQueryHeaders(
    void* hRequest,
    DWORD dwInfoLevel,
    LPCWSTR pwszName,
    void* lpBuffer,   // optional
    DWORD* lpdwBufferLength,
    DWORD* lpdwIndex
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WINHTTP.dll", SetLastError = true, ExactSpelling = true)]
static extern bool WinHttpQueryHeaders(
    IntPtr hRequest,   // void* in/out
    uint dwInfoLevel,   // DWORD
    [MarshalAs(UnmanagedType.LPWStr)] string pwszName,   // LPCWSTR
    IntPtr lpBuffer,   // void* optional, out
    ref uint lpdwBufferLength,   // DWORD* in/out
    ref uint lpdwIndex   // DWORD* in/out
);

<DllImport("WINHTTP.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function WinHttpQueryHeaders(
    hRequest As IntPtr,   ' void* in/out
    dwInfoLevel As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPWStr)> pwszName As String,   ' LPCWSTR
    lpBuffer As IntPtr,   ' void* optional, out
    ByRef lpdwBufferLength As UInteger,   ' DWORD* in/out
    ByRef lpdwIndex As UInteger   ' DWORD* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hRequest : void* in/out
' dwInfoLevel : DWORD
' pwszName : LPCWSTR
' lpBuffer : void* optional, out
' lpdwBufferLength : DWORD* in/out
' lpdwIndex : DWORD* in/out
Declare PtrSafe Function WinHttpQueryHeaders Lib "winhttp" ( _
    ByVal hRequest As LongPtr, _
    ByVal dwInfoLevel As Long, _
    ByVal pwszName As LongPtr, _
    ByVal lpBuffer As LongPtr, _
    ByRef lpdwBufferLength As Long, _
    ByRef lpdwIndex As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

WinHttpQueryHeaders = ctypes.windll.winhttp.WinHttpQueryHeaders
WinHttpQueryHeaders.restype = wintypes.BOOL
WinHttpQueryHeaders.argtypes = [
    ctypes.POINTER(None),  # hRequest : void* in/out
    wintypes.DWORD,  # dwInfoLevel : DWORD
    wintypes.LPCWSTR,  # pwszName : LPCWSTR
    ctypes.POINTER(None),  # lpBuffer : void* optional, out
    ctypes.POINTER(wintypes.DWORD),  # lpdwBufferLength : DWORD* in/out
    ctypes.POINTER(wintypes.DWORD),  # lpdwIndex : DWORD* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WINHTTP.dll')
WinHttpQueryHeaders = Fiddle::Function.new(
  lib['WinHttpQueryHeaders'],
  [
    Fiddle::TYPE_VOIDP,  # hRequest : void* in/out
    -Fiddle::TYPE_INT,  # dwInfoLevel : DWORD
    Fiddle::TYPE_VOIDP,  # pwszName : LPCWSTR
    Fiddle::TYPE_VOIDP,  # lpBuffer : void* optional, out
    Fiddle::TYPE_VOIDP,  # lpdwBufferLength : DWORD* in/out
    Fiddle::TYPE_VOIDP,  # lpdwIndex : DWORD* in/out
  ],
  Fiddle::TYPE_INT)

#[link(name = "winhttp")]
extern "system" {
    fn WinHttpQueryHeaders(
        hRequest: *mut (),  // void* in/out
        dwInfoLevel: u32,  // DWORD
        pwszName: *const u16,  // LPCWSTR
        lpBuffer: *mut (),  // void* optional, out
        lpdwBufferLength: *mut u32,  // DWORD* in/out
        lpdwIndex: *mut u32  // DWORD* in/out
    ) -> 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 WinHttpQueryHeaders(IntPtr hRequest, uint dwInfoLevel, [MarshalAs(UnmanagedType.LPWStr)] string pwszName, IntPtr lpBuffer, ref uint lpdwBufferLength, ref uint lpdwIndex);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WINHTTP_WinHttpQueryHeaders' -Namespace Win32 -PassThru
# $api::WinHttpQueryHeaders(hRequest, dwInfoLevel, pwszName, lpBuffer, lpdwBufferLength, lpdwIndex)

#uselib "WINHTTP.dll"
#func global WinHttpQueryHeaders "WinHttpQueryHeaders" sptr, sptr, sptr, sptr, sptr, sptr
; WinHttpQueryHeaders hRequest, dwInfoLevel, pwszName, lpBuffer, varptr(lpdwBufferLength), varptr(lpdwIndex)   ; 戻り値は stat
; hRequest : void* in/out -> "sptr"
; dwInfoLevel : DWORD -> "sptr"
; pwszName : LPCWSTR -> "sptr"
; lpBuffer : void* optional, out -> "sptr"
; lpdwBufferLength : DWORD* in/out -> "sptr"
; lpdwIndex : DWORD* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "WINHTTP.dll"
#cfunc global WinHttpQueryHeaders "WinHttpQueryHeaders" sptr, int, wstr, sptr, var, var
; res = WinHttpQueryHeaders(hRequest, dwInfoLevel, pwszName, lpBuffer, lpdwBufferLength, lpdwIndex)
; hRequest : void* in/out -> "sptr"
; dwInfoLevel : DWORD -> "int"
; pwszName : LPCWSTR -> "wstr"
; lpBuffer : void* optional, out -> "sptr"
; lpdwBufferLength : DWORD* in/out -> "var"
; lpdwIndex : DWORD* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "WINHTTP.dll"
#cfunc global WinHttpQueryHeaders "WinHttpQueryHeaders" sptr, int, wstr, sptr, sptr, sptr
; res = WinHttpQueryHeaders(hRequest, dwInfoLevel, pwszName, lpBuffer, varptr(lpdwBufferLength), varptr(lpdwIndex))
; hRequest : void* in/out -> "sptr"
; dwInfoLevel : DWORD -> "int"
; pwszName : LPCWSTR -> "wstr"
; lpBuffer : void* optional, out -> "sptr"
; lpdwBufferLength : DWORD* in/out -> "sptr"
; lpdwIndex : DWORD* in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。