ホーム › Networking.WinHttp › WinHttpGetIEProxyConfigForCurrentUser

WinHttpGetIEProxyConfigForCurrentUser

関数

現在のユーザーのIEプロキシ構成を取得する。

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

シグネチャ

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

BOOL WinHttpGetIEProxyConfigForCurrentUser(
    WINHTTP_CURRENT_USER_IE_PROXY_CONFIG* pProxyConfig
);

パラメーター

名前	型	方向	説明
pProxyConfig	WINHTTP_CURRENT_USER_IE_PROXY_CONFIG*	inout	入力時には WINHTTP_CURRENT_USER_IE_PROXY_CONFIG 構造体へのポインターを指定します。出力時には、この構造体に現在アクティブなネットワーク接続(例: LAN、ダイヤルアップ、VPN 接続)の Internet Explorer プロキシ設定が格納されます。

戻り値の型: BOOL

公式ドキュメント

現在のユーザーの Internet Explorer プロキシ構成を取得します。

戻り値

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

エラーコード	説明
ERROR_FILE_NOT_FOUND	Internet Explorer のプロキシ設定が見つかりません。
ERROR_WINHTTP_INTERNAL_ERROR	内部エラーが発生しました。
ERROR_NOT_ENOUGH_MEMORY	要求された操作を完了するための十分なメモリがありませんでした。(Windows エラーコード)

解説(Remarks)

Internet Explorer では、プロキシ設定は ツール / インターネットオプション メニューの接続タブにあります。プロキシ設定は接続ごとに構成されます。つまり、LAN 接続のプロキシ設定は、ダイヤルアップ接続や VPN 接続のプロキシ設定とは別個のものです。WinHttpGetIEProxyConfigForCurrentUser は、現在アクティブな接続のプロキシ設定を返します。

この関数は、Web Proxy Auto-Discovery (WPAD) プロトコルが実装されていない(つまり、Proxy Auto-Configuration ファイルが利用できない)ネットワーク環境で動作するクライアントアプリケーションに役立ちます。PAC ファイルが利用できない場合、WinHttpGetProxyForUrl 関数は失敗します。WinHttpGetIEProxyConfigForCurrentUser 関数は、Internet Explorer のユーザーのプロキシ構成を取得することで、動作可能なプロキシ構成を見つけるためのフォールバック手段として使用できます。

この関数は、ログオンユーザーを偽装しないサービスプロセスでは使用しないでください。呼び出し元がログオンユーザーを偽装しない場合、WinHTTP は現在のサービスプロセス(例: ローカルサービスやネットワークサービス)の Internet Explorer 設定の取得を試みます。これらのシステムアカウントに対して Internet Explorer 設定が構成されていない場合、WinHttpGetIEProxyConfigForCurrentUser の呼び出しは失敗します。

呼び出し元は、WINHTTP_CURRENT_USER_IE_PROXY_CONFIG 構造体内の lpszProxy、lpszProxyBypass、lpszAutoConfigUrl 文字列が非 NULL の場合、それらを解放する必要があります。文字列を解放するには GlobalFree を使用します。

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

各言語での呼び出し定義

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

BOOL WinHttpGetIEProxyConfigForCurrentUser(
    WINHTTP_CURRENT_USER_IE_PROXY_CONFIG* pProxyConfig
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WINHTTP.dll", SetLastError = true, ExactSpelling = true)]
static extern bool WinHttpGetIEProxyConfigForCurrentUser(
    IntPtr pProxyConfig   // WINHTTP_CURRENT_USER_IE_PROXY_CONFIG* in/out
);

<DllImport("WINHTTP.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function WinHttpGetIEProxyConfigForCurrentUser(
    pProxyConfig As IntPtr   ' WINHTTP_CURRENT_USER_IE_PROXY_CONFIG* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' pProxyConfig : WINHTTP_CURRENT_USER_IE_PROXY_CONFIG* in/out
Declare PtrSafe Function WinHttpGetIEProxyConfigForCurrentUser Lib "winhttp" ( _
    ByVal pProxyConfig As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

WinHttpGetIEProxyConfigForCurrentUser = ctypes.windll.winhttp.WinHttpGetIEProxyConfigForCurrentUser
WinHttpGetIEProxyConfigForCurrentUser.restype = wintypes.BOOL
WinHttpGetIEProxyConfigForCurrentUser.argtypes = [
    ctypes.c_void_p,  # pProxyConfig : WINHTTP_CURRENT_USER_IE_PROXY_CONFIG* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WINHTTP.dll')
WinHttpGetIEProxyConfigForCurrentUser = Fiddle::Function.new(
  lib['WinHttpGetIEProxyConfigForCurrentUser'],
  [
    Fiddle::TYPE_VOIDP,  # pProxyConfig : WINHTTP_CURRENT_USER_IE_PROXY_CONFIG* in/out
  ],
  Fiddle::TYPE_INT)

#[link(name = "winhttp")]
extern "system" {
    fn WinHttpGetIEProxyConfigForCurrentUser(
        pProxyConfig: *mut WINHTTP_CURRENT_USER_IE_PROXY_CONFIG  // WINHTTP_CURRENT_USER_IE_PROXY_CONFIG* 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 WinHttpGetIEProxyConfigForCurrentUser(IntPtr pProxyConfig);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WINHTTP_WinHttpGetIEProxyConfigForCurrentUser' -Namespace Win32 -PassThru
# $api::WinHttpGetIEProxyConfigForCurrentUser(pProxyConfig)

#uselib "WINHTTP.dll"
#func global WinHttpGetIEProxyConfigForCurrentUser "WinHttpGetIEProxyConfigForCurrentUser" sptr
; WinHttpGetIEProxyConfigForCurrentUser varptr(pProxyConfig)   ; 戻り値は stat
; pProxyConfig : WINHTTP_CURRENT_USER_IE_PROXY_CONFIG* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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