com.github.markusbernhardt.proxy.jna.win

Interface WinHttp

All Superinterfaces:

com.sun.jna.AltCallingConvention, com.sun.jna.Library, com.sun.jna.win32.StdCall, com.sun.jna.win32.StdCallLibrary

public interface WinHttp
extends com.sun.jna.win32.StdCallLibrary

WinHttp.dll Interface.

Author:

Markus Bernhardt, Copyright 2016

Nested Class Summary

Nested classes/interfaces inherited from interface com.sun.jna.win32.StdCallLibrary

com.sun.jna.win32.StdCallLibrary.StdCallCallback

Nested classes/interfaces inherited from interface com.sun.jna.Library

com.sun.jna.Library.Handler

Field Summary

Fields

Modifier and Type	Field and Description
static int	ERROR_WINHTTP_AUTODETECTION_FAILED Returned if WinHTTP was unable to discover the URL of the Proxy Auto-Configuration (PAC) file using the WPAD method.
static WinHttp	INSTANCE
static int	WINHTTP_ACCESS_TYPE_DEFAULT_PROXY Resolves all host names directly without a proxy.
static int	WINHTTP_ACCESS_TYPE_NAMED_PROXY Passes requests to the proxy unless a proxy bypass list is supplied and the name to be resolved bypasses the proxy.
static int	WINHTTP_ACCESS_TYPE_NO_PROXY Retrieves the static proxy or direct configuration from the registry.
static int	WINHTTP_AUTO_DETECT_TYPE_DHCP Use DHCP to locate the proxy auto-configuration file.
static int	WINHTTP_AUTO_DETECT_TYPE_DNS_A Use DNS to attempt to locate the proxy auto-configuration file at a well-known location on the domain of the local computer.

Fields inherited from interface com.sun.jna.win32.StdCallLibrary

FUNCTION_MAPPER, STDCALL_CONVENTION

Fields inherited from interface com.sun.jna.Library

OPTION_ALLOW_OBJECTS, OPTION_CALLING_CONVENTION, OPTION_CLASSLOADER, OPTION_FUNCTION_MAPPER, OPTION_INVOCATION_MAPPER, OPTION_OPEN_FLAGS, OPTION_STRING_ENCODING, OPTION_STRUCTURE_ALIGNMENT, OPTION_TYPE_MAPPER

Method Summary

Modifier and Type	Method and Description
boolean	WinHttpDetectAutoProxyConfigUrl(com.sun.jna.platform.win32.WinDef.DWORD dwAutoDetectFlags, WTypes2.LPWSTRByReference ppwszAutoConfigUrl) The WinHttpDetectAutoProxyConfigUrl function finds the URL for the Proxy Auto-Configuration (PAC) file.
boolean	WinHttpGetDefaultProxyConfiguration(WinHttpProxyInfo pProxyInfo) The WinHttpGetDefaultProxyConfiguration function retrieves the default WinHTTP proxy configuration from the registry.
boolean	WinHttpGetIEProxyConfigForCurrentUser(WinHttpCurrentUserIEProxyConfig pProxyConfig) The WinHttpGetIEProxyConfigForCurrentUser function retrieves the Internet Explorer proxy configuration for the current user.

Field Detail

INSTANCE

static final WinHttp INSTANCE

WINHTTP_AUTO_DETECT_TYPE_DHCP

static final int WINHTTP_AUTO_DETECT_TYPE_DHCP

Use DHCP to locate the proxy auto-configuration file.

See Also:

Constant Field Values

WINHTTP_AUTO_DETECT_TYPE_DNS_A

static final int WINHTTP_AUTO_DETECT_TYPE_DNS_A

Use DNS to attempt to locate the proxy auto-configuration file at a well-known location on the domain of the local computer.

See Also:

Constant Field Values

WINHTTP_ACCESS_TYPE_DEFAULT_PROXY

static final int WINHTTP_ACCESS_TYPE_DEFAULT_PROXY

Resolves all host names directly without a proxy.

See Also:

Constant Field Values

ERROR_WINHTTP_AUTODETECTION_FAILED

static final int ERROR_WINHTTP_AUTODETECTION_FAILED

Returned if WinHTTP was unable to discover the URL of the Proxy Auto-Configuration (PAC) file using the WPAD method.

See Also:

Constant Field Values

WINHTTP_ACCESS_TYPE_NO_PROXY

static final int WINHTTP_ACCESS_TYPE_NO_PROXY

Retrieves the static proxy or direct configuration from the registry. WINHTTP_ACCESS_TYPE_DEFAULT_PROXY does not inherit browser proxy settings. WinHTTP does not share any proxy settings with Internet Explorer.

The WinHTTP proxy configuration is set by one of these mechanisms.

• The proxycfg.exe utility on Windows XP and Windows Server 2003 or earlier.
• The netsh.exe utility on Windows Vista and Windows Server 2008 or later.
• WinHttpSetDefaultProxyConfiguration on all platforms.

See Also:

Constant Field Values

WINHTTP_ACCESS_TYPE_NAMED_PROXY

static final int WINHTTP_ACCESS_TYPE_NAMED_PROXY

Passes requests to the proxy unless a proxy bypass list is supplied and the name to be resolved bypasses the proxy. In this case, this function uses WINHTTP_ACCESS_TYPE_NAMED_PROXY.

See Also:

Constant Field Values

Method Detail

WinHttpDetectAutoProxyConfigUrl

boolean WinHttpDetectAutoProxyConfigUrl(com.sun.jna.platform.win32.WinDef.DWORD dwAutoDetectFlags,
                                        WTypes2.LPWSTRByReference ppwszAutoConfigUrl)
                                 throws com.sun.jna.LastErrorException

The WinHttpDetectAutoProxyConfigUrl function finds the URL for the Proxy Auto-Configuration (PAC) file. This function reports the URL of the PAC file, but it does not download the file.

Parameters:

dwAutoDetectFlags - A data type that specifies what protocols to use to locate the PAC file. If both the DHCP and DNS auto detect flags are set, DHCP is used first; if no PAC URL is discovered using DHCP, then DNS is used. Set WINHTTP_AUTO_DETECT_TYPE_DHCP, WINHTTP_AUTO_DETECT_TYPE_DNS_A or both.

ppwszAutoConfigUrl - A data type that returns a pointer to a null-terminated Unicode string that contains the configuration URL that receives the proxy data. You must free the string pointed to by ppwszAutoConfigUrl using the GlobalFree function.

Returns:

true if successful; otherwise, false.

Throws:

com.sun.jna.LastErrorException

See Also:

WinHttpHelpers.detectAutoProxyConfigUrl(com.sun.jna.platform.win32.WinDef.DWORD)

WinHttpGetDefaultProxyConfiguration

boolean WinHttpGetDefaultProxyConfiguration(WinHttpProxyInfo pProxyInfo)

The WinHttpGetDefaultProxyConfiguration function retrieves the default WinHTTP proxy configuration from the registry.

Parameters:

pProxyInfo - A pointer to a variable of type WINHTTP_PROXY_INFO that receives the default proxy configuration.

Returns:

true if successful; otherwise, false.

WinHttpGetIEProxyConfigForCurrentUser

boolean WinHttpGetIEProxyConfigForCurrentUser(WinHttpCurrentUserIEProxyConfig pProxyConfig)

The WinHttpGetIEProxyConfigForCurrentUser function retrieves the Internet Explorer proxy configuration for the current user.

Parameters:

pProxyConfig - A pointer, on input, to a WINHTTP_CURRENT_USER_IE_PROXY_CONFIG structure. On output, the structure contains the Internet Explorer proxy settings for the current active network connection (for example, LAN, dial-up, or VPN connection).

Returns:

true if successful; otherwise, false.