ホーム › Networking.WinHttp › WinHttpGetProxySettingsEx

WinHttpGetProxySettingsEx

関数

拡張プロキシ設定を非同期で取得する。

DLLWINHTTP.dll呼出規約winapi

シグネチャ

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

DWORD WinHttpGetProxySettingsEx(
    void* hResolver,
    WINHTTP_PROXY_SETTINGS_TYPE ProxySettingsType,
    WINHTTP_PROXY_SETTINGS_PARAM* pProxySettingsParam,   // optional
    UINT_PTR pContext   // optional
);

パラメーター

名前	型	方向	説明
hResolver	void*	in	WinHttpCreateProxyResolver 関数によって返される WinHTTP リゾルバーハンドルです。
ProxySettingsType	WINHTTP_PROXY_SETTINGS_TYPE	in	プロキシ設定の種類です。
pProxySettingsParam	WINHTTP_PROXY_SETTINGS_PARAM*	inoptional	WINHTTP_PROXY_SETTINGS_PARAM への省略可能なポインターです。
pContext	UINT_PTR	inoptional	完了コールバック関数に渡されるコンテキストデータを格納する DWORD への省略可能なポインターです。

戻り値の型: DWORD

公式ドキュメント

拡張プロキシ設定を取得します。

戻り値

操作の結果を示すステータスコードを格納する DWORD です。以下のコードが返される可能性があります(これがすべてではありません)。

コード	説明
ERROR_IO_PENDING	操作は非同期で継続中です。

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

各言語での呼び出し定義

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

DWORD WinHttpGetProxySettingsEx(
    void* hResolver,
    WINHTTP_PROXY_SETTINGS_TYPE ProxySettingsType,
    WINHTTP_PROXY_SETTINGS_PARAM* pProxySettingsParam,   // optional
    UINT_PTR pContext   // optional
);

[DllImport("WINHTTP.dll", ExactSpelling = true)]
static extern uint WinHttpGetProxySettingsEx(
    IntPtr hResolver,   // void*
    int ProxySettingsType,   // WINHTTP_PROXY_SETTINGS_TYPE
    IntPtr pProxySettingsParam,   // WINHTTP_PROXY_SETTINGS_PARAM* optional
    UIntPtr pContext   // UINT_PTR optional
);

<DllImport("WINHTTP.dll", ExactSpelling:=True)>
Public Shared Function WinHttpGetProxySettingsEx(
    hResolver As IntPtr,   ' void*
    ProxySettingsType As Integer,   ' WINHTTP_PROXY_SETTINGS_TYPE
    pProxySettingsParam As IntPtr,   ' WINHTTP_PROXY_SETTINGS_PARAM* optional
    pContext As UIntPtr   ' UINT_PTR optional
) As UInteger
End Function

' hResolver : void*
' ProxySettingsType : WINHTTP_PROXY_SETTINGS_TYPE
' pProxySettingsParam : WINHTTP_PROXY_SETTINGS_PARAM* optional
' pContext : UINT_PTR optional
Declare PtrSafe Function WinHttpGetProxySettingsEx Lib "winhttp" ( _
    ByVal hResolver As LongPtr, _
    ByVal ProxySettingsType As Long, _
    ByVal pProxySettingsParam As LongPtr, _
    ByVal pContext As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

WinHttpGetProxySettingsEx = ctypes.windll.winhttp.WinHttpGetProxySettingsEx
WinHttpGetProxySettingsEx.restype = wintypes.DWORD
WinHttpGetProxySettingsEx.argtypes = [
    ctypes.POINTER(None),  # hResolver : void*
    ctypes.c_int,  # ProxySettingsType : WINHTTP_PROXY_SETTINGS_TYPE
    ctypes.c_void_p,  # pProxySettingsParam : WINHTTP_PROXY_SETTINGS_PARAM* optional
    ctypes.c_size_t,  # pContext : UINT_PTR optional
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WINHTTP.dll')
WinHttpGetProxySettingsEx = Fiddle::Function.new(
  lib['WinHttpGetProxySettingsEx'],
  [
    Fiddle::TYPE_VOIDP,  # hResolver : void*
    Fiddle::TYPE_INT,  # ProxySettingsType : WINHTTP_PROXY_SETTINGS_TYPE
    Fiddle::TYPE_VOIDP,  # pProxySettingsParam : WINHTTP_PROXY_SETTINGS_PARAM* optional
    Fiddle::TYPE_UINTPTR_T,  # pContext : UINT_PTR optional
  ],
  -Fiddle::TYPE_INT)

#[link(name = "winhttp")]
extern "system" {
    fn WinHttpGetProxySettingsEx(
        hResolver: *mut (),  // void*
        ProxySettingsType: i32,  // WINHTTP_PROXY_SETTINGS_TYPE
        pProxySettingsParam: *mut WINHTTP_PROXY_SETTINGS_PARAM,  // WINHTTP_PROXY_SETTINGS_PARAM* optional
        pContext: usize  // UINT_PTR optional
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("WINHTTP.dll")]
public static extern uint WinHttpGetProxySettingsEx(IntPtr hResolver, int ProxySettingsType, IntPtr pProxySettingsParam, UIntPtr pContext);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WINHTTP_WinHttpGetProxySettingsEx' -Namespace Win32 -PassThru
# $api::WinHttpGetProxySettingsEx(hResolver, ProxySettingsType, pProxySettingsParam, pContext)

#uselib "WINHTTP.dll"
#func global WinHttpGetProxySettingsEx "WinHttpGetProxySettingsEx" sptr, sptr, sptr, sptr
; WinHttpGetProxySettingsEx hResolver, ProxySettingsType, varptr(pProxySettingsParam), pContext   ; 戻り値は stat
; hResolver : void* -> "sptr"
; ProxySettingsType : WINHTTP_PROXY_SETTINGS_TYPE -> "sptr"
; pProxySettingsParam : WINHTTP_PROXY_SETTINGS_PARAM* optional -> "sptr"
; pContext : UINT_PTR optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "WINHTTP.dll"
#cfunc global WinHttpGetProxySettingsEx "WinHttpGetProxySettingsEx" sptr, int, var, sptr
; res = WinHttpGetProxySettingsEx(hResolver, ProxySettingsType, pProxySettingsParam, pContext)
; hResolver : void* -> "sptr"
; ProxySettingsType : WINHTTP_PROXY_SETTINGS_TYPE -> "int"
; pProxySettingsParam : WINHTTP_PROXY_SETTINGS_PARAM* optional -> "var"
; pContext : UINT_PTR optional -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "WINHTTP.dll"
#cfunc global WinHttpGetProxySettingsEx "WinHttpGetProxySettingsEx" sptr, int, sptr, sptr
; res = WinHttpGetProxySettingsEx(hResolver, ProxySettingsType, varptr(pProxySettingsParam), pContext)
; hResolver : void* -> "sptr"
; ProxySettingsType : WINHTTP_PROXY_SETTINGS_TYPE -> "int"
; pProxySettingsParam : WINHTTP_PROXY_SETTINGS_PARAM* optional -> "sptr"
; pContext : UINT_PTR optional -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。