Platforms to show: All Mac Windows Linux Cross-Platform
Back to CFProxyMBS class.
CFProxyMBS.kCFNetworkProxiesExceptionsList as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreFoundation Network | MBS MacCF Plugin | 14.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Value is an array of strings.
CFProxyMBS.kCFNetworkProxiesExcludeSimpleHostnames as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreFoundation Network | MBS MacCF Plugin | 14.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Value is a number.
Simple hostnames will be excluded if the key is present and has a non-zero value.
CFProxyMBS.kCFNetworkProxiesFTPEnable as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreFoundation Network | MBS MacCF Plugin | 14.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Value is a number.
The proxy is enabled if the key is present and has a non-zero value.
CFProxyMBS.kCFNetworkProxiesFTPPassive as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreFoundation Network | MBS MacCF Plugin | 14.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Value is a Number.
A value of one indicates that passive mode is enabled, a value of zero indicates that passive mode is not enabled.
CFProxyMBS.kCFNetworkProxiesFTPPort as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreFoundation Network | MBS MacCF Plugin | 14.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Value is a number which is the port number.
CFProxyMBS.kCFNetworkProxiesFTPProxy as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreFoundation Network | MBS MacCF Plugin | 14.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Value is a string which is the proxy host name.
CFProxyMBS.kCFNetworkProxiesHTTPPort as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreFoundation Network | MBS MacCF Plugin | 14.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Value is a number which is the port number.
CFProxyMBS.kCFNetworkProxiesHTTPProxy as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreFoundation Network | MBS MacCF Plugin | 14.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Value is a string which is the proxy host name.
CFProxyMBS.kCFNetworkProxiesHTTPSEnable as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreFoundation Network | MBS MacCF Plugin | 14.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
The proxy is enabled if the key is present and has a non-zero value.
CFProxyMBS.kCFNetworkProxiesHTTPSPort as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreFoundation Network | MBS MacCF Plugin | 14.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Value is a Number which is the port number.
CFProxyMBS.kCFNetworkProxiesHTTPSProxy as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreFoundation Network | MBS MacCF Plugin | 14.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Value is a string which is the proxy host name.
CFProxyMBS.kCFNetworkProxiesProxyAutoConfigEnable as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreFoundation Network | MBS MacCF Plugin | 14.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Value is a number.
ProxyAutoConfig is enabled if the key is present and has a non-zero value.
CFProxyMBS.kCFNetworkProxiesProxyAutoConfigURLString as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreFoundation Network | MBS MacCF Plugin | 14.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Value is a string which is url for the PAC file.
CFProxyMBS.kCFNetworkProxiesProxyAutoDiscoveryEnable as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreFoundation Network | MBS MacCF Plugin | 14.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Value is a number.
Proxy auto discovery is enabled if the key is present and has a non-zero value.
CFProxyMBS.kCFNetworkProxiesRTSPEnable as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreFoundation Network | MBS MacCF Plugin | 14.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Value is a Number.
The proxy is enabled if the key is present and has a non-zero value.
CFProxyMBS.kCFNetworkProxiesRTSPPort as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreFoundation Network | MBS MacCF Plugin | 14.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Value is a Number which is the port number.
CFProxyMBS.kCFNetworkProxiesRTSPProxy as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreFoundation Network | MBS MacCF Plugin | 14.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Value is a string which is the proxy host name.
CFProxyMBS.kCFNetworkProxiesSOCKSEnable as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreFoundation Network | MBS MacCF Plugin | 14.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Value is a number.
The proxy is enabled if the key is present and has a non-zero value.
CFProxyMBS.kCFNetworkProxiesSOCKSPort as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreFoundation Network | MBS MacCF Plugin | 14.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Value is a Number which is the port number.
CFProxyMBS.kCFNetworkProxiesSOCKSProxy as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreFoundation Network | MBS MacCF Plugin | 14.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
value is a String which is the proxy host name.
CFProxyMBS.kCFProxyAutoConfigurationJavaScriptKey as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreFoundation Network | MBS MacCF Plugin | 14.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
The value is a String that contains the full JavaScript soure text for the PAC file.
CFProxyMBS.kCFProxyAutoConfigurationURLKey as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreFoundation Network | MBS MacCF Plugin | 14.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
This key is only present if the proxy's type is kCFProxyTypeAutoConfigurationURL. Value is a string with URL specifying the location of a proxy auto-configuration file.
CFProxyMBS.kCFProxyHostNameKey as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreFoundation Network | MBS MacCF Plugin | 14.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Note that this may be an IPv4 or IPv6 dotted-IP string.
CFProxyMBS.kCFProxyPasswordKey as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreFoundation Network | MBS MacCF Plugin | 14.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Value is a String. Note that this key will only be present if the username could be extracted from the information passed in. No external credential stores (like the Keychain) are consulted.
CFProxyMBS.kCFProxyPortNumberKey as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreFoundation Network | MBS MacCF Plugin | 14.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Value is a CFNumber specifying the port on which to contact the proxy.
CFProxyMBS.kCFProxyTypeAutoConfigurationJavaScript as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreFoundation Network | MBS MacCF Plugin | 14.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
The proxy is specified by a proxy autoconfiguration (PAC) file content.
CFProxyMBS.kCFProxyTypeAutoConfigurationURL as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreFoundation Network | MBS MacCF Plugin | 14.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
The proxy is specified by a proxy autoconfiguration (PAC) file.
CFProxyMBS.kCFProxyTypeFTP as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreFoundation Network | MBS MacCF Plugin | 14.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
The proxy is an FTP proxy.
CFProxyMBS.kCFProxyTypeHTTP as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreFoundation Network | MBS MacCF Plugin | 14.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
The proxy is an HTTP proxy.
CFProxyMBS.kCFProxyTypeHTTPS as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreFoundation Network | MBS MacCF Plugin | 14.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
The proxy is a tunneling proxy as used for HTTPS.
CFProxyMBS.kCFProxyTypeKey as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreFoundation Network | MBS MacCF Plugin | 14.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
value will be one of the kCFProxyType* constants listed below.
CFProxyMBS.kCFProxyTypeNone as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreFoundation Network | MBS MacCF Plugin | 14.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
No proxy should be used; contact the origin server directly.
CFProxyMBS.kCFProxyTypeSOCKS as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreFoundation Network | MBS MacCF Plugin | 14.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
The proxy is a SOCKS proxy.
CFProxyMBS.kCFProxyUsernameKey as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreFoundation Network | MBS MacCF Plugin | 14.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Value is a String. Note that this key will only be present if the username could be extracted from the information passed in. No external credential stores (like the Keychain) are consulted.
CFProxyMBS.ProxiesForAutoConfigurationScript(proxyAutoConfigurationScript as string, URL as string, byref error as CFErrorMBS) as Dictionary()
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreFoundation Network | MBS MacCF Plugin | 14.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Synchronously executes the given proxy autoconfiguration script and returns a valid proxyList and nil error upon success or a
nil proxyList and valid error on failure.
proxyAutoConfigurationScript: A string containing the code of the script to be executed.
targetURL: The URL that should be input in to the autoconfiguration script.
error: A return argument that will contain a valid error in case of failure.
Returns an array of dictionaries describing the proxies returned by the script or nil on failure.
Some examples using this method:
CFProxyMBS.ProxiesForURL(URL as string, proxySettings as Dictionary = nil) as Dictionary()
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreFoundation Network | MBS MacCF Plugin | 14.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
url: The URL to be accessed
proxySettings: A dictionary describing the available proxy settings; the dictionary's format should match the dictionary returned by SystemProxySettings described below. If you pass nil, the plugin queries SystemProxySettings functions for you.
Returns an array of dictionaries; each dictionary describes a single proxy. See the comment at the top of this file for how to interpret the returned dictionaries.
Some examples using this method:
CFProxyMBS.SystemProxySettings as Dictionary
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreFoundation Network | MBS MacCF Plugin | 14.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Returns a dictionary containing key-value pairs that represent the current internet proxy settings.
Value is nil if no proxy settings have been defined or if an error was encountered.
Some examples using this method:
The items on this page are in the following plugins: MBS MacCF Plugin.