Xojo Conferences
MBSSep2018MunichDE
XDCMay2019MiamiUSA

Platforms to show: All Mac Windows Linux Cross-Platform

Previous items Next items

CURLSMBS.OptionFTPUseEPRT 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: If the value is true, it tells CURL to use the EPRT (and LPRT) command when doing active FTP downloads (which is enabled by CURLOPT_FTPPORT).
Notes:
Using EPRT means that it will first attempt to use EPRT and then LPRT before using PORT, but if you pass FALSE (zero) to this option, it will not try using EPRT or LPRT, only plain PORT. (Added in 7.10.5)

If the server is an IPv6 host, this option will have no effect as of 7.12.3.

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 FTP_USE_EPRT option in CURL manual.

Feedback, Comments & Corrections

CURLSMBS.OptionFTPUseEPSV 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: If the value is true, it tells CURL to use the EPSV command when doing passive FTP downloads (which it always does by default).
Notes:
Using EPSV means that it will first attempt to use EPSV before using PASV, but if you pass FALSE (zero) to this option, it will not try using EPSV, only plain PASV.

If the server is an IPv6 host, this option will have no effect as of 7.12.3.

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 FTP_USE_EPSV option in CURL manual.

Feedback, Comments & Corrections

CURLSMBS.OptionFTPusePret as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property CURL MBS CURL Plugin 11.0 Yes Yes Yes Yes No
Function: If the value is true, it tells CURL to send a PRET command before PASV (and EPSV). Certain FTP servers, mainly drftpd, require this non-standard command for directory listings as well as up and downloads in PASV mode.
Notes:
Has no effect when using the active FTP transfers mode. (Added in 7.20.0)
(Read and Write property)

See also FTP_USE_PRET option in CURL manual.

Feedback, Comments & Corrections

CURLSMBS.OptionGet 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: If the true, this forces the HTTP request to get back to GET.
Notes:
usable if a POST, HEAD, PUT or a custom request have been used previously using the same CURL handle.

When setting OptionGet to a true value, it will automatically set OptionNoBody to true (since 7.14.1).

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)

Feedback, Comments & Corrections

CURLSMBS.OptionGSSAPIDelegation 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: Allow GSSAPI credential delegation.
Notes: (Read and Write property)

See also GSSAPI_DELEGATION option in CURL manual.

Feedback, Comments & Corrections

CURLSMBS.OptionHappyEyeballsTimeOutMS 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: The happy eyeballs timeout.
Notes:
Head start in milliseconds to give happy eyeballs.
(Read and Write property)

See also HAPPY_EYEBALLS_TIMEOUT_MS option in CURL manual.

Feedback, Comments & Corrections

CURLSMBS.OptionHAProxyProtocol as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property CURL MBS CURL Plugin 18.2 Yes Yes Yes Yes No
Function: Wether to send an HAProxy PROXY protocol header.
Notes:
Set to true to tell the library to send an HAProxy PROXY protocol header at beginning of the connection. The default action is not to send this header.
This option is primarily useful when sending test requests to a service that expects this header.
Most applications do not need this option.
Default false, do not send HAProxy PROXY protocol header.
(Read and Write property)

See also HAPROXYPROTOCOL option in CURL manual.

Feedback, Comments & Corrections

CURLSMBS.OptionHeader 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: True tells the library to include the header in the body output.
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.

This is only relevant for protocols that actually have headers preceding the data (like HTTP).
(Read and Write property)

See also HEADER option in CURL manual.

Feedback, Comments & Corrections

CURLSMBS.OptionHeaderOptions 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: Pass in a bitmask of "header options".
Notes: (Read and Write property)

See also HEADEROPT option in CURL manual.

Feedback, Comments & Corrections

CURLSMBS.OptionHTTPAuth 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 http 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. The available bits are listed below. 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 UserPassword option. (Added in 7.10.6)

kAuthBASIC = 1

HTTP Basic authentication. This is the default choice, and the only method that is in wide-spread use and supported virtually everywhere. This is sending the user name and password over the network in plain text, easily captured by others.

kAuthDIGEST = 2

HTTP Digest authentication. Digest authentication is defined in RFC2617 and is a more secure way to do authentication over public networks than the regular old-fashioned Basic method.

kAuthGSSNEGOTIATE = 4

HTTP GSS-Negotiate authentication. The GSS-Negotiate (also known as plain "Negotiate") method was designed by Microsoft and is used in their web applications. It is primarily meant as a support for Kerberos5 authentication but may be also used along with another authentication methods. For more information see IETF draft draft-brezak-spnego-http-04.txt.

You need to build libCURL with a suitable GSS-API library for this to work.

kAuthNTLM = 8

HTTP NTLM authentication. A proprietary protocol invented and used by Microsoft. It uses a challenge-response and hash concept similar to Digest, to prevent the password from being eavesdropped.

You need to build libCURL with OpenSSL support for this option to work, or build libCURL on Windows.

kAuthANY = &hFFFFFFFF

This is a convenience macro that sets all bits and thus makes libCURL pick any it finds suitable. libCURL will automatically select the one it finds most secure.

kAuthANYSAFE = &hFFFFFFFE

This is a convenience macro that sets all bits except Basic and thus makes libCURL pick any it finds suitable. libCURL will automatically select the one it finds most secure.

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 HTTPAUTH option in CURL manual.

Feedback, Comments & Corrections

CURLSMBS.OptionHTTPContentDecoding 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: Pass a long to tell libCURL how to act on content decoding.
Notes:
If set to zero, content decoding will be disabled. If set to 1 it is enabled. Note however that libCURL has no default content decoding but requires you to use OptionEncoding for that. (added in 7.16.2)
(Read and Write property)

See also HTTP_CONTENT_DECODING option in CURL manual.

Feedback, Comments & Corrections

CURLSMBS.OptionHTTPProxyTunnel 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: Set the parameter to true to get the library to tunnel all operations through a given HTTP proxy.
Notes:
There is a big difference between using a proxy and to tunnel through it. If you don't know what this means, you probably don't want this tunneling option.

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 HTTPPROXYTUNNEL option in CURL manual.

Feedback, Comments & Corrections

CURLSMBS.OptionHTTPTransferDecoding 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: Pass an integer to tell libCURL how to act on transfer decoding.
Notes:
If set to zero, transfer decoding will be disabled, if set to 1 it is enabled (default). libCURL does chunked transfer decoding by default unless this option is set to zero. (added in 7.16.2)
(Read and Write property)

See also HTTP_TRANSFER_DECODING option in CURL manual.

Feedback, Comments & Corrections

CURLSMBS.OptionHTTPVersion 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: Set to one of the values described below.
Notes:
They force libCURL to use the specific HTTP versions. This is not sensible to do unless you have a good reason.

kHTTP_VERSION_NONE = 0

We don't care about what version the library uses. libCURL will use whatever it thinks fit.

kHTTP_VERSION_1_0 = 1

Enforce HTTP 1.0 requests.

kHTTP_VERSION_1_1 = 2

Enforce HTTP 1.1 requests.

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 HTTP_VERSION option in CURL manual.

Feedback, Comments & Corrections

CURLSMBS.OptionIgnoreContentLength 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: Whether to ignore the Content-Length header.
Notes:
This is useful for Apache 1.x (and similar servers) which will report incorrect content length for files over 2 gigabytes. If this option is used, CURL will not be able to accurately report progress, and will simply stop the download when the server ends the connection. (added in 7.14.1)
(Read and Write property)

See also IGNORE_CONTENT_LENGTH option in CURL manual.

Feedback, Comments & Corrections

CURLSMBS.OptionInFileSize as Int64
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property CURL MBS CURL Plugin 9.8 Yes Yes Yes Yes No
Function: When uploading a file to a remote site, this option should be used to tell libCURL what the expected size of the infile is.
Notes:
Note that this option does not limit how much data libCURL will actually send, as that is controlled entirely by what the read callback returns.

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 INFILESIZE option in CURL manual.

Feedback, Comments & Corrections

CURLSMBS.OptionInFileSizeLarge as Int64
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property CURL MBS CURL Plugin 9.8 Yes Yes Yes Yes No
Function: When uploading a file to a remote site, this option should be used to tell libCURL what the expected size of the infile is.
This item is deprecated and should no longer be used. You can use OptionInFileSize instead.
Notes:
This value should be passed as a CURL_off_t. (Added in 7.11.0)

Note that this option does not limit how much data libCURL will actually send, as that is controlled entirely by what the read callback returns.

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)

Feedback, Comments & Corrections

CURLSMBS.OptionInterface 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: This set the interface name to use as outgoing network interface.
Notes:
The name can be an interface name, an IP address or a host name.

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 INTERFACE option in CURL manual.

Feedback, Comments & Corrections

CURLSMBS.OptionIPResolve 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: Allows an application to select what kind of IP addresses to use when resolving host names.
Example:
dim c as new CURLSMBS
c.OptionIPResolve = c.kIPRESOLVE_V4
Notes:
This is only interesting when using host names that resolve addresses using more than one version of IP. The allowed values are:

kIPRESOLVE_WHATEVER = 0

Default, resolves addresses to all IP versions that your system allows.

kIPRESOLVE_V4 = 1

Resolve to ipv4 addresses.

kIPRESOLVE_V6 = 2

Resolve to ipv6 addresses.

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 IPRESOLVE option in CURL manual.

Feedback, Comments & Corrections

CURLSMBS.OptionIssuerCert 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 naming a file holding a CA certificate in PEM format.
Notes:
If the option is set, an additional check against the peer certificate is performed to verify the issuer is indeed the one associated with the certificate provided by the option. This additional check is useful in multi-level PKI where one needs to enforce that the peer certificate is from a specific branch of the tree.

This option makes sense only when used in combination with the OptionSSLVerifyPeer option. Otherwise, the result of the check is not considered as failure.

A specific error code (CURLE_SSL_ISSUER_ERROR) is defined with the option, which is returned if the setup of the SSL/TLS session has failed due to a mismatch with the issuer of peer certificate (OptionSSLVerifyPeer has to be set too for the check to fail). (Added in 7.19.0)

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 ISSUERCERT option in CURL manual.

Feedback, Comments & Corrections

CURLSMBS.OptionKeepSendingOnError 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: Wether to keep sending on error.
Notes:
Continue to send data if the server responds early with an HTTP status code >= 300
(Read and Write property)

See also KEEP_SENDING_ON_ERROR option in CURL manual.

Feedback, Comments & Corrections

CURLSMBS.OptionKeyPassword as String
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property CURL MBS CURL Plugin 15.2 Yes Yes Yes Yes No
Function: Set passphrase to private key.
Notes:
It will be used as the password required to use the OptionSSLKey or OptionSSHPrivateKeyfile private key. You never needed a pass phrase to load a certificate but you need one to load your private key.
(Read and Write property)

See also KEYPASSWD option in CURL manual.

Feedback, Comments & Corrections

CURLSMBS.OptionKRB4Level 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 the krb4 security level, this also enables krb4 awareness.
This item is deprecated and should no longer be used. You can use OptionKRBLevel instead.
Notes:
This is a string, 'clear', 'safe', 'confidential' or 'private'. If the string is set but doesn't match one of these, 'private' will be used. Set the string to "" to disable kerberos4. The kerberos support only works for FTP.

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)

Feedback, Comments & Corrections

CURLSMBS.OptionKRBLevel as String
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property CURL MBS CURL Plugin 15.2 Yes Yes Yes Yes No
Function: FTP kerberos security level.
Notes:
Set the kerberos security level for FTP; this also enables kerberos awareness. This is a string that should match one of the following: 'clear', 'safe', 'confidential' or 'private'. If the string is set but doesn't match one of these, 'private' will be used. Set the string to NULL to disable kerberos support for FTP.
(Read and Write property)

See also KRBLEVEL option in CURL manual.

Feedback, Comments & Corrections

CURLSMBS.OptionLocalPort 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 sets the local port number of the socket used for connection.
Notes:
This can be used in combination with OptionInterface and you are recommended to use OptionLocalPortRange as well when this is set. Note that port numbers are only valid 1 - 65535. (Added in 7.15.2)
(Read and Write property)

See also LOCALPORT option in CURL manual.

Feedback, Comments & Corrections

CURLSMBS.OptionLocalPortRange 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 is the number of attempts libCURL should do to find a working local port number.
Notes:
It starts with the given OptionLocalPort and adds one to the number for each retry. Setting this value to 1 or below will make libCURL do only one try for exact port number. Note that port numbers by nature is a scarce resource that will be busy at times so setting this value to something too low might cause unnecessary connection setup failures. (Added in 7.15.2)
(Read and Write property)

See also LOCALPORTRANGE option in CURL manual.

Feedback, Comments & Corrections

CURLSMBS.OptionLoginOptions as String
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property CURL MBS CURL Plugin 15.4 Yes Yes Yes Yes No
Function: Login options string to use for the transfer.
Notes:
For more information about the login options please see RFC 2384, RFC5092 and IETF draft draft-earhart-url-smtp-00.txt

CURLOPT_LOGIN_OPTIONS can be used to set protocol specific login options, such as the preferred authentication mechanism via "AUTH=NTLM" or "AUTH=*", and should be used in conjunction with the OptionUserName option.
Only IMAP, POP3 and SMTP support login options.
(Read and Write property)

See also LOGIN_OPTIONS option in CURL manual.

Feedback, Comments & Corrections

CURLSMBS.OptionLowSpeedLimit 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 property contains the transfer speed in bytes per second that the transfer should be below during OptionLowSpeedTime seconds for the library to consider it too slow and abort.
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.
(Read and Write property)

See also LOW_SPEED_LIMIT option in CURL manual.

Feedback, Comments & Corrections

CURLSMBS.OptionLowSpeedTime 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 property contains the time in seconds that the transfer should be below the OptionLowSpeedLimit for the library to consider it too slow and abort.
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.
(Read and Write property)

See also LOW_SPEED_TIME option in CURL manual.

Feedback, Comments & Corrections

CURLSMBS.OptionMailAuth as String
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property CURL MBS CURL Plugin 12.4 Yes Yes Yes Yes No
Function: This string will be used to specify the authentication address (identity) of a submitted message that is being relayed to another server.
Notes:
This optional parameter allows co-operating agents in a trusted environment to communicate the authentication of individual messages and should only be used by the application program, using libCURL, if the application is itself a mail server acting in such an environment. If the application is operating as such and the AUTH address is not known or is invalid, then an empty string should be used for this parameter.

Unlike OptionMailFrom and SetOptionMailRecipients, the address should not be specified within a pair of angled brackets (<>). However, if an empty string is used then a pair of brackets will be sent by libCURL as required by RFC 2554.
(Read and Write property)

See also MAIL_AUTH 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 FileMaker blog