Xojo Developer Conference
Join us from 25th to 27th April 2018 in Denver.

Platforms to show: All Mac Windows Linux Cross-Platform

Previous items Next items

CURLNMBS.OptionDirListOnly as Boolean
property, CURL, MBS CURL Plugin (CURLN), class CURLNMBS,
Plugin version: 15.2, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.

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)
CURLNMBS.OptionDNSCacheTimeout as Integer
property, CURL, MBS CURL Plugin (CURLN), class CURLNMBS,
Plugin version: 9.8, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.

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)
CURLNMBS.OptionDNSInterface as String
property, CURL, MBS CURL Plugin (CURLN), class CURLNMBS,
Plugin version: 15.2, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.

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)
CURLNMBS.OptionDNSLocalIPv4 as String
property, CURL, MBS CURL Plugin (CURLN), class CURLNMBS,
Plugin version: 15.2, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.

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)
CURLNMBS.OptionDNSLocalIPv6 as String
property, CURL, MBS CURL Plugin (CURLN), class CURLNMBS,
Plugin version: 15.2, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.

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)
CURLNMBS.OptionEGDSocket as String
property, CURL, MBS CURL Plugin (CURLN), class CURLNMBS,
Plugin version: 9.8, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.

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)
CURLNMBS.OptionFailOnError as Boolean
property, CURL, MBS CURL Plugin (CURLN), class CURLNMBS,
Plugin version: 9.8, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.

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)
CURLNMBS.OptionFileTime as Boolean
property, CURL, MBS CURL Plugin (CURLN), class CURLNMBS,
Plugin version: 9.8, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.

Function: Whether filetime should be querried.
Example:
// init CURL with options
dim d as new CURLNMBS
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)
CURLNMBS.OptionFollowLocation as Boolean
property, CURL, MBS CURL Plugin (CURLN), class CURLNMBS,
Plugin version: 9.8, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.

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 CURLNMBS

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)
CURLNMBS.OptionForbitReuse as Boolean
property, CURL, MBS CURL Plugin (CURLN), class CURLNMBS,
Plugin version: 9.8, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.

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)
CURLNMBS.OptionFreshConnect as Boolean
property, CURL, MBS CURL Plugin (CURLN), class CURLNMBS,
Plugin version: 9.8, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.

Function: Set to true to make the next transfer use a new (fresh) connection by force.
Example:
dim c as new CURLNMBS

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)
CURLNMBS.OptionFTPAccount as String
property, CURL, MBS CURL Plugin (CURLN), class CURLNMBS,
Plugin version: 15.2, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.

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)
CURLNMBS.OptionFTPAlternativeToUser as String
property, CURL, MBS CURL Plugin (CURLN), class CURLNMBS,
Plugin version: 9.8, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.

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)
CURLNMBS.OptionFTPAppend as Boolean
property, CURL, MBS CURL Plugin (CURLN), class CURLNMBS,
Plugin version: 9.8, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.

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)
CURLNMBS.OptionFTPCreateMissingDirs as Integer
property, CURL, MBS CURL Plugin (CURLN), class CURLNMBS,
Plugin version: 9.8, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.

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)
CURLNMBS.OptionFTPFileMethod as Integer
property, CURL, MBS CURL Plugin (CURLN), class CURLNMBS,
Plugin version: 9.8, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.

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)
CURLNMBS.OptionFTPListOnly as Boolean
property, CURL, MBS CURL Plugin (CURLN), class CURLNMBS,
Plugin version: 9.8, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.

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)
CURLNMBS.OptionFTPPort as String
property, CURL, MBS CURL Plugin (CURLN), class CURLNMBS,
Plugin version: 9.8, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.

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)
CURLNMBS.OptionFTPResponseTimeout as Integer
property, CURL, MBS CURL Plugin (CURLN), class CURLNMBS,
Plugin version: 9.8, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.

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)
CURLNMBS.OptionFTPSkipPasvIP as Boolean
property, CURL, MBS CURL Plugin (CURLN), class CURLNMBS,
Plugin version: 9.8, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.

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)
CURLNMBS.OptionFTPSSL as Integer
property, CURL, MBS CURL Plugin (CURLN), class CURLNMBS,
Plugin version: 9.8, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.

Function: Request using SSL / TLS for the transfer.
Example:
dim c as CURLNMBS
c.OptionUseSSL = c.kFTPSSL_ALL
c.OptionSSLVersion = c.kSSLVersionTLSv12
This item is deprecated and should no longer be used. You can use OptionUseSSL instead.
Notes:
Set to an integer using one of the values from below, to make libCURL use your desired level of SSL for the transfer.
These are all protocols that start out plain text and get "upgraded" to SSL using the STARTTLS command.
This is for enabling SSL/TLS when you use FTP, SMTP, POP3, IMAP etc.

CURLUSESSL_NONE0Don't attempt to use SSL.
CURLUSESSL_TRY1Try using SSL, proceed as normal otherwise.
CURLUSESSL_CONTROL2Require SSL for the control connection or fail with CURLE_USE_SSL_FAILED.
CURLUSESSL_ALL3Require SSL for all communication or fail with CURLE_USE_SSL_FAILED.
(Read and Write property)
CURLNMBS.OptionFTPSSLAuth as Integer
property, CURL, MBS CURL Plugin (CURLN), class CURLNMBS,
Plugin version: 9.8, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.

Function: What kind of SSL authentication to use for FTP.
Notes:
Pass an integer using one of the values from below, to alter how libCURL issues "AUTH TLS" or "AUTH SSL" when FTP over SSL is activated (see CURLOPT_FTP_SSL). (Added in 7.12.2)

kFTPAUTH_DEFAULT = 0

Allow libCURL to decide

kFTPAUTH_SSL = 1

Try "AUTH SSL" first, and only if that fails try "AUTH TLS"

kFTPAUTH_TLS = 2

Try "AUTH TLS" first, and only if that fails try "AUTH 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)
CURLNMBS.OptionFTPSSLCCC as Integer
property, CURL, MBS CURL Plugin (CURLN), class CURLNMBS,
Plugin version: 9.8, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.

Function: If enabled, this option makes libCURL use CCC (Clear Command Channel).
Notes:
It shuts down the SSL/TLS layer after authenticating. The rest of the control channel communication will be unencrypted. This allows NAT routers to follow the FTP transaction. Pass a long using one of the values below. (Added in 7.16.1)

CURLFTPSSL_CCC_NONE0Don't attempt to use CCC.
CURLFTPSSL_CCC_PASSIVE1Do not initiate the shutdown, but wait for the server to do it. Do not send a reply.
CURLFTPSSL_CCC_ACTIVE2Initiate the shutdown and wait for a reply.
(Read and Write property)
CURLNMBS.OptionFTPUseEPRT as Boolean
property, CURL, MBS CURL Plugin (CURLN), class CURLNMBS,
Plugin version: 9.8, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.

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)
CURLNMBS.OptionFTPUseEPSV as Boolean
property, CURL, MBS CURL Plugin (CURLN), class CURLNMBS,
Plugin version: 9.8, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.

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)
CURLNMBS.OptionFTPusePret as Boolean
property, CURL, MBS CURL Plugin (CURLN), class CURLNMBS,
Plugin version: 11.0, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.

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)
CURLNMBS.OptionGet as Boolean
property, CURL, MBS CURL Plugin (CURLN), class CURLNMBS,
Plugin version: 9.8, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.

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)
CURLNMBS.OptionHeader as Boolean
property, CURL, MBS CURL Plugin (CURLN), class CURLNMBS,
Plugin version: 9.8, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.

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)
CURLNMBS.OptionHTTPAuth as Integer
property, CURL, MBS CURL Plugin (CURLN), class CURLNMBS,
Plugin version: 9.8, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.

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)
CURLNMBS.OptionHTTPContentDecoding as Integer
property, CURL, MBS CURL Plugin (CURLN), class CURLNMBS,
Plugin version: 9.8, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.

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)

Previous items Next items

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




Links
MBS FileMaker tutorial videos