ホーム › Networking.WinHttp › WinHttpSetDefaultProxyConfiguration

WinHttpSetDefaultProxyConfiguration

関数

既定のWinHTTPプロキシ構成を設定する。

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

シグネチャ

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

BOOL WinHttpSetDefaultProxyConfiguration(
    WINHTTP_PROXY_INFO* pProxyInfo
);

パラメーター

名前	型	方向	説明
pProxyInfo	WINHTTP_PROXY_INFO*	inout	既定のプロキシ構成を指定する WINHTTP_PROXY_INFO 型の変数へのポインターです。

戻り値の型: BOOL

公式ドキュメント

レジストリに既定の WinHTTP プロキシ構成を設定します。

戻り値

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

エラーコード	説明
ERROR_WINHTTP_INTERNAL_ERROR	内部エラーが発生しました。
ERROR_NOT_ENOUGH_MEMORY	要求された操作を完了するのに十分なメモリがありませんでした。(Windows エラーコード)

解説(Remarks)

WinHttpSetDefaultProxyConfiguration によって設定された既定のプロキシ構成は、 WinHttpSetOption を呼び出して WINHTTP_OPTION_PROXY フラグを指定することで、既存の WinHTTP セッションに対して上書きできます。既定のプロキシ構成は、 WinHttpOpen 関数で構成を指定することにより、新しいセッションに対して上書きできます。

pProxyInfo が指す WINHTTP_PROXY_INFO 構造体の dwAccessType メンバーは、プロキシを指定する場合は WINHTTP_ACCESS_TYPE_NAMED_PROXY に設定する必要があります。それ以外の場合は WINHTTP_ACCESS_TYPE_DEFAULT_PROXY に設定します。

この関数を呼び出した後に作成される新しいセッションは、新しい既定のプロキシ構成を使用します。

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

注意 Windows XP および Windows 2000 については、WinHTTP スタートページの実行時の要件セクションを参照してください。

例

次のコード例は、レジストリに既定のプロキシ構成を設定する方法を示しています。

WINHTTP_PROXY_INFO proxyInfo;

// Allocate memory for string members.
proxyInfo.lpszProxy = new WCHAR[25];
proxyInfo.lpszProxyBypass = new WCHAR[25];

// Set the members of the proxy info structure.
proxyInfo.dwAccessType = WINHTTP_ACCESS_TYPE_NAMED_PROXY;
swprintf_s(proxyInfo.lpszProxy, 25, L"proxy_server");
swprintf_s(proxyInfo.lpszProxyBypass, 25, L"<local>");

// Set the default proxy configuration.
if (WinHttpSetDefaultProxyConfiguration( &proxyInfo ))
    printf("Proxy Configuration Set.\n");

// Free memory allocated to the strings.
delete [] proxyInfo.lpszProxy;
delete [] proxyInfo.lpszProxyBypass;

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

各言語での呼び出し定義

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

BOOL WinHttpSetDefaultProxyConfiguration(
    WINHTTP_PROXY_INFO* pProxyInfo
);

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

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

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

import ctypes
from ctypes import wintypes

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

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WINHTTP.dll')
WinHttpSetDefaultProxyConfiguration = Fiddle::Function.new(
  lib['WinHttpSetDefaultProxyConfiguration'],
  [
    Fiddle::TYPE_VOIDP,  # pProxyInfo : WINHTTP_PROXY_INFO* in/out
  ],
  Fiddle::TYPE_INT)

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

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

出力引数:

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