Xojo Developer Conference
25/27th April 2018 in Denver.
MBS Xojo Conference
6/7th September 2018 in Munich, Germany.

Platforms to show: All Mac Windows Linux Cross-Platform

Next items

CURLNMBS.Cancel as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property CURL MBS CURL Plugin 13.2 Yes Yes Yes Yes No
Function: Tells CURL instance to cancel transfer as soon as possible.
Notes:
Especially when using PerformMT, you may see your app hang if user tries to quit application. To prevent the hang, please set Cancel = true in window close event. So when app quits and windows get destroyed, the PerformMT will see the Cancel being true and returns soon.
(Read and Write property)

Feedback, Comments & Corrections

CURLNMBS.CollectDebugData as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property CURL MBS CURL Plugin 12.3 Yes Yes Yes Yes No
Function: Whether to collect debug message data.
Notes:
If you set this property to true, you can grab the data from the transfer in the DebugData Property instead of collecting the pieces yourself in the DebugMessage event. Of course this is optional and you can still process data in DebugMessage event.
Due to memory limitation, collecting data will not work right if your app is running low on memory.
(Read and Write property)

Feedback, Comments & Corrections

CURLNMBS.CollectHeaderData as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property CURL MBS CURL Plugin 12.3 Yes Yes Yes Yes No
Function: Whether to collect header data.
Notes:
If you set this property to true, you can grab the data from the transfer in the headerData Property instead of collecting the pieces yourself in the header event. Of course this is optional and you can still process data in header event.
Due to memory limitation, collecting data will not work right if your app is running low on memory.
(Read and Write property)

Feedback, Comments & Corrections

CURLNMBS.CollectOutputData as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property CURL MBS CURL Plugin 12.3 Yes Yes Yes Yes No
Function: Whether to collect output data.
Notes:
If you set this property to true, you can grab the data from the transfer in the OutputData Property instead of collecting the pieces yourself in the write event. Of course this is optional and you can still process data in write event.
Due to memory limitation, collecting data will not work right if your app is running low on memory.
(Read and Write property)

Feedback, Comments & Corrections

CURLNMBS.DebugData as String
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property CURL MBS CURL Plugin 12.3 Yes Yes Yes Yes No
Function: The debug data from CURL.
Notes:
If CollectDebugData property is true, the plugin puts the data received in debugMessage event also into this property, so you can grab it after the transfer. Use ClearData method to clear when reusing CURL object.
(Read only property)

Feedback, Comments & Corrections

CURLNMBS.Handle 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 internal handle of the CURL object.
Notes: (Read and Write property)

Feedback, Comments & Corrections

CURLNMBS.HeaderData as String
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property CURL MBS CURL Plugin 12.3 Yes Yes Yes Yes No
Function: The header data from CURL.
Notes:
If CollectHeaderData property is true, the plugin puts the data received in header event also into this property, so you can grab it after the transfer. Use ClearData method to clear when reusing CURL object.
(Read only property)

Feedback, Comments & Corrections

CURLNMBS.InputData as String
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property CURL MBS CURL Plugin 14.0 Yes Yes Yes Yes No
Function: The input data.
Notes:
If you set input data, you do not need to use Read, RestartRead or Seek events.
The plugin will use the provided data for the upload.
Setting input data size, will also set the input file size (OptionInFileSizeLarge and OptionInFileSize).

Alternatively you can provide data in Read event or use OpenMTInputFile method to open a file on disk to upload.
(Read and Write property)

Feedback, Comments & Corrections

CURLNMBS.Lasterror 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 lasterror from the library.
Notes:
Set in the constructor while doing initialization.
Check the kError* constants.
(Read and Write property)

Feedback, Comments & Corrections

CURLNMBS.LasterrorMessage as String
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property CURL MBS CURL Plugin 11.3 Yes Yes Yes Yes No
Function: The last error message.
Notes: (Read only property)

Feedback, Comments & Corrections

CURLNMBS.OptionAcceptEncoding as String
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property CURL MBS CURL Plugin 13.0 Yes Yes Yes Yes No
Function: Sets the contents of the Accept-Encoding: header sent in a HTTP request, and enables decoding of a response when a Content-Encoding: header is received.
Example:
dim c as new CURLNMBS
c.OptionAcceptEncoding = "deflate"
Notes:
Three encodings are supported: identity, which does nothing, deflate which requests the server to compress its response using the zlib algorithm, and gzip which requests the gzip algorithm. If a zero-length string is set, then an Accept-Encoding: header containing all supported encodings is sent.

This is a request, not an order; the server may or may not do it. This option must be set (to any non-NULL value) or else any unsolicited encoding done by the server is ignored. See the special file README.encoding for details (included with CURL source code).
(Read and Write property)

Feedback, Comments & Corrections

CURLNMBS.OptionAddressScope 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: Pass an integer specifying the scope_id value to use when connecting to IPv6 link-local or site-local addresses.
Notes:
(Added in CURL 7.19.0)
(Read and Write property)

Feedback, Comments & Corrections

CURLNMBS.OptionAppend 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: True tells the library to append to the remote file instead of overwrite it.
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

CURLNMBS.OptionAutoReferer 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: When enabled, libCURL will automatically set the Referer: field in requests where it follows a Location: redirect.
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)

Feedback, Comments & Corrections

CURLNMBS.OptionBufferSize 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: Your preferred size (in bytes) for the receive buffer in libCURL.
Notes:
The main point of this would be that the write callback gets called more often and with smaller chunks. This is just treated as a request, not an order. You cannot be guaranteed to actually get the given size. (Added in 7.10)

This size is by default set as big as possible (OptionMaxWriteSize), so it only makse sense to use this option if you want it smaller.

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

CURLNMBS.OptionCAInfo 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: A string naming a file holding one or more certificates to verify the peer with.
Notes:
This makes sense only when used in combination with the OptionSSLVerifyPeer option. If OptionSSLVerifyPeer is false, OptionCAINFO need not even indicate an accessible file.

Note that option is by default set to the system path where libCURL's cacert bundle is assumed to be stored, as established at build time.

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

CURLNMBS.OptionCAPath 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: A string naming a directory holding multiple CA certificates to verify the peer with.
Notes:
The certificate directory must be prepared using the openssl c_rehash utility. This makes sense only when used in combination with the CURLOPT_SSL_VERIFYPEER option. If OptionSSLVerifyPeer is zero, OptionCAPath need not even indicate an accessible path. The OptionCAPath function apparently does not work in Windows due to some limitation in openssl. This option is OpenSSL-specific and does nothing if libCURL is built to use GnuTLS.

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

CURLNMBS.OptionCertInfo as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property CURL MBS CURL Plugin 10.0 Yes Yes Yes Yes No
Function: Set to true to enable libCURL's certificate chain info gatherer.
Notes:
With this enabled, libCURL (if built with OpenSSL) will extract lots of information and data about the certificates in the certificate chain used in the SSL connection. This data is then possible to extract after a transfer using GetInfoCertInfo. (Added in 7.19.1)
(Read and Write property)

Feedback, Comments & Corrections

CURLNMBS.OptionConnectionTimeout 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 connection to the server to take.
Notes:
This only limits the connection phase, once it has connected, this option is of no more use. Set to zero to disable connection timeout (it will then only timeout on the system's internal timeouts). See also the OptionTimeout option.
(Read and Write property)

Feedback, Comments & Corrections

CURLNMBS.OptionConnectionTimeOutMS 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 milli seconds that you allow the connection to the server to take.
Notes:
This only limits the connection phase, once it has connected, this option is of no more use. Set to zero to disable connection timeout (it will then only timeout on the system's internal timeouts). See also the OptionTimeout option.
(Read and Write property)

Feedback, Comments & Corrections

CURLNMBS.OptionConnectOnly 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 true tells the library to perform any required proxy authentication and connection setup, but no data transfer.
Notes:
This option is useful with the CURLNMBS.GetInfoLastSocket function. The library can set up the connection and then the application can obtain the most recently used socket for special data transfers. (Added in 7.15.2)
(Read and Write property)

Feedback, Comments & Corrections

CURLNMBS.OptionCookie 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 used to set a cookie in the http request.
Notes:
The format of the string should be NAME=CONTENTS, where NAME is the cookie name and CONTENTS is what the cookie should contain.

If you need to set multiple cookies, you need to set them all using a single option and thus you need to concatenate them all in one single string. Set multiple cookies in one string like this: "name1=content1; name2=content2;" etc.

Using this option multiple times will only make the latest string override the previously ones.

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

CURLNMBS.OptionCookieFile 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 cookie file content.
Notes:
It should contain the name of your file holding cookie data to read. The cookie data may be in Netscape / Mozilla cookie data format or just regular HTTP-style headers dumped to a file.

Given an empty or non-existing file or by passing the empty string (""), this option will enable cookies for this CURL handle, making it understand and parse received cookies and then use matching cookies in future request.

If you use this option multiple times, you just add more files to read. Subsequent files will add more cookies.

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

CURLNMBS.OptionCookieJar 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: File path where to write the cookies to.
Notes:
This will make libCURL write all internally known cookies to the specified file, when the object is destroyed. If no cookies are known, no file will be created. Specify "-" to instead have the cookies written to stdout. Using this option also enables cookies for this session, so if you for example follow a location it will make matching cookies get sent accordingly.

If the cookie jar file can't be created or written to, libCURL will not and cannot report an error for this. Using OptionVerbose or DebugFunction event will get a warning to display, but that is the only visible feedback you get about this possibly lethal situation.

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

CURLNMBS.OptionCookieList 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 cookie string.
Notes:
Cookie can be either in Netscape / Mozilla format or just regular HTTP-style header (Set-Cookie: ...) format. If CURL cookie engine was not enabled it will enable its cookie engine. Passing a magic string "ALL" will erase all cookies known by CURL. (Added in 7.14.1) Passing the special string "SESS" will only erase all session cookies known by CURL. (Added in 7.15.4)

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

CURLNMBS.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)

Feedback, Comments & Corrections

CURLNMBS.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)

Feedback, Comments & Corrections

CURLNMBS.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)

Feedback, Comments & Corrections

CURLNMBS.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 CURLNMBS // 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.
(Read and Write property)

Feedback, Comments & Corrections

Next items

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




Links
MBS Xojo Plugins