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

WinHttpResetAutoProxy

関数
自動プロキシ構成のキャッシュをリセットする。
DLLWINHTTP.dll呼出規約winapi対応OSwindows8.0

シグネチャ

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

DWORD WinHttpResetAutoProxy(
    void* hSession,
    DWORD dwFlags
);

パラメーター

名前方向説明
hSessionvoid*in以前の WinHttpOpen 関数の呼び出しによって返された、有効な HINTERNET WinHTTP セッションハンドル。
dwFlagsDWORDin

リセット操作に影響するフラグのセットです。

Winhttp.h ヘッダーファイルで定義されている、次のフラグがサポートされています。

意味
WINHTTP_RESET_STATE
0x00000001
現在のネットワーク上の非永続的なプロキシ情報のフラッシュと再試行を強制します。
WINHTTP_RESET_SWPAD_CURRENT_NETWORK
0x00000002
現在のネットワークの PAD 情報をフラッシュします。
WINHTTP_RESET_SWPAD_ALL
0x00000004
すべてのネットワークの PAD 情報をフラッシュします。
WINHTTP_RESET_SCRIPT_CACHE
0x00000008
プロキシスクリプトの永続的な HTTP キャッシュをフラッシュします。
WINHTTP_RESET_ALL
0x0000FFFF
現在のネットワーク上のすべてのプロキシ情報のフラッシュと再試行を強制します。
WINHTTP_RESET_NOTIFY_NETWORK_CHANGED
0x00010000
現在のプロキシ情報をフラッシュし、ネットワークが変更されたことを通知します。
WINHTTP_RESET_OUT_OF_PROC
0x00020000
現在のプロセスではなく、autoproxy サービスに対して動作します。
注意 このフラグは必須です。

WinHttpGetProxyForUrl 関数を使用してプロセス内キャッシュを消去するアプリケーションは、hInternet ハンドルを閉じ、以降の呼び出しのために新しいハンドルを開く必要があります。

戻り値の型: DWORD

公式ドキュメント

自動プロキシをリセットします。

戻り値

操作の成否を示すコード。

戻り値コード 説明
ERROR_SUCCESS
操作は成功しました。
ERROR_INVALID_HANDLE
hSession パラメーターが有効なハンドルではありません。
ERROR_WINHTTP_INCORRECT_HANDLE TYPE
hSession パラメーターが WinHttpOpen の呼び出しによって生成されたものではありません。

解説(Remarks)

すべてをリセットするには、dwFlags パラメーターに WINHTTP_RESET_ALLWINHTTP_RESET_OUT_OF_PROC を含めます。

注意 WinHttpResetAutoProxy 関数を続けて呼び出す場合、自動プロキシの状態をリセットするには呼び出しの間に少なくとも 30 秒の間隔が必要です。30 秒未満の場合、WinHttpResetAutoProxy 関数の呼び出しは ERROR_SUCCESS を返すことがありますが、リセットは行われません。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

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

DWORD WinHttpResetAutoProxy(
    void* hSession,
    DWORD dwFlags
);
[DllImport("WINHTTP.dll", ExactSpelling = true)]
static extern uint WinHttpResetAutoProxy(
    IntPtr hSession,   // void*
    uint dwFlags   // DWORD
);
<DllImport("WINHTTP.dll", ExactSpelling:=True)>
Public Shared Function WinHttpResetAutoProxy(
    hSession As IntPtr,   ' void*
    dwFlags As UInteger   ' DWORD
) As UInteger
End Function
' hSession : void*
' dwFlags : DWORD
Declare PtrSafe Function WinHttpResetAutoProxy Lib "winhttp" ( _
    ByVal hSession As LongPtr, _
    ByVal dwFlags As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

WinHttpResetAutoProxy = ctypes.windll.winhttp.WinHttpResetAutoProxy
WinHttpResetAutoProxy.restype = wintypes.DWORD
WinHttpResetAutoProxy.argtypes = [
    ctypes.POINTER(None),  # hSession : void*
    wintypes.DWORD,  # dwFlags : DWORD
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WINHTTP.dll')
WinHttpResetAutoProxy = Fiddle::Function.new(
  lib['WinHttpResetAutoProxy'],
  [
    Fiddle::TYPE_VOIDP,  # hSession : void*
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
  ],
  -Fiddle::TYPE_INT)
#[link(name = "winhttp")]
extern "system" {
    fn WinHttpResetAutoProxy(
        hSession: *mut (),  // void*
        dwFlags: u32  // DWORD
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("WINHTTP.dll")]
public static extern uint WinHttpResetAutoProxy(IntPtr hSession, uint dwFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WINHTTP_WinHttpResetAutoProxy' -Namespace Win32 -PassThru
# $api::WinHttpResetAutoProxy(hSession, dwFlags)
#uselib "WINHTTP.dll"
#func global WinHttpResetAutoProxy "WinHttpResetAutoProxy" sptr, sptr
; WinHttpResetAutoProxy hSession, dwFlags   ; 戻り値は stat
; hSession : void* -> "sptr"
; dwFlags : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "WINHTTP.dll"
#cfunc global WinHttpResetAutoProxy "WinHttpResetAutoProxy" sptr, int
; res = WinHttpResetAutoProxy(hSession, dwFlags)
; hSession : void* -> "sptr"
; dwFlags : DWORD -> "int"
; DWORD WinHttpResetAutoProxy(void* hSession, DWORD dwFlags)
#uselib "WINHTTP.dll"
#cfunc global WinHttpResetAutoProxy "WinHttpResetAutoProxy" intptr, int
; res = WinHttpResetAutoProxy(hSession, dwFlags)
; hSession : void* -> "intptr"
; dwFlags : DWORD -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	winhttp = windows.NewLazySystemDLL("WINHTTP.dll")
	procWinHttpResetAutoProxy = winhttp.NewProc("WinHttpResetAutoProxy")
)

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

extern "winhttp" fn WinHttpResetAutoProxy(
    hSession: ?*anyopaque, // void*
    dwFlags: u32 // DWORD
) callconv(std.os.windows.WINAPI) u32;
proc WinHttpResetAutoProxy(
    hSession: pointer,  # void*
    dwFlags: uint32  # DWORD
): uint32 {.importc: "WinHttpResetAutoProxy", stdcall, dynlib: "WINHTTP.dll".}
pragma(lib, "winhttp");
extern(Windows)
uint WinHttpResetAutoProxy(
    void* hSession,   // void*
    uint dwFlags   // DWORD
);
ccall((:WinHttpResetAutoProxy, "WINHTTP.dll"), stdcall, UInt32,
      (Ptr{Cvoid}, UInt32),
      hSession, dwFlags)
# hSession : void* -> Ptr{Cvoid}
# dwFlags : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t WinHttpResetAutoProxy(
    void* hSession,
    uint32_t dwFlags);
]]
local winhttp = ffi.load("winhttp")
-- winhttp.WinHttpResetAutoProxy(hSession, dwFlags)
-- hSession : void*
-- dwFlags : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('WINHTTP.dll');
const WinHttpResetAutoProxy = lib.func('__stdcall', 'WinHttpResetAutoProxy', 'uint32_t', ['void *', 'uint32_t']);
// WinHttpResetAutoProxy(hSession, dwFlags)
// hSession : void* -> 'void *'
// dwFlags : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("WINHTTP.dll", {
  WinHttpResetAutoProxy: { parameters: ["pointer", "u32"], result: "u32" },
});
// lib.symbols.WinHttpResetAutoProxy(hSession, dwFlags)
// hSession : void* -> "pointer"
// dwFlags : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t WinHttpResetAutoProxy(
    void* hSession,
    uint32_t dwFlags);
C, "WINHTTP.dll");
// $ffi->WinHttpResetAutoProxy(hSession, dwFlags);
// hSession : void*
// dwFlags : DWORD
// 構造体/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);
    int WinHttpResetAutoProxy(
        Pointer hSession,   // void*
        int dwFlags   // DWORD
    );
}
@[Link("winhttp")]
lib LibWINHTTP
  fun WinHttpResetAutoProxy = WinHttpResetAutoProxy(
    hSession : Void*,   # void*
    dwFlags : UInt32   # DWORD
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef WinHttpResetAutoProxyNative = Uint32 Function(Pointer<Void>, Uint32);
typedef WinHttpResetAutoProxyDart = int Function(Pointer<Void>, int);
final WinHttpResetAutoProxy = DynamicLibrary.open('WINHTTP.dll')
    .lookupFunction<WinHttpResetAutoProxyNative, WinHttpResetAutoProxyDart>('WinHttpResetAutoProxy');
// hSession : void* -> Pointer<Void>
// dwFlags : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function WinHttpResetAutoProxy(
  hSession: Pointer;   // void*
  dwFlags: DWORD   // DWORD
): DWORD; stdcall;
  external 'WINHTTP.dll' name 'WinHttpResetAutoProxy';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "WinHttpResetAutoProxy"
  c_WinHttpResetAutoProxy :: Ptr () -> Word32 -> IO Word32
-- hSession : void* -> Ptr ()
-- dwFlags : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let winhttpresetautoproxy =
  foreign "WinHttpResetAutoProxy"
    ((ptr void) @-> uint32_t @-> returning uint32_t)
(* hSession : void* -> (ptr void) *)
(* dwFlags : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library winhttp (t "WINHTTP.dll"))
(cffi:use-foreign-library winhttp)

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