ホーム › Networking.WinInet › HttpQueryInfoW

HttpQueryInfoW

関数

HTTP応答のヘッダーや状態情報を問い合わせる(Unicode版)。

DLLWININET.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

// WININET.dll  (Unicode / -W)
#include <windows.h>

BOOL HttpQueryInfoW(
    void* hRequest,
    DWORD dwInfoLevel,
    void* lpBuffer,   // optional
    DWORD* lpdwBufferLength,
    DWORD* lpdwIndex   // optional
);

パラメーター

名前	型	方向	説明
hRequest	void*	in	HttpOpenRequest または InternetOpenUrl 関数の呼び出しによって返されたハンドルです。
dwInfoLevel	DWORD	in	取得する属性と、リクエストを変更するフラグの組み合わせです。指定可能な属性と修飾子の値の一覧については、Query Info Flags を参照してください。
lpBuffer	void*	inoutoptional	要求した情報を受け取るバッファーへのポインターです。このパラメーターを NULL にすることはできません。
lpdwBufferLength	DWORD*	inout	lpvBuffer が指すバッファーのサイズ (バイト単位) を、呼び出し時に格納する変数へのポインターです。関数が正常に返ると、この変数にはバッファーへ書き込まれた情報のバイト数が格納されます。文字列の場合、このバイト数には文字列の終端 null 文字は含まれません。関数が拡張エラーコード ERROR_INSUFFICIENT_BUFFER で失敗した場合、lpdwBufferLength が指す変数には、要求した情報を受け取るのに十分な大きさのバッファーのサイズ (バイト単位) が終了時に格納されます。呼び出し元のアプリケーションは、このサイズ以上のバッファーを割り当てて、関数を再度呼び出すことができます。
lpdwIndex	DWORD*	inoutoptional	同じ名前の複数のヘッダーを列挙するために使用する、0 から始まるヘッダーインデックスへのポインターです。関数を呼び出す際、このパラメーターは返す対象として指定するヘッダーのインデックスです。関数が返ると、このパラメーターは次のヘッダーのインデックスになります。次のインデックスが見つからない場合は、ERROR_HTTP_HEADER_NOT_FOUND が返されます。

戻り値の型: BOOL

公式ドキュメント

HTTP リクエストに関連付けられたヘッダー情報を取得します。(Unicode)

戻り値

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

解説(Remarks)

HttpQueryInfo からは、次の種類のデータを取得できます。

文字列 (既定)
SYSTEMTIME (日付の場合)
DWORD (HTTP_QUERY_FLAG_NUMBER が使用されている場合の STATUS_CODE、CONTENT_LENGTH など)

アプリケーションがデータを文字列以外のデータ型で返すことを必要とする場合は、dwInfoLevel に渡す属性に適切な修飾子を含める必要があります。

HttpQueryInfo 関数は、Microsoft Internet Explorer 3.0 では ISO-8859-1 文字に対して (HttpQueryInfoA 関数)、Internet Explorer 4.0 以降では ISO-8859-1 文字に対して (HttpQueryInfoA 関数) および ISO-8859-1 文字を UTF-16LE 文字に変換したものに対して (HttpQueryInfoW 関数) 利用できます。

注意 HttpQueryInfoA 関数は、ヘッダーを ANSI 文字ではなく ISO-8859-1 文字として表します。HttpQueryInfoW 関数は、ヘッダーを ISO-8859-1 文字を UTF-16LE 文字に変換したものとして表します。そのため、ヘッダーに非 ASCII 文字が含まれる可能性がある場合に HttpQueryInfoW 関数を使用するのは決して安全ではありません。代わりに、アプリケーションは Codepage パラメーターを 28591 に設定した MultiByteToWideChar 関数および WideCharToMultiByte 関数を使用して、ANSI 文字と UTF-16LE 文字の間でマッピングできます。

HttpQueryInfo 関数を呼び出すサンプルコードについては、Retrieving HTTP Headers を参照してください。

WinINet API の他のすべての側面と同様に、この関数は DllMain やグローバルオブジェクトのコンストラクター・デストラクター内から安全に呼び出すことはできません。

注意 WinINet はサーバー実装をサポートしていません。また、サービスから使用すべきではありません。サーバー実装やサービスでは、Microsoft Windows HTTP Services (WinHTTP) を使用してください。

メモ

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

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

各言語での呼び出し定義

// WININET.dll  (Unicode / -W)
#include <windows.h>

BOOL HttpQueryInfoW(
    void* hRequest,
    DWORD dwInfoLevel,
    void* lpBuffer,   // optional
    DWORD* lpdwBufferLength,
    DWORD* lpdwIndex   // optional
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WININET.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool HttpQueryInfoW(
    IntPtr hRequest,   // void*
    uint dwInfoLevel,   // DWORD
    IntPtr lpBuffer,   // void* optional, in/out
    ref uint lpdwBufferLength,   // DWORD* in/out
    IntPtr lpdwIndex   // DWORD* optional, in/out
);

<DllImport("WININET.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function HttpQueryInfoW(
    hRequest As IntPtr,   ' void*
    dwInfoLevel As UInteger,   ' DWORD
    lpBuffer As IntPtr,   ' void* optional, in/out
    ByRef lpdwBufferLength As UInteger,   ' DWORD* in/out
    lpdwIndex As IntPtr   ' DWORD* optional, in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hRequest : void*
' dwInfoLevel : DWORD
' lpBuffer : void* optional, in/out
' lpdwBufferLength : DWORD* in/out
' lpdwIndex : DWORD* optional, in/out
Declare PtrSafe Function HttpQueryInfoW Lib "wininet" ( _
    ByVal hRequest As LongPtr, _
    ByVal dwInfoLevel As Long, _
    ByVal lpBuffer As LongPtr, _
    ByRef lpdwBufferLength As Long, _
    ByVal lpdwIndex As LongPtr) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

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

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WININET.dll')
HttpQueryInfoW = Fiddle::Function.new(
  lib['HttpQueryInfoW'],
  [
    Fiddle::TYPE_VOIDP,  # hRequest : void*
    -Fiddle::TYPE_INT,  # dwInfoLevel : DWORD
    Fiddle::TYPE_VOIDP,  # lpBuffer : void* optional, in/out
    Fiddle::TYPE_VOIDP,  # lpdwBufferLength : DWORD* in/out
    Fiddle::TYPE_VOIDP,  # lpdwIndex : DWORD* optional, in/out
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "wininet")]
extern "system" {
    fn HttpQueryInfoW(
        hRequest: *mut (),  // void*
        dwInfoLevel: u32,  // DWORD
        lpBuffer: *mut (),  // void* optional, in/out
        lpdwBufferLength: *mut u32,  // DWORD* in/out
        lpdwIndex: *mut u32  // DWORD* optional, in/out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WININET.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern bool HttpQueryInfoW(IntPtr hRequest, uint dwInfoLevel, IntPtr lpBuffer, ref uint lpdwBufferLength, IntPtr lpdwIndex);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WININET_HttpQueryInfoW' -Namespace Win32 -PassThru
# $api::HttpQueryInfoW(hRequest, dwInfoLevel, lpBuffer, lpdwBufferLength, lpdwIndex)

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

出力引数:

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