Xojo Conferences
MBSSep2018MunichDE
XDCMay2019MiamiUSA

Platforms to show: All Mac Windows Linux Cross-Platform

Previous items Next items

CURLSMBS.OptionSSLOptions 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.
Notes: (Read and Write property)

See also SSL_OPTIONS option in CURL manual.

Feedback, Comments & Corrections

CURLSMBS.OptionSSLSessionIDCache 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 use the SSL session ID cache.
Notes:
Pass false to disable libCURL's use of SSL session-ID caching. Set this to true to enable it. By default all transfers are done using the cache. Note that while nothing ever should get hurt by attempting to reuse SSL session-IDs, there seem to be broken SSL implementations in the wild that may require you to disable this in order for you to succeed. (Added in 7.16.0)
(Read and Write property)

See also SSL_SESSIONID_CACHE option in CURL manual.

Feedback, Comments & Corrections

CURLSMBS.OptionSSLVerifyHost 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 determines whether libCURL verifies that the server cert is for the server it is known as.
Notes:
When negotiating an SSL connection, the server sends a certificate indicating its identity.

When OptionSSLVerifyHost is 2, that certificate must indicate that the server is the server to which you meant to connect, or the connection fails.

CURL considers the server the intended one when the Common Name field or a Subject Alternate Name field in the certificate matches the host name in the URL to which you told CURL to connect.

When the value is 1, the certificate must contain a Common Name field, but it doesn't matter what name it says. (This is not ordinarily a useful setting).

When the value is 0, the connection succeeds regardless of the names in the certificate.

The default, since 7.10, is 2.

The checking this option controls is of the identity that the server claims. The server could be lying. To control lying, see OptionSSLVerifyPeer.

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

Feedback, Comments & Corrections

CURLSMBS.OptionSSLVerifyPeer 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: Configure whether this CURL instance will verify the SSL peer certificate.
Notes:
This option determines whether CURL verifies the authenticity of the peer's certificate. A value of 1 means CURL verifies; zero means it doesn't. The default is nonzero, but before 7.10, it was zero.

When negotiating an SSL connection, the server sends a certificate indicating its identity. CURL verifies whether the certificate is authentic, i.e. that you can trust that the server is who the certificate says it is. This trust is based on a chain of digital signatures, rooted in certification authority (CA) certificates you supply. As of 7.10, CURL installs a default bundle of CA certificates and you can specify alternate certificates with the OptionCAINFO option or the OptionCAPATH option.

When OptionSSLVerifyPeer is nonzero, and the verification fails to prove that the certificate is authentic, the connection fails. When the option is zero, the connection succeeds regardless.

Authenticating the certificate is not by itself very useful. You typically want to ensure that the server, as authentically identified by its certificate, is the server you mean to be talking to. Use OptionSSLVerifyHost to control that.
(Read and Write property)

See also SSL_VERIFYPEER option in CURL manual.

Feedback, Comments & Corrections

CURLSMBS.OptionSSLVerifyStatus 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 certificate status.
Notes: (Read and Write property)

See also SSL_VERIFYSTATUS option in CURL manual.

Feedback, Comments & Corrections

CURLSMBS.OptionSSLVersion 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: What version of SSL/TLS to attempt to use.
Example:
dim c as CURLSMBS
c.OptionUseSSL = c.kFTPSSL_ALL
c.OptionSSLVersion = c.kSSLVersionTLSv12
Notes:
The available options are:

kSSLVERSION_DEFAULT = 0

The default action. When libCURL built with OpenSSL, this will attempt to figure out the remote SSL protocol version. Unfortunately there are a lot of ancient and broken servers in use which cannot handle this technique and will fail to connect. When libCURL is built with GnuTLS, this will mean SSLv3.

kSSLVERSION_TLSv1 = 1

Force TLSv1

kSSLVERSION_SSLv2 = 2

Force SSLv2

kSSLVERSION_SSLv3 = 3

Force SSLv3

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

Feedback, Comments & Corrections

CURLSMBS.OptionStreamDepends as CURLSMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property CURL MBS CURL Plugin 18.2 Yes Yes Yes Yes No
Function: Set stream dependency on another CURL handle.
Notes: (Read and Write property)

See also STREAM_DEPENDS option in CURL manual.

Feedback, Comments & Corrections

CURLSMBS.OptionStreamDependsE as CURLSMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property CURL MBS CURL Plugin 18.2 Yes Yes Yes Yes No
Function: Set E-xclusive stream dependency on another CURL handle.
Notes: (Read and Write property)

See also STREAM_DEPENDS_E option in CURL manual.

Feedback, Comments & Corrections

CURLSMBS.OptionStreamWeight 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 stream weight, 1 - 256.
Notes:
Default is 16.
(Read and Write property)

See also STREAM_WEIGHT option in CURL manual.

Feedback, Comments & Corrections

CURLSMBS.OptionSuppressConnectHeaders 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: Suppress proxy CONNECT response headers from user callbacks.
Notes: (Read and Write property)

See also SUPPRESS_CONNECT_HEADERS option in CURL manual.

Feedback, Comments & Corrections

CURLSMBS.OptionTCPFastOpen 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 TCP Fast Open.
Notes: (Read and Write property)

See also TCP_FASTOPEN option in CURL manual.

Feedback, Comments & Corrections

CURLSMBS.OptionTCPKeepAlive as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property CURL MBS CURL Plugin 12.2 Yes Yes Yes Yes No
Function: If set to true, TCP keepalive probes will be sent.
Notes:
The delay and frequency of these probes can be controlled by the OptionTCPKeepIdle and OptionTCPKeepInterval options, provided the operating system supports them. Set to false (default behavior) to disable keepalive probes (Added in 7.25.0).
(Read and Write property)

See also TCP_KEEPALIVE option in CURL manual.

Feedback, Comments & Corrections

CURLSMBS.OptionTCPKeepIdle as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property CURL MBS CURL Plugin 12.2 Yes Yes Yes Yes No
Function: Sets the delay, in seconds, that the operating system will wait while the connection is idle before sending keepalive probes.
Notes:
Not all operating systems support this option. (Added in 7.25.0)
(Read and Write property)

See also TCP_KEEPIDLE option in CURL manual.

Feedback, Comments & Corrections

CURLSMBS.OptionTCPKeepInterval as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property CURL MBS CURL Plugin 12.2 Yes Yes Yes Yes No
Function: Sets the interval, in seconds, that the operating system will wait between sending keepalive probes.
Notes:
Not all operating systems support this option. (Added in 7.25.0)
(Read and Write property)

See also TCP_KEEPINTVL option in CURL manual.

Feedback, Comments & Corrections

CURLSMBS.OptionTCPNoDelay 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: An integer specifying whether the TCP_NODELAY option should be set or cleared (true = set, false = clear).
Notes:
The option is cleared by default. This will have no effect after the connection has been established.

Setting this option will disable TCP's Nagle algorithm. The purpose of this algorithm is to try to minimize the number of small packets on the network (where "small packets" means TCP segments less than the Maximum Segment Size (MSS) for the network).

Maximizing the amount of data sent per TCP segment is good because it amortizes the overhead of the send. However, in some cases (most notably telnet or rlogin) small segments may need to be sent without delay. This is less efficient than sending larger amounts of data at a time, and can contribute to congestion on the network if overdone.

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

Feedback, Comments & Corrections

CURLSMBS.OptionTFTPBlockSize 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: Specify block size to use for TFTP data transmission.
Notes:
Valid range as per RFC 2348 is 8-65464 bytes. The default of 512 bytes will be used if this option is not specified. The specified block size will only be used pending support by the remote server. If the server does not return an option acknowledgement or returns an option acknowledgement with no blksize, the default of 512 bytes will be used. (added in 7.19.4)
(Read and Write property)

See also TFTP_BLKSIZE option in CURL manual.

Feedback, Comments & Corrections

CURLSMBS.OptionTFTPNoOptions 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: Whether not send any tftp option requests to the server.
Notes: (Read and Write property)

See also TFTP_NO_OPTIONS option in CURL manual.

Feedback, Comments & Corrections

CURLSMBS.OptionTimeCondition 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 Time condition option.
Notes:
This defines how the OptionTimeValue time value is treated. You can set this parameter to kTimeConditionIfModifiedSince (1) or kTimeConditionIfUnModifiedSince (2). This feature applies to HTTP and FTP.

The last modification time of a file is not always known and in such instances this feature will have no effect even if the given time condition would have not been met.

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

Feedback, Comments & Corrections

CURLSMBS.OptionTimeOut 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 maximum time in seconds that you allow the libCURL transfer operation to take.
Notes:
Normally, name lookups can take a considerable time and limiting operations to less than a few minutes risk aborting perfectly normal operations. This option will cause CURL to use the SIGALRM to enable time-outing system calls.

In unix-like systems, this might cause signals to be used unless CURLOPT_NOSIGNAL is set.

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

Feedback, Comments & Corrections

CURLSMBS.OptionTimeOutMS 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 as parameter containing the maximum time in milli seconds that you allow the libCURL transfer operation to take.
Notes:
Normally, name lookups can take a considerable time and limiting operations to less than a few minutes risk aborting perfectly normal operations. This option will cause CURL to use the SIGALRM to enable time-outing system calls.
(Read and Write property)

See also TIMEOUT_MS option in CURL manual.

Feedback, Comments & Corrections

CURLSMBS.OptionTimeValue 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 should be the time in seconds since 1 jan 1970, and the time will be used in a condition as specified with OptionTimeCondition.
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 TIMEVALUE option in CURL manual.

Feedback, Comments & Corrections

CURLSMBS.OptionTLSAuthPassword as String
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property CURL MBS CURL Plugin 13.5 Yes Yes Yes Yes No
Function: Sets the TSL authentication password.
Notes:
Please also set OptionTLSAuthType.
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 TLSAUTH_PASSWORD option in CURL manual.

Feedback, Comments & Corrections

CURLSMBS.OptionTLSAuthType as String
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property CURL MBS CURL Plugin 13.5 Yes Yes Yes Yes No
Function: Sets the TLS authentication type.
Notes:
You can set this to "SRP" to use Secure Remote Password authentication.
Please also set username and password.
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 TLSAUTH_TYPE option in CURL manual.

Feedback, Comments & Corrections

CURLSMBS.OptionTLSAuthUsername as String
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property CURL MBS CURL Plugin 13.5 Yes Yes Yes Yes No
Function: Sets the TSL authentication user name.
Notes:
Please also set OptionTLSAuthType.
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 TLSAUTH_USERNAME option in CURL manual.

Feedback, Comments & Corrections

CURLSMBS.OptionTransferEncoding as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property CURL MBS CURL Plugin 13.0 Yes Yes Yes Yes No
Function: Adds a request for compressed Transfer Encoding in the outgoing HTTP request.
Notes:
If the server supports this and so desires, it can respond with the HTTP response sent using a compressed Transfer-Encoding that will be automatically uncompressed by libCURL on reception.

Transfer-Encoding differs slightly from the Content-Encoding you ask for with OptionAcceptEncoding in that a Transfer-Encoding is strictly meant to be for the transfer and thus MUST be decoded before the data arrives in the client. Traditionally, Transfer-Encoding has been much less used and supported by both HTTP clients and HTTP servers.
(Read and Write property)

See also TRANSFER_ENCODING option in CURL manual.

Feedback, Comments & Corrections

CURLSMBS.OptionTransferText 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 use ASCII mode for ftp transfers, instead of the default binary transfer.
Notes:
For win32 systems it does not set the stdout to binary mode. This option can be usable when transferring text data between systems with different views on certain characters, such as newlines or similar.

libCURL does not do a complete ASCII conversion when doing ASCII transfers over FTP. This is a known limitation/flaw that nobody has rectified. libCURL simply sets the mode to ascii and performs a standard transfer.

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

Feedback, Comments & Corrections

CURLSMBS.OptionUnixSocketPath 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: Path to Unix domain socket.
Notes: (Read and Write property)

See also UNIX_SOCKET_PATH option in CURL manual.

Feedback, Comments & Corrections

CURLSMBS.OptionUnrestrictedAuth 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 boolean parameter tells the library it can continue to send authentication (user+password) when following locations, even when hostname changed.
Notes:
This option is meaningful only when setting FollowOption.

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

Feedback, Comments & Corrections

CURLSMBS.OptionUpload 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 prepare for an upload.
Notes:
The OptionInFileSize or OptionInFileSizeLarge options are also interesting for uploads. If the protocol is HTTP, uploading means using the PUT request unless you tell libCURL otherwise.

Using PUT with HTTP 1.1 implies the use of a "Expect: 100-continue" header. You can disable this header with OptionHTTPHeader as usual.

If you use PUT to a HTTP 1.1 server, you can upload data without knowing the size before starting the transfer if you use chunked encoding. You enable this by adding a header like "Transfer-Encoding: chunked" with OptionHTTPHeader. With HTTP 1.0 or without chunked transfer, you must specify the size.

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

Feedback, Comments & Corrections

CURLSMBS.OptionURL 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: The actual URL to deal with.
Notes:
If you need to pass username or password, please consider using the OptionUsername and OptionPassword properties. If you username or password contains characters like @ or :, you must use those properties.

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 char * to a zero terminated string. The string must remain present until CURL no longer needs it, as it doesn't copy the string.

If the given URL lacks the protocol part ("http://" or "ftp://" etc), it will attempt to guess which protocol to use based on the given host name. If the given protocol of the set URL is not supported, libCURL will return on error (kError_UNSUPPORTED_PROTOCOL) when you call Perform. Use VersionInfo for detailed info on which protocols that are supported.

The string given to CURLOPT_URL must be url-encoded and following the RFC 2396:
http://CURL.haxx.se/rfc/rfc2396.txt

CURLOPT_URL is the only option that must be set before Perform is called.
For file uploads or downloads, please include the file name in the URL.

Please do never include username and passwords in URLs, as those get often written to log files and would reveal your credentials!
Instead use OptionUsername and OptionPassword.
(Read and Write property)

See also URL 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 tutorial videos