MBS Xojo Developer Conference and Training
Join us from 3rd to 6th May 2017 in Berlin, Germany.

Platforms to show: All Mac Windows Linux Cross-Platform

Previous items Next items

CURLNMBS.OptionHTTPProxyTunnel 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 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)
CURLNMBS.OptionHTTPTransferDecoding 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 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)
CURLNMBS.OptionHTTPVersion 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: 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)
CURLNMBS.OptionIgnoreContentLength 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 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)
CURLNMBS.OptionInFileSize as Int64
property, CURL, MBS CURL Plugin (CURLN), class CURLNMBS,
Plugin version: 9.8, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.

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

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)
CURLNMBS.OptionInterface 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: 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)
CURLNMBS.OptionIPResolve 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: Allows an application to select what kind of IP addresses to use when resolving host names.
Example:
dim c as new CURLNMBS
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)
CURLNMBS.OptionIssuerCert as String
property, CURL, MBS CURL Plugin (CURLN), class CURLNMBS,
Plugin version: 10.0, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.

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)
(Read and Write property)
CURLNMBS.OptionKeyPassword 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 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)
CURLNMBS.OptionKRB4Level 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: 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)
CURLNMBS.OptionKRBLevel 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: 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)
CURLNMBS.OptionLocalPort 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: 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)
CURLNMBS.OptionLocalPortRange 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: 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)
CURLNMBS.OptionLoginOptions as String
property, CURL, MBS CURL Plugin (CURLN), class CURLNMBS,
Plugin version: 15.4, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.

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

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

Function: A string that will be used to specify the sender address in a mail when sending an SMTP mail with libCURL.
Notes: (Read and Write property)
CURLNMBS.OptionMaxConnects 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 set number will be the persistent connection cache size.
Notes:
The set amount will be the maximum amount of simultaneously open connections that libCURL may cache. Default is 5, and there isn't much point in changing this value unless you are perfectly aware of how this work and changes libCURL's behaviour. This concerns connection using any of the protocols that support persistent connections.

When reaching the maximum limit, CURL closes the oldest one in the cache to prevent the number of open connections to increase.

If you already have performed transfers with this CURL handle, setting a smaller MAXCONNECTS than before may cause open connections to get closed unnecessarily.

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

Function: This allows you to specify the maximum size (in bytes) of a file to download.
Notes:
If the file requested is larger than this value, the transfer will not start and kError_FILESIZE_EXCEEDED will be returned.

The file size is not always known prior to download, and for such files this option has no effect even if the file transfer ends up being larger than this given limit. This concerns both FTP and HTTP transfers.

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

Function: This allows you to specify the maximum size (in bytes) of a file to download.
This item is deprecated and should no longer be used. You can use OptionMaxFileSize instead.
Notes:
If the file requested is larger than this value, the transfer will not start and kError_FILESIZE_EXCEEDED will be returned. (Added in 7.11.0)

The file size is not always known prior to download, and for such files this option has no effect even if the file transfer ends up being larger than this given limit. This concerns both FTP and HTTP transfers.

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

Function: Defines the maximum download speed.
Notes:
If a download exceeds this speed (counted in bytes per second) on cumulative average during the transfer, the transfer will pause to keep the average rate less than or equal to the parameter value. Defaults to unlimited speed. (Added in 7.15.5)
(Read and Write property)
CURLNMBS.OptionMaxRecvSpeedLarge as Int64
property, CURL, MBS CURL Plugin (CURLN), class CURLNMBS,
Plugin version: 9.8, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.

Function: Defines the maximum download speed.
This item is deprecated and should no longer be used. You can use OptionMaxRecvSpeed instead.
Notes:
If a download exceeds this speed (counted in bytes per second) on cumulative average during the transfer, the transfer will pause to keep the average rate less than or equal to the parameter value. Defaults to unlimited speed. (Added in 7.15.5)
(Read and Write property)
CURLNMBS.OptionMaxRedirs 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 set number will be the redirection limit.
Example:
dim c as new CURLNMBS

c.OptionFollowLocation = true
c.OptionMaxRedirs = 3
Notes:
If that many redirections have been followed, the next redirect will cause an error (kError_TOO_MANY_REDIRECTS). This option only makes sense if the CURLOPT_FOLLOWLOCATION is used at the same time. Added in 7.15.1: Setting the limit to 0 will make libCURL refuse any redirect. Set it to -1 for an infinite number of redirects (which is the default)

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

Function: Defines the maximum upload speed.
Notes:
If an upload exceeds this speed on cumulative average during the transfer, the transfer will pause to keep the average rate less than or equal to the parameter value. Defaults to unlimited speed. (Added in 7.15.5)
Value is in bytes per second.
Useful if you have a limited pipe and you'd like your transfer not to use your entire bandwidth.
Slowing down the transfer speed is also useful for lowering CPU consumption during transfers.
(Read and Write property)
CURLNMBS.OptionMaxSendSpeedLarge as Int64
property, CURL, MBS CURL Plugin (CURLN), class CURLNMBS,
Plugin version: 9.8, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.

Function: Defines the maximum upload speed.
This item is deprecated and should no longer be used. You can use OptionMaxSendSpeed instead.
Notes:
If an upload exceeds this speed on cumulative average during the transfer, the transfer will pause to keep the average rate less than or equal to the parameter value. Defaults to unlimited speed. (Added in 7.15.5)
Value is in bytes per second.
Useful if you have a limited pipe and you'd like your transfer not to use your entire bandwidth.
Slowing down the transfer speed is also useful for lowering CPU consumption during transfers.
(Read and Write property)
CURLNMBS.OptionNetRC 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: Controls usage of netrc file.
Notes:
This parameter controls the preference of libCURL between using user names and passwords from your ~/.netrc file, relative to user names and passwords in the URL supplied with OptionURL.

libCURL uses a user name (and supplied or prompted password) supplied with OptionUsername and OptionPassword in preference to any of the options controlled by this parameter.

An integer, set to one of the values described below.

kNETRC_OPTIONAL = 1

The use of your ~/.netrc file is optional, and information in the URL is to be preferred. The file will be scanned with the host and user name (to find the password only) or with the host only, to find the first user name and password after that machine, which ever information is not specified in the URL.

Undefined values of the option will have this effect.

kNETRC_IGNORED = 0

The library will ignore the file and use only the information in the URL.

This is the default.

kNETRC_REQUIRED = 2

This value tells the library that use of the file is required, to ignore the information in the URL, and to search the file with the host only.

Only machine name, user name and password are taken into account (init macros and similar things aren't supported).

libCURL does not verify that the file has the correct properties set (as the standard Unix ftp client does). It should only be readable by user.

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.OptionNetRCFile 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: A string containing the full path name to the file you want libCURL to use as .netrc file.
Notes:
If this option is omitted, and OptionNETRC is set, libCURL will attempt to find the a .netrc file in the current user's home directory. (Added in 7.10.9)

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

Function: An integer, containing the value of the permissions that will be assigned to newly created directories on the remote server.
Notes:
The default value is 0755, but any valid value can be used. The only protocols that can use this are sftp://, scp://, and file://. (Added in 7.16.4)
Value must be octal, so use &o prefix for number.
(Read and Write property)

Previous items Next items

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




Links
MBS Realbasic PDF Plugins