Xojo Conferences
XDCMay2019MiamiUSA

Platforms to show: All Mac Windows Linux Cross-Platform

Previous items Next items

CURLSMBS.OptionCookieSession 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 to true to mark this as a new cookie "session".
Notes:
It will force libCURL to ignore all cookies it is about to load that are "session cookies" from the previous session. By default, libCURL always stores and loads all cookies, independent if they are session cookies are not. Session cookies are cookies without expiry date and they are meant to be alive and existing for this "session" only.

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

Feedback, Comments & Corrections

CURLSMBS.OptionCRLF 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: Convert Unix newlines to CRLF newlines on transfers.
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 CRLF option in CURL manual.

Feedback, Comments & Corrections

CURLSMBS.OptionCRLFile 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 with the concatenation of CRL (in PEM format) to use in the certificate validation that occurs during the SSL exchange.
Notes:
When CURL is built to use NSS or GnuTLS, there is no way to influence the use of CRL passed to help in the verification process. When libCURL is built with OpenSSL support, X509_V_FLAG_CRL_CHECK and X509_V_FLAG_CRL_CHECK_ALL are both set, requiring CRL check against all the elements of the certificate chain if a CRL file is passed.

This option makes sense only when used in combination with the OptionSSLVerifyPeer option.

A specific error code (CURLE_SSL_CRL_BADFILE) is defined with the option. It is returned when the SSL exchange fails because the CRL file cannot be loaded. Note that a failure in certificate verification due to a revocation information found in the CRL does not trigger this specific error. (Added in 7.19.0)
(Read and Write property)

See also CRLFILE option in CURL manual.

Feedback, Comments & Corrections

CURLSMBS.OptionCustomRequest 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: It will be user instead of GET or HEAD when doing an HTTP request, or instead of LIST or NLST when doing an ftp directory listing.
Example:
dim c as CURLSMBS // your CURL instance

c.URL = "ftp://..."
c.customRequest = "MLSD" // ftp advanced directory listing
Notes:
This is useful for doing DELETE or other more or less obscure HTTP requests. Don't do this at will, make sure your server supports the command first.

Restore to the internal default by setting this to "".

Many people have wrongly used this option to replace the entire request with their own, including multiple headers and POST contents. While that might work in many cases, it will cause libCURL to send invalid requests and it could possibly confuse the remote server badly. Use CURLOPT_POST and OptionPostFields to set POST data. Use OptionHTTPHeader to replace or extend the set of headers sent by libCURL. Use OptionHTTPVersion to change HTTP version.

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.

For WebDAV, you can set this to "MKCOL" to create a folder at the given URL.
(Read and Write property)

See also CUSTOMREQUEST option in CURL manual.

Feedback, Comments & Corrections

CURLSMBS.OptionDefaultProtocol 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 the protocol used when curl is given a URL without a protocol.
Notes: (Read and Write property)

See also DEFAULT_PROTOCOL option in CURL manual.

Feedback, Comments & Corrections

CURLSMBS.OptionDirListOnly as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property CURL MBS CURL Plugin 15.2 Yes Yes Yes Yes No
Function: For FTP and SFTP based URLs a parameter set to true tells the library to list the names of files in a directory, rather than performing a full directory listing that would normally include file sizes, dates etc.
Notes:
For POP3 a parameter of true tells the library to list the email message or messages on the POP3 server. This can be used to change the default behaviour of libCURL, when combined with a URL that contains a message ID, to perform a "scan listing" which can then be used to determine the size of an email.

Note: For FTP this causes a NLST command to be sent to the FTP server. Beware that some FTP servers list only files in their response to NLST; they might not include subdirectories and symbolic links.

Setting this option to true also implies a directory listing even if the URL doesn't end with a slash, which otherwise is necessary.

Do NOT use this option if you also use OptionWildCardMatch as it will effectively break that feature then.
(Read and Write property)

See also DIRLISTONLY option in CURL manual.

Feedback, Comments & Corrections

CURLSMBS.OptionDisableUserNameInURL as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property CURL MBS CURL Plugin 18.3 Yes Yes Yes Yes No
Function: Disallow specifying username/login in URL.
Notes:
The value true tells the library to not allow URLs that include an username.
(Read and Write property)

Feedback, Comments & Corrections

CURLSMBS.OptionDNSCacheTimeout 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 timeout in seconds.
Notes:
Name resolves will be kept in memory for this number of seconds. Set to zero (0) to completely disable caching, or set to -1 to make the cached entries remain forever. By default, libCURL caches this info for 60 seconds.

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

Feedback, Comments & Corrections

CURLSMBS.OptionDNSInterface 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 the name of the network interface that the DNS resolver should bind to.
Notes:
This must be an interface name (not an address). Set this option to "" to use the default setting (don't bind to a specific interface).
(Read and Write property)

See also DNS_INTERFACE option in CURL manual.

Feedback, Comments & Corrections

CURLSMBS.OptionDNSLocalIPv4 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 the local IPv4 address that the resolver should bind to.
Notes:
The argument should be of string and contain a single numerical IPv4 address as a string.
Set this option to "" to use the default setting (don't bind to a specific IP address).
(Read and Write property)

See also DNS_LOCAL_IP4 option in CURL manual.

Feedback, Comments & Corrections

CURLSMBS.OptionDNSLocalIPv6 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 the local IPv6 address that the resolver should bind to.
Notes:
The argument should be of type string and contain a single IPv6 address as a string.
Set this option to "" to use the default setting (don't bind to a specific IP address).
(Read and Write property)

See also DNS_LOCAL_IP6 option in CURL manual.

Feedback, Comments & Corrections

CURLSMBS.OptionDNSServers 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 the name servers to use for DNS resolution.
Notes: (Read and Write property)

See also DNS_SERVERS option in CURL manual.

Feedback, Comments & Corrections

CURLSMBS.OptionDNSShuffleAddresses 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: Whether to shuffle DNS addresses.
Notes:
When a name is resolved and more than one IP address is returned, shuffle the order of all returned addresses so that they will be used in a random order. This is similar to the ordering behavior of gethostbyname which is no longer used on most platforms.

Addresses will not be reshuffled if a name resolution is completed using the DNS cache. DNSCacheTimeout property can be used together with this option to reduce DNS cache timeout or disable caching entirely if frequent reshuffling is needed.

Since the addresses returned will be reordered randomly, their order will not be in accordance with RFC 3484 or any other deterministic order that may be generated by the system's name resolution implementation. This may have performance impacts and may cause IPv4 to be used before IPv6 or vice versa.
Default is false.
(Read and Write property)

See also DNS_SHUFFLE_ADDRESSES option in CURL manual.

Feedback, Comments & Corrections

CURLSMBS.OptionDOHURL as String
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property CURL MBS CURL Plugin 18.5 Yes Yes Yes Yes No
Function: Provides the DNS-over-HTTPS URL.
Notes:
Pass in a string to a URL for the DOH server to use for name resolving. The parameter should be URL-encoded in the following format: "https://host:port/path". It MUST specify a HTTPS URL.

libcurl doesn't validate the syntax or use this variable until the transfer is issued. Even if you set a crazy value here, OptionDOHURL will still return CURLE_OK.

curl sends POST requests to the given DNS-over-HTTPS URL.

To find the DOH server itself, which might be specified using a name, libcurl will use the default name lookup function. You can bootstrap that by providing the address for the DOH server with OptionResolve.

Disable DOH use again by setting this option to "".
(Read and Write property)

See also DOH_URL option in CURL manual.

Feedback, Comments & Corrections

CURLSMBS.OptionEGDSocket 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 path name to the Entropy Gathering Daemon socket.
Notes:
It will be used to seed the random engine for SSL.

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

Feedback, Comments & Corrections

CURLSMBS.OptionExpect100TimeoutMS 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: Sets Expect 100 timeout.
Notes:
Time to wait in milliseconds for a response to a HTTP request containing an Expect: 100-continue header before sending the data anyway.
(Read and Write property)

See also EXPECT_100_TIMEOUT_MS option in CURL manual.

Feedback, Comments & Corrections

CURLSMBS.OptionFailOnError 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 fail silently if the HTTP code returned is equal to or larger than 400. The default action would be to return the page normally, ignoring that code.
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 method is not fail-safe and there are occasions where non-succesful response codes will slip through, especially when authentication is involved (response codes 401 and 407).

You might get some amounts of headers transferred before this situation is detected, like for when a "100-continue" is received as a response to a POST/PUT and a 401 or 407 is received immediately afterwards.
(Read and Write property)

See also FAILONERROR option in CURL manual.

Feedback, Comments & Corrections

CURLSMBS.OptionFileTime 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 filetime should be querried.
Example:
// init CURL with options
dim d as new CURLSMBS
d.OptionFileTime = true
d.OptionURL = "http://www.monkeybreadsoftware.de/images/mbs.jpg"

// run query
dim e as Integer = d.Perform

// calculate date object
dim da as new date(1970,1,1,0,0,0)
da.TotalSeconds = da.TotalSeconds + d.GetInfoFileTime

// show date
ResultText.text=str(d.GetInfoFileTime)+" "+da.ShortDate+" "+da.ShortTime
Notes:
If it is true, libCURL will attempt to get the modification date of the remote document in this operation. This requires that the remote server sends the time or replies to a time querying command.

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

Feedback, Comments & Corrections

CURLSMBS.OptionFollowLocation 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 to follow any Location: header that the server sends as part of an HTTP header.
Example:
dim c as new CURLSMBS

c.OptionFollowLocation = true
c.OptionMaxRedirs = 3
Notes:
This means that the library will re-send the same request on the new location and follow new Location: headers all the way until no more such headers are returned. OptionMaxRedirs can be used to limit the number of redirects libCURL will follow.

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

Feedback, Comments & Corrections

CURLSMBS.OptionForbitReuse 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 to true to make the next transfer explicitly close the connection when done.
Notes:
Normally, libCURL keep all connections alive when done with one transfer in case there comes a succeeding one that can re-use them. This option should be used with caution and only if you understand what it does. Set to false to have libCURL keep the connection open for possibly later re-use (default behavior).

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.OptionFreshConnect 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 to true to make the next transfer use a new (fresh) connection by force.
Example:
dim c as new CURLSMBS

c.OptionFreshConnect=True
Notes:
If the connection cache is full before this connection, one of the existing connections will be closed as according to the selected or default policy. This option should be used with caution and only if you understand what it does. Set this to 0 to have libCURL attempt re-using an existing connection (default behavior).

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

Feedback, Comments & Corrections

CURLSMBS.OptionFTPAccount 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: The FTP account name to use.
Notes:
When an FTP server asks for "account data" after user name and password has been provided, this data is sent off using the ACCT command.
(Read and Write property)

See also FTP_ACCOUNT option in CURL manual.

Feedback, Comments & Corrections

CURLSMBS.OptionFTPAlternativeToUser 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 alternative username.
Notes:
Pass a string as parameter, pointing to a string which will be used to authenticate if the usual FTP "USER user" and "PASS password" negotiation fails. This is currently only known to be required when connecting to Tumbleweed's Secure Transport FTPS server using client certificates for authentication. (Added in 7.15.5)
(Read and Write property)

See also FTP_ALTERNATIVE_TO_USER option in CURL manual.

Feedback, Comments & Corrections

CURLSMBS.OptionFTPAppend 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 append to the remote file instead of overwrite it.
This item is deprecated and should no longer be used. You can use OptionAppend instead.
Notes:
This is only useful when uploading to an ftp site.

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.OptionFTPCreateMissingDirs 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: If the value is 1, CURL will attempt to create any remote directory that it fails to CWD into.
Notes:
CWD is the command that changes working directory. (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.
Newer CURL Library versions allow a value of 2 to do a CWD after the directory was created, so this property changed from boolean to integer.
(Read and Write property)

See also FTP_CREATE_MISSING_DIRS option in CURL manual.

Feedback, Comments & Corrections

CURLSMBS.OptionFTPFileMethod 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 that should have one of the following values.
Notes:
This option controls what method libCURL should use to reach a file on a FTP(S) server. The argument should be one of the following alternatives:

URLFTPMETHOD_MULTICWD = 1

libCURL does a single CWD operation for each path part in the given URL. For deep hierarchies this means very many commands. This is how RFC1738 says it should be done. This is the default but the slowest behavior.

CURLFTPMETHOD_NOCWD = 2

libCURL does no CWD at all. libCURL will do SIZE, RETR, STOR etc and give a full path to the server for all these commands. This is the fastest behavior.

CURLFTPMETHOD_SINGLECWD = 3

libCURL does one CWD with the full target directory and then operates on the file "normally" (like in the multicwd case). This is somewhat more standards compliant than 'nocwd' but without the full penalty of 'multicwd'.
(Read and Write property)

See also FTP_FILEMETHOD option in CURL manual.

Feedback, Comments & Corrections

CURLSMBS.OptionFTPListOnly 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 just list the names of an ftp directory, instead of doing a full directory listing that would include file sizes, dates etc.
This item is deprecated and should no longer be used. You can use OptionDirListOnly instead.
Notes:
This causes an FTP NLST command to be sent. Beware that some FTP servers list only files in their response to NLST; they might not include subdirectories and symbolic links.

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.OptionFTPPort 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 port to use for ftp.
Notes:
It will be used to get the IP address to use for the ftp PORT instruction. The PORT instruction tells the remote server to connect to our specified IP address. The string may be a plain IP address, a host name, an network interface name (under Unix) or just a '-' letter to let the library use your systems default IP address. Default FTP operations are passive, and thus won't use PORT.

You disable PORT again and go back to using the passive version by setting this option to "".

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

Feedback, Comments & Corrections

CURLSMBS.OptionFTPResponseTimeout 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: Causes CURL to set a timeout period (in seconds) on the amount of time that the server is allowed to take in order to generate a response message for a command before the session is considered hung.
Notes:
While CURL is waiting for a response, this value overrides OptionTimeout. It is recommended that if used in conjunction with OptionTimeout, you set OptionFTPResponseTimeout to a value smaller than OptionTimeout. (Added in 7.10.8)

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

Feedback, Comments & Corrections

CURLSMBS.OptionFTPSkipPasvIP 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 set to a non-zero value, it instructs libCURL to not use the IP address the server suggests in its 227-response to libCURL's PASV command when libCURL connects the data connection.
Notes:
Instead libCURL will re-use the same IP address it already uses for the control connection. But it will use the port number from the 227-response. (Added in 7.14.2)

This option has no effect if PORT, EPRT or EPSV is used instead of PASV.
(Read and Write property)

See also FTP_SKIP_PASV_IP 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