ホーム › Networking.WinHttp › WinHttpQueryOption

WinHttpQueryOption

関数

WinHTTPハンドルの指定したオプション値を取得する。

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

シグネチャ

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

BOOL WinHttpQueryOption(
    void* hInternet,
    DWORD dwOption,
    void* lpBuffer,   // optional
    DWORD* lpdwBufferLength
);

パラメーター

名前	型	方向	説明
hInternet	void*	inout	情報を照会する HINTERNET ハンドル。照会するオプションに応じて、これはセッションハンドルとリクエストハンドルのいずれかになります。特定のオプションを照会する際にどちらのハンドルを使用するのが適切かを判断するには、Option Flags のトピックを参照してください。
dwOption	DWORD	in	照会するインターネットオプションを格納する unsigned long 整数値。これは Option Flags の値のいずれかになります。
lpBuffer	void*	outoptional	オプション設定を受け取るバッファへのポインター。 WinHttpQueryOption 関数が返す文字列はグローバルに割り当てられるため、呼び出し元のアプリケーションは使用を終えたらその文字列をグローバルに解放する必要があります。このパラメーターを NULL に設定すると、この関数は FALSE を返します。続けて GetLastError を呼び出すと ERROR_INSUFFICIENT_BUFFER が返され、 lpdwBufferLength には要求された情報を保持するために必要なバイト数が格納されます。
lpdwBufferLength	DWORD*	inout	lpBuffer の長さ(バイト単位)を格納する unsigned long 整数変数へのポインター。関数が返ると、この変数には lpBuffer に格納されたデータの長さが設定されます。 GetLastError が ERROR_INSUFFICIENT_BUFFER を返す場合、このパラメーターには要求された情報を保持するために必要なバイト数が設定されます。

戻り値の型: BOOL

公式ドキュメント

WinHttpQueryOption 関数は、指定されたハンドルに対してインターネットオプションを照会します。

戻り値

成功した場合は TRUE を、それ以外の場合は FALSE を返します。具体的なエラーメッセージを取得するには、 GetLastError を呼び出します。返されるエラーコードには次のものがあります。

エラーコード	説明
ERROR_WINHTTP_INCORRECT_HANDLE_STATE	指定されたハンドルが正しい状態にないため、要求された操作を実行できません。
ERROR_WINHTTP_INCORRECT_HANDLE_TYPE	指定されたハンドルの種類がこの操作に対して正しくありません。
ERROR_WINHTTP_INTERNAL_ERROR	内部エラーが発生しました。
ERROR_WINHTTP_INVALID_OPTION	無効なオプション値が指定されました。
ERROR_NOT_ENOUGH_MEMORY	要求された操作を完了するために十分なメモリがありませんでした。(Windows エラーコード)

解説(Remarks)

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

指定されたハンドルの種類に対して無効なオプションフラグが dwOption パラメーターに渡された場合、 GetLastError は ERROR_INVALID_PARAMETER を返します。

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

例

この例では、接続のタイムアウト値を取得する方法を示します。

    DWORD data;
    DWORD dwSize = sizeof(DWORD);

    // Use WinHttpOpen to obtain an HINTERNET handle.
    HINTERNET hSession = WinHttpOpen(L"A WinHTTP Example Program/1.0", 
                                    WINHTTP_ACCESS_TYPE_DEFAULT_PROXY,
                                    WINHTTP_NO_PROXY_NAME, 
                                    WINHTTP_NO_PROXY_BYPASS, 0);
    if (hSession)
    {


        // Use WinHttpQueryOption to retrieve internet options.
        if (WinHttpQueryOption( hSession, 
                                WINHTTP_OPTION_CONNECT_TIMEOUT, 
                                &data, &dwSize))
        {
            printf("Connection timeout: %u ms\n\n",data);
        }
        else
        {
            printf( "Error %u in WinHttpQueryOption.\n", GetLastError());
        }        
        
        // When finished, release the HINTERNET handle.
        WinHttpCloseHandle(hSession);
    }
    else
    {
        printf("Error %u in WinHttpOpen.\n", GetLastError());
    }

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

各言語での呼び出し定義

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

BOOL WinHttpQueryOption(
    void* hInternet,
    DWORD dwOption,
    void* lpBuffer,   // optional
    DWORD* lpdwBufferLength
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WINHTTP.dll", SetLastError = true, ExactSpelling = true)]
static extern bool WinHttpQueryOption(
    IntPtr hInternet,   // void* in/out
    uint dwOption,   // DWORD
    IntPtr lpBuffer,   // void* optional, out
    ref uint lpdwBufferLength   // DWORD* in/out
);

<DllImport("WINHTTP.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function WinHttpQueryOption(
    hInternet As IntPtr,   ' void* in/out
    dwOption As UInteger,   ' DWORD
    lpBuffer As IntPtr,   ' void* optional, out
    ByRef lpdwBufferLength As UInteger   ' DWORD* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

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

import ctypes
from ctypes import wintypes

WinHttpQueryOption = ctypes.windll.winhttp.WinHttpQueryOption
WinHttpQueryOption.restype = wintypes.BOOL
WinHttpQueryOption.argtypes = [
    ctypes.POINTER(None),  # hInternet : void* in/out
    wintypes.DWORD,  # dwOption : DWORD
    ctypes.POINTER(None),  # lpBuffer : void* optional, out
    ctypes.POINTER(wintypes.DWORD),  # lpdwBufferLength : DWORD* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WINHTTP.dll')
WinHttpQueryOption = Fiddle::Function.new(
  lib['WinHttpQueryOption'],
  [
    Fiddle::TYPE_VOIDP,  # hInternet : void* in/out
    -Fiddle::TYPE_INT,  # dwOption : DWORD
    Fiddle::TYPE_VOIDP,  # lpBuffer : void* optional, out
    Fiddle::TYPE_VOIDP,  # lpdwBufferLength : DWORD* in/out
  ],
  Fiddle::TYPE_INT)

#[link(name = "winhttp")]
extern "system" {
    fn WinHttpQueryOption(
        hInternet: *mut (),  // void* in/out
        dwOption: u32,  // DWORD
        lpBuffer: *mut (),  // void* optional, out
        lpdwBufferLength: *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 WinHttpQueryOption(IntPtr hInternet, uint dwOption, IntPtr lpBuffer, ref uint lpdwBufferLength);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WINHTTP_WinHttpQueryOption' -Namespace Win32 -PassThru
# $api::WinHttpQueryOption(hInternet, dwOption, lpBuffer, lpdwBufferLength)

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

出力引数:

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