Win32 API 日本語リファレンス
ホームNetworking.WinHttp › WinHttpDetectAutoProxyConfigUrl

WinHttpDetectAutoProxyConfigUrl

関数
自動プロキシ構成スクリプトのURLを自動検出する。
DLLWINHTTP.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

BOOL WinHttpDetectAutoProxyConfigUrl(
    DWORD dwAutoDetectFlags,
    LPWSTR* ppwstrAutoConfigUrl
);

パラメーター

名前方向説明
dwAutoDetectFlagsDWORDin

PAC ファイルを特定するために使用するプロトコルを指定するデータ型です。DHCP と DNS の両方の自動検出フラグが設定されている場合は、最初に DHCP が使用されます。DHCP で PAC URL が検出されなかった場合は、続いて DNS が使用されます。

Value Meaning
WINHTTP_AUTO_DETECT_TYPE_DHCP
DHCP を使用してプロキシ自動構成ファイルを特定します。
WINHTTP_AUTO_DETECT_TYPE_DNS_A
DNS を使用して、ローカル コンピューターのドメイン上の既知の場所にあるプロキシ自動構成ファイルの特定を試みます。
ppwstrAutoConfigUrlLPWSTR*outプロキシ データを受け取る構成 URL を含む null 終端 Unicode 文字列へのポインターを返すデータ型です。ppwszAutoConfigUrl が指す文字列は、GlobalFree 関数を使用して解放する必要があります。

戻り値の型: BOOL

公式ドキュメント

プロキシ自動構成 (PAC) ファイルの URL を検索します。

戻り値

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

Error Code Description
ERROR_WINHTTP_AUTODETECTION_FAILED
WinHTTP がプロキシ自動構成 (PAC) ファイルの URL を検出できなかった場合に返されます。
ERROR_WINHTTP_INTERNAL_ERROR
内部エラーが発生しました。
ERROR_NOT_ENOUGH_MEMORY
要求された操作を完了するための十分なメモリがありませんでした。(Windows エラー コード)

解説(Remarks)

WinHTTP は、しばしば autoproxy と呼ばれる Web Proxy Auto-Discovery (WPAD) プロトコルを実装しています。既知の場所の詳細については、WPAD プロトコル ドキュメントの Discovery Process セクションを参照してください。

WinHttpDetectAutoProxyConfigUrl 関数は処理の完了に時間がかかるため、UI スレッドから呼び出すべきではないことに注意してください。

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

各言語での呼び出し定義

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

BOOL WinHttpDetectAutoProxyConfigUrl(
    DWORD dwAutoDetectFlags,
    LPWSTR* ppwstrAutoConfigUrl
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WINHTTP.dll", SetLastError = true, ExactSpelling = true)]
static extern bool WinHttpDetectAutoProxyConfigUrl(
    uint dwAutoDetectFlags,   // DWORD
    IntPtr ppwstrAutoConfigUrl   // LPWSTR* out
);
<DllImport("WINHTTP.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function WinHttpDetectAutoProxyConfigUrl(
    dwAutoDetectFlags As UInteger,   ' DWORD
    ppwstrAutoConfigUrl As IntPtr   ' LPWSTR* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' dwAutoDetectFlags : DWORD
' ppwstrAutoConfigUrl : LPWSTR* out
Declare PtrSafe Function WinHttpDetectAutoProxyConfigUrl Lib "winhttp" ( _
    ByVal dwAutoDetectFlags As Long, _
    ByVal ppwstrAutoConfigUrl As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

WinHttpDetectAutoProxyConfigUrl = ctypes.windll.winhttp.WinHttpDetectAutoProxyConfigUrl
WinHttpDetectAutoProxyConfigUrl.restype = wintypes.BOOL
WinHttpDetectAutoProxyConfigUrl.argtypes = [
    wintypes.DWORD,  # dwAutoDetectFlags : DWORD
    ctypes.c_void_p,  # ppwstrAutoConfigUrl : LPWSTR* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WINHTTP.dll')
WinHttpDetectAutoProxyConfigUrl = Fiddle::Function.new(
  lib['WinHttpDetectAutoProxyConfigUrl'],
  [
    -Fiddle::TYPE_INT,  # dwAutoDetectFlags : DWORD
    Fiddle::TYPE_VOIDP,  # ppwstrAutoConfigUrl : LPWSTR* out
  ],
  Fiddle::TYPE_INT)
#[link(name = "winhttp")]
extern "system" {
    fn WinHttpDetectAutoProxyConfigUrl(
        dwAutoDetectFlags: u32,  // DWORD
        ppwstrAutoConfigUrl: *mut *mut u16  // LPWSTR* 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 WinHttpDetectAutoProxyConfigUrl(uint dwAutoDetectFlags, IntPtr ppwstrAutoConfigUrl);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WINHTTP_WinHttpDetectAutoProxyConfigUrl' -Namespace Win32 -PassThru
# $api::WinHttpDetectAutoProxyConfigUrl(dwAutoDetectFlags, ppwstrAutoConfigUrl)
#uselib "WINHTTP.dll"
#func global WinHttpDetectAutoProxyConfigUrl "WinHttpDetectAutoProxyConfigUrl" sptr, sptr
; WinHttpDetectAutoProxyConfigUrl dwAutoDetectFlags, varptr(ppwstrAutoConfigUrl)   ; 戻り値は stat
; dwAutoDetectFlags : DWORD -> "sptr"
; ppwstrAutoConfigUrl : LPWSTR* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "WINHTTP.dll"
#cfunc global WinHttpDetectAutoProxyConfigUrl "WinHttpDetectAutoProxyConfigUrl" int, var
; res = WinHttpDetectAutoProxyConfigUrl(dwAutoDetectFlags, ppwstrAutoConfigUrl)
; dwAutoDetectFlags : DWORD -> "int"
; ppwstrAutoConfigUrl : LPWSTR* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL WinHttpDetectAutoProxyConfigUrl(DWORD dwAutoDetectFlags, LPWSTR* ppwstrAutoConfigUrl)
#uselib "WINHTTP.dll"
#cfunc global WinHttpDetectAutoProxyConfigUrl "WinHttpDetectAutoProxyConfigUrl" int, var
; res = WinHttpDetectAutoProxyConfigUrl(dwAutoDetectFlags, ppwstrAutoConfigUrl)
; dwAutoDetectFlags : DWORD -> "int"
; ppwstrAutoConfigUrl : LPWSTR* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	winhttp = windows.NewLazySystemDLL("WINHTTP.dll")
	procWinHttpDetectAutoProxyConfigUrl = winhttp.NewProc("WinHttpDetectAutoProxyConfigUrl")
)

// dwAutoDetectFlags (DWORD), ppwstrAutoConfigUrl (LPWSTR* out)
r1, _, err := procWinHttpDetectAutoProxyConfigUrl.Call(
	uintptr(dwAutoDetectFlags),
	uintptr(ppwstrAutoConfigUrl),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function WinHttpDetectAutoProxyConfigUrl(
  dwAutoDetectFlags: DWORD;   // DWORD
  ppwstrAutoConfigUrl: PPWideChar   // LPWSTR* out
): BOOL; stdcall;
  external 'WINHTTP.dll' name 'WinHttpDetectAutoProxyConfigUrl';
result := DllCall("WINHTTP\WinHttpDetectAutoProxyConfigUrl"
    , "UInt", dwAutoDetectFlags   ; DWORD
    , "Ptr", ppwstrAutoConfigUrl   ; LPWSTR* out
    , "Int")   ; return: BOOL
●WinHttpDetectAutoProxyConfigUrl(dwAutoDetectFlags, ppwstrAutoConfigUrl) = DLL("WINHTTP.dll", "bool WinHttpDetectAutoProxyConfigUrl(dword, void*)")
# 呼び出し: WinHttpDetectAutoProxyConfigUrl(dwAutoDetectFlags, ppwstrAutoConfigUrl)
# dwAutoDetectFlags : DWORD -> "dword"
# ppwstrAutoConfigUrl : LPWSTR* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "winhttp" fn WinHttpDetectAutoProxyConfigUrl(
    dwAutoDetectFlags: u32, // DWORD
    ppwstrAutoConfigUrl: [*c][*c]u16 // LPWSTR* out
) callconv(std.os.windows.WINAPI) i32;
proc WinHttpDetectAutoProxyConfigUrl(
    dwAutoDetectFlags: uint32,  # DWORD
    ppwstrAutoConfigUrl: ptr WideCString  # LPWSTR* out
): int32 {.importc: "WinHttpDetectAutoProxyConfigUrl", stdcall, dynlib: "WINHTTP.dll".}
pragma(lib, "winhttp");
extern(Windows)
int WinHttpDetectAutoProxyConfigUrl(
    uint dwAutoDetectFlags,   // DWORD
    wchar** ppwstrAutoConfigUrl   // LPWSTR* out
);
ccall((:WinHttpDetectAutoProxyConfigUrl, "WINHTTP.dll"), stdcall, Int32,
      (UInt32, Ptr{Ptr{UInt16}}),
      dwAutoDetectFlags, ppwstrAutoConfigUrl)
# dwAutoDetectFlags : DWORD -> UInt32
# ppwstrAutoConfigUrl : LPWSTR* out -> Ptr{Ptr{UInt16}}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t WinHttpDetectAutoProxyConfigUrl(
    uint32_t dwAutoDetectFlags,
    uint16_t** ppwstrAutoConfigUrl);
]]
local winhttp = ffi.load("winhttp")
-- winhttp.WinHttpDetectAutoProxyConfigUrl(dwAutoDetectFlags, ppwstrAutoConfigUrl)
-- dwAutoDetectFlags : DWORD
-- ppwstrAutoConfigUrl : LPWSTR* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('WINHTTP.dll');
const WinHttpDetectAutoProxyConfigUrl = lib.func('__stdcall', 'WinHttpDetectAutoProxyConfigUrl', 'int32_t', ['uint32_t', 'void *']);
// WinHttpDetectAutoProxyConfigUrl(dwAutoDetectFlags, ppwstrAutoConfigUrl)
// dwAutoDetectFlags : DWORD -> 'uint32_t'
// ppwstrAutoConfigUrl : LPWSTR* out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("WINHTTP.dll", {
  WinHttpDetectAutoProxyConfigUrl: { parameters: ["u32", "pointer"], result: "i32" },
});
// lib.symbols.WinHttpDetectAutoProxyConfigUrl(dwAutoDetectFlags, ppwstrAutoConfigUrl)
// dwAutoDetectFlags : DWORD -> "u32"
// ppwstrAutoConfigUrl : LPWSTR* out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t WinHttpDetectAutoProxyConfigUrl(
    uint32_t dwAutoDetectFlags,
    uint16_t** ppwstrAutoConfigUrl);
C, "WINHTTP.dll");
// $ffi->WinHttpDetectAutoProxyConfigUrl(dwAutoDetectFlags, ppwstrAutoConfigUrl);
// dwAutoDetectFlags : DWORD
// ppwstrAutoConfigUrl : LPWSTR* out
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Winhttp extends StdCallLibrary {
    Winhttp INSTANCE = Native.load("winhttp", Winhttp.class);
    boolean WinHttpDetectAutoProxyConfigUrl(
        int dwAutoDetectFlags,   // DWORD
        PointerByReference ppwstrAutoConfigUrl   // LPWSTR* out
    );
}
@[Link("winhttp")]
lib LibWINHTTP
  fun WinHttpDetectAutoProxyConfigUrl = WinHttpDetectAutoProxyConfigUrl(
    dwAutoDetectFlags : UInt32,   # DWORD
    ppwstrAutoConfigUrl : UInt16**   # LPWSTR* out
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef WinHttpDetectAutoProxyConfigUrlNative = Int32 Function(Uint32, Pointer<Pointer<Utf16>>);
typedef WinHttpDetectAutoProxyConfigUrlDart = int Function(int, Pointer<Pointer<Utf16>>);
final WinHttpDetectAutoProxyConfigUrl = DynamicLibrary.open('WINHTTP.dll')
    .lookupFunction<WinHttpDetectAutoProxyConfigUrlNative, WinHttpDetectAutoProxyConfigUrlDart>('WinHttpDetectAutoProxyConfigUrl');
// dwAutoDetectFlags : DWORD -> Uint32
// ppwstrAutoConfigUrl : LPWSTR* out -> Pointer<Pointer<Utf16>>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function WinHttpDetectAutoProxyConfigUrl(
  dwAutoDetectFlags: DWORD;   // DWORD
  ppwstrAutoConfigUrl: PPWideChar   // LPWSTR* out
): BOOL; stdcall;
  external 'WINHTTP.dll' name 'WinHttpDetectAutoProxyConfigUrl';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "WinHttpDetectAutoProxyConfigUrl"
  c_WinHttpDetectAutoProxyConfigUrl :: Word32 -> Ptr CWString -> IO CInt
-- dwAutoDetectFlags : DWORD -> Word32
-- ppwstrAutoConfigUrl : LPWSTR* out -> Ptr CWString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let winhttpdetectautoproxyconfigurl =
  foreign "WinHttpDetectAutoProxyConfigUrl"
    (uint32_t @-> (ptr (ptr uint16_t)) @-> returning int32_t)
(* dwAutoDetectFlags : DWORD -> uint32_t *)
(* ppwstrAutoConfigUrl : LPWSTR* out -> (ptr (ptr uint16_t)) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library winhttp (t "WINHTTP.dll"))
(cffi:use-foreign-library winhttp)

(cffi:defcfun ("WinHttpDetectAutoProxyConfigUrl" win-http-detect-auto-proxy-config-url :convention :stdcall) :int32
  (dw-auto-detect-flags :uint32)   ; DWORD
  (ppwstr-auto-config-url :pointer))   ; LPWSTR* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $WinHttpDetectAutoProxyConfigUrl = Win32::API::More->new('WINHTTP',
    'BOOL WinHttpDetectAutoProxyConfigUrl(DWORD dwAutoDetectFlags, LPVOID ppwstrAutoConfigUrl)');
# my $ret = $WinHttpDetectAutoProxyConfigUrl->Call($dwAutoDetectFlags, $ppwstrAutoConfigUrl);
# dwAutoDetectFlags : DWORD -> DWORD
# ppwstrAutoConfigUrl : LPWSTR* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。