Xojo Conferences
XDCMay2019MiamiUSA

Platforms to show: All Mac Windows Linux Cross-Platform

Previous items Next items

CURLMBS.OptionProtocols as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property CURL MBS CURL Plugin 10.0 Yes Yes Yes Yes No
Function: A bitmask of kProtocol* constants.
Notes:
If used, this bitmask limits what protocols libCURL may use in the transfer. This allows you to have a libCURL built to support a wide range of protocols but still limit specific transfers to only be allowed to use a subset of them. By default libCURL will accept all protocols it supports. See also OptionRedirProtocols. (Added in 7.19.4)
(Read and Write property)

See also PROTOCOLS option in CURL manual.

Feedback, Comments & Corrections

CURLMBS.OptionProxy as String
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property CURL MBS CURL Plugin 9.8 Yes Yes Yes Yes No
Function: Set HTTP proxy to use.
Example:
dim c as CURLMBS // your CURL object
dim psAddress as string // your proxy address
dim psPort as Integer // your proxy port

c.OptionProxy=psAddress
c.OptionProxyPort=psPort
c.OptionProxyType=c.kPROXY_HTTP
Notes:
The Lasterror property is set. 0 for success.
You can set this value and later you can read it, but you cannot read the default value.

The parameter should be a string holding the host name or dotted IP address. To specify port number in this string, append :[port] to the end of the host name. The proxy string may be prefixed with [protocol]:// since any such prefix will be ignored. The proxy's port number may optionally be specified with the separate option ProxyHost.

When you tell the library to use an HTTP proxy, libCURL will transparently convert operations to HTTP even if you specify an FTP URL etc. This may have an impact on what other features of the library you can use, such as CURLOPT_QUOTE and similar FTP specifics that don't work unless you tunnel through the HTTP proxy. Such tunneling is activated with HTTPProxyTunnel.

libCURL respects the environment variables http_proxy, ftp_proxy, all_proxy etc, if any of those is set. The Proxy option does however override any possibly set environment variables.

Starting with 7.14.1, the proxy host string given in environment variables can be specified the exact same way as the proxy can be set with Proxy, include protocol prefix (http://) and embedded user + password.

You can use WinHTTPClientMBS class on Windows or CFProxyMBS on Mac to discover system proxy settings.
(Read and Write property)

See also PROXY option in CURL manual.

Feedback, Comments & Corrections

CURLMBS.OptionProxyAuth as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property CURL MBS CURL Plugin 9.8 Yes Yes Yes Yes No
Function: Which proxy authentication to use.
Notes:
Pass an integer as parameter, which is set to a bitmask, to tell libCURL what authentication method(s) you want it to use for your proxy authentication. If more than one bit is set, libCURL will first query the site to see what authentication methods it supports and then pick the best one you allow it to use. For some methods, this will induce an extra network round-trip. Set the actual name and password with the ProxyUserPassword option. The bitmask can be constructed by or'ing together the bits listed above for the HTTPAuth option. As of this writing, only Basic, Digest and NTLM work. (Added in 7.10.7)

The Lasterror property is set. 0 for success.
You can set this value and later you can read it, but you cannot read the default value.
(Read and Write property)

See also PROXYAUTH option in CURL manual.

Feedback, Comments & Corrections

CURLMBS.OptionProxyCAInfo as String
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property CURL MBS CURL Plugin 18.2 Yes Yes Yes Yes No
Function: The CApath or CAfile used to validate the proxy certificate.
Notes:
Pass native file path.
This option is used only if CURLMBS.OptionProxySSLVerifyPeer is true
(Read and Write property)

See also PROXY_CAINFO option in CURL manual.

Feedback, Comments & Corrections

CURLMBS.OptionProxyCAPath as String
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property CURL MBS CURL Plugin 18.2 Yes Yes Yes Yes No
Function: The CApath directory used to validate the proxy certificate.
Notes:
Pass native file path.
This option is used only if CURLMBS.OptionProxySSLVerifyPeer is true
(Read and Write property)

See also PROXY_CAPATH option in CURL manual.

Feedback, Comments & Corrections

CURLMBS.OptionProxyCRLFile as String
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property CURL MBS CURL Plugin 18.2 Yes Yes Yes Yes No
Function: CRL file for proxy.
Notes:
Pass native file path.
(Read and Write property)

See also PROXY_CRLFILE option in CURL manual.

Feedback, Comments & Corrections

CURLMBS.OptionProxyKeyPassword as String
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property CURL MBS CURL Plugin 18.2 Yes Yes Yes Yes No
Function: Password for the SSL private key for proxy.
Notes: (Read and Write property)

See also PROXY_KEYPASSWD option in CURL manual.

Feedback, Comments & Corrections

CURLMBS.OptionProxyPassword as String
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property CURL MBS CURL Plugin 10.0 Yes Yes Yes Yes No
Function: A string which should be pointing to the password to use for the transfer while connecting to Proxy.
Notes:
The OptionProxyPassword option should be used in conjunction with the OptionProxyUsername option. (Added in 7.19.1)
(Read and Write property)

See also PROXYPASSWORD option in CURL manual.

Feedback, Comments & Corrections

CURLMBS.OptionProxyPinnedPublicKey as String
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property CURL MBS CURL Plugin 18.2 Yes Yes Yes Yes No
Function: The public key in DER form used to validate the proxy public key.
Notes:
This option is used only if CURLMBS.OptionProxySSLVerifyPeer is true.
Please path native file path to key file.
(Read and Write property)

See also PROXY_PINNEDPUBLICKEY option in CURL manual.

Feedback, Comments & Corrections

CURLMBS.OptionProxyPort as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property CURL MBS CURL Plugin 9.8 Yes Yes Yes Yes No
Function: The proxy port to connect to unless it is specified in the proxy string OptionProxy.
Notes:
The Lasterror property is set. 0 for success.
You can set this value and later you can read it, but you cannot read the default value.

You can use OptionProxy with port, e.g. "12.34.56.78:8080" or pass port here and proxy without port.
For some users it seems like the option with OptionProxy including port works better.
(Read and Write property)

See also PROXYPORT option in CURL manual.

Feedback, Comments & Corrections

CURLMBS.OptionProxyServiceName as String
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property CURL MBS CURL Plugin 18.2 Yes Yes Yes Yes No
Function: Proxy Service Name.
Notes: (Read and Write property)

See also PROXY_SERVICE_NAME option in CURL manual.

Feedback, Comments & Corrections

CURLMBS.OptionProxySSLCert as String
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property CURL MBS CURL Plugin 18.2 Yes Yes Yes Yes No
Function: Name of the file keeping your private SSL-certificate for proxy.
Notes: (Read and Write property)

See also PROXY_SSLCERT option in CURL manual.

Feedback, Comments & Corrections

CURLMBS.OptionProxySSLCertType as String
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property CURL MBS CURL Plugin 18.2 Yes Yes Yes Yes No
Function: Type of the file keeping your SSL-certificate for proxy.
Notes:
Value can be "DER", "PEM" or "ENG".
(Read and Write property)

See also PROXY_SSLCERTTYPE option in CURL manual.

Feedback, Comments & Corrections

CURLMBS.OptionProxySSLCipherList as String
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property CURL MBS CURL Plugin 18.2 Yes Yes Yes Yes No
Function: Specify which SSL ciphers to use for proxy.
Notes: (Read and Write property)

See also PROXY_SSL_CIPHER_LIST option in CURL manual.

Feedback, Comments & Corrections

CURLMBS.OptionProxySSLKey as String
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property CURL MBS CURL Plugin 18.2 Yes Yes Yes Yes No
Function: Name of the file keeping your private SSL-key for proxy.
Notes:
Pass native file path.
(Read and Write property)

See also PROXY_SSLKEY option in CURL manual.

Feedback, Comments & Corrections

CURLMBS.OptionProxySSLKeyType as String
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property CURL MBS CURL Plugin 18.2 Yes Yes Yes Yes No
Function: Sets type of the file keeping your private SSL-key for proxy.
Notes:
Value is DER, PEM or ENG.
(Read and Write property)

See also PROXY_SSLKEYTYPE option in CURL manual.

Feedback, Comments & Corrections

CURLMBS.OptionProxySSLOptions as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property CURL MBS CURL Plugin 18.2 Yes Yes Yes Yes No
Function: Enable/disable specific SSL features with a bitmask for proxy.
Notes: (Read and Write property)

See also PROXY_SSL_OPTIONS option in CURL manual.

Feedback, Comments & Corrections

CURLMBS.OptionProxySSLVerifyHost as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property CURL MBS CURL Plugin 18.2 Yes Yes Yes Yes No
Function: Enable SSL Host verification.
Notes:
Set if we should verify the Common name from the proxy certificate in ssl handshake, set 1 to check existence, 2 to ensure that it matches the provided hostname.
(Read and Write property)

See also PROXY_SSL_VERIFYHOST option in CURL manual.

Feedback, Comments & Corrections

CURLMBS.OptionProxySSLVerifyPeer as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property CURL MBS CURL Plugin 18.2 Yes Yes Yes Yes No
Function: Set if we should verify the proxy in ssl handshake.
Notes:
set 1 to verify.
(Read and Write property)

See also PROXY_SSL_VERIFYPEER option in CURL manual.

Feedback, Comments & Corrections

CURLMBS.OptionProxySSLVersion as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property CURL MBS CURL Plugin 18.2 Yes Yes Yes Yes No
Function: What version to specifically try to use for proxy.
Notes:
The available options are:
Default0The default action. This will attempt to figure out the remote SSL protocol version, i.e. either SSLv3 or TLSv1 (but not SSLv2, which became disabled by default with 7.18.1).
TLSv11Force TLSv1.x
SSLv22Force SSLv2
SSLv33Force SSLv3
TLSv1.04Force TLSv1.0
TLSv1.15Force TLSv1.1
TLSv1.26Force TLSv1.2
TLSv1.37Force TLSv1.3
(Read and Write property)

See also PROXY_SSLVERSION option in CURL manual.

Feedback, Comments & Corrections

CURLMBS.OptionProxyTLS13Ciphers as String
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property CURL MBS CURL Plugin 18.3 Yes Yes Yes Yes No
Function: Specify which TLS 1.3 ciphers suites to use for proxy.
Notes:
The list of cipher suites to use for the TLS 1.3 connection to a proxy. The list must be syntactically correct, it consists of one or more cipher suite strings separated by colons.

You'll find more details about cipher lists on this URL:

https://curl.haxx.se/docs/ssl-ciphers.html

The application does not have to keep the string around after setting this option.
(Read and Write property)

See also PROXY_TLS13_CIPHERS option in CURL manual.

Feedback, Comments & Corrections

CURLMBS.OptionProxyTLSAuthPassword as String
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property CURL MBS CURL Plugin 18.2 Yes Yes Yes Yes No
Function: Password for authenticated TLS for proxy.
Notes: (Read and Write property)

See also PROXY_TLSAUTH_PASSWORD option in CURL manual.

Feedback, Comments & Corrections

CURLMBS.OptionProxyTLSAuthType as String
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property CURL MBS CURL Plugin 18.2 Yes Yes Yes Yes No
Function: Set authentication type for authenticated TLS for proxy
Notes: (Read and Write property)

See also PROXY_TLSAUTH_TYPE option in CURL manual.

Feedback, Comments & Corrections

CURLMBS.OptionProxyTLSAuthUsername as String
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property CURL MBS CURL Plugin 18.2 Yes Yes Yes Yes No
Function: Set a username for authenticated TLS for proxy.
Notes: (Read and Write property)

See also PROXY_TLSAUTH_USERNAME option in CURL manual.

Feedback, Comments & Corrections

CURLMBS.OptionProxyTransferMode as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property CURL MBS CURL Plugin 10.0 Yes Yes Yes Yes No
Function: If this integer value is set to 1 (one), it tells libCURL to set the transfer mode (binary or ASCII) for FTP transfers done via an HTTP proxy, by appending ;type=a or ;type=i to the URL.
Notes:
Without this setting, or it being set to 0 (zero, the default), OptionTransferText has no effect when doing FTP via a proxy. Beware that not all proxies support this feature. (Added in 7.18.0)
(Read and Write property)

See also PROXY_TRANSFER_MODE option in CURL manual.

Feedback, Comments & Corrections

CURLMBS.OptionProxyType as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property CURL MBS CURL Plugin 9.8 Yes Yes Yes Yes No
Function: This option is to set type of the proxy.
Notes:
The Lasterror property is set. 0 for success.
You can set this value and later you can read it, but you cannot read the default value.

Available options for this are kPROXY_HTTP, kPROXY_SOCKS4 (added in 7.15.2) kPROXY_SOCKS5. The HTTP type is default.
(Read and Write property)

See also PROXYTYPE option in CURL manual.

Feedback, Comments & Corrections

CURLMBS.OptionProxyUsername as String
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property CURL MBS CURL Plugin 10.0 Yes Yes Yes Yes No
Function: A string, which should be pointing to the user name to use for the transfer while connecting to Proxy.
Notes:
In order to specify the password to be used in conjunction with the user name use the OptionProxyPassword option.
(Read and Write property)

See also PROXYUSERNAME option in CURL manual.

Feedback, Comments & Corrections

CURLMBS.OptionPut as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property CURL MBS CURL Plugin 9.8 Yes Yes Yes Yes No
Function: A non-zero parameter tells the library to use HTTP PUT to transfer data.
Notes:
The data should be set with OptionInFileSize.

This option is deprecated and starting with version 7.12.1 you should instead use OptionUpload.

The Lasterror property is set. 0 for success.
You can set this value and later you can read it, but you cannot read the default value.
(Read and Write property)

See also PUT option in CURL manual.

Feedback, Comments & Corrections

CURLMBS.OptionRandomFile as String
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property CURL MBS CURL Plugin 9.8 Yes Yes Yes Yes No
Function: A file name for the random file.
Notes:
The file will be used to read from to seed the random engine for SSL. The more random the specified file is, the more secure the SSL connection will become.

The Lasterror property is set. 0 for success.
You can set this value and later you can read it, but you cannot read the default value.

Starting with version 18.0 the plugin will always use UTF-8 encoding for file path on Linux and macOS. For macOS we also do the unicode character normalization for file names for you.
(Read and Write property)

See also RANDOM_FILE option in CURL manual.

Feedback, Comments & Corrections

CURLMBS.OptionRange as String
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property CURL MBS CURL Plugin 9.8 Yes Yes Yes Yes No
Function: A string which should contain the specified range you want.
Notes:
It should be in the format "X-Y", where X or Y may be left out. HTTP transfers also support several intervals, separated with commas as in "X-Y,N-M". Using this kind of multiple intervals will cause the HTTP server to send the response document in pieces (using standard MIME separation techniques). Pass a NULL to this option to disable the use of ranges.

The Lasterror property is set. 0 for success.
You can set this value and later you can read it, but you cannot read the default value.
(Read and Write property)

See also RANGE option in CURL manual.

Feedback, Comments & Corrections

Previous items Next items

The items on this page are in the following plugins: MBS CURL Plugin.




Links
MBS Xojo tutorial videos