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.OptionNewFilePerms 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 files on the remote server.
Notes:
The default value is &o0644, but any valid value can be used. The only protocols that can use this are sftp://, scp://, and file://. (Added in 7.16.4)
Be aware that you normally specify this in octal values. So use the &o prefix in Real Studio.
(Read and Write property)
CURLNMBS.OptionNoBody 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 not include the body-part in the output.
Notes:
This is only relevant for protocols that have separate header and body parts. On HTTP(S) servers, this will make libCURL do a HEAD request.

To change request to GET, you should use OptionGet. Change request to POST with OptionPost etc.

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.OptionNoProxy 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 with a comma- separated list of hosts which do not use a proxy, if one is specified.
Notes:
The only wildcard is a single * character, which matches all hosts, and effectively disables the proxy. Each name in this list is matched as either a domain which contains the hostname, or the hostname itself. For example, local.com would match local.com, local.com:80, and www.local.com, but not www.notlocal.com. (Added in 7.19.4)
(Read and Write property)
CURLNMBS.OptionNoSignal as Integer
property, CURL, MBS CURL Plugin (CURLN), class CURLNMBS,
Plugin version: 13.1, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.

Function: Whether to not use signals.
Notes:
If it is true, libCURL will not use any functions that install signal handlers or any functions that cause signals to be sent to the process. This option is mainly here to allow multi-threaded unix applications to still set/use all timeout options etc, without risking getting signals. (Added in 7.10)

If this option is set and libCURL has been built with the standard name resolver, timeouts will not occur while the name resolve takes place. Consider building libCURL with c-ares support to enable asynchronous DNS lookups, which enables nice timeouts for name resolves without signals.

Setting OptionNoSignal to true makes libCURL NOT ask the system to ignore SIGPIPE signals, which otherwise are sent by the system when trying to send data to a socket which is closed in the other end. libCURL makes an effort to never cause such SIGPIPEs to trigger, but some operating systems have no way to avoid them and even on those that have there are some corner cases when they may still happen, contrary to our desire. In addition, using CURLAUTH_NTLM_WB authentication could cause a SIGCHLD signal to be raised.
(Read and Write property)
CURLNMBS.OptionPassword 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: The password to use for the transfer.
Notes:
The OptionPassword option should be used in conjunction with the OptionUsername option.
(Read and Write property)
CURLNMBS.OptionPort 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 remote port number to connect to, instead of the one specified in the URL or the default port for the used protocol.
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.OptionPost 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 do a regular HTTP post.
Notes:
This will also make the library use the a "Content-Type: application/x-www-form-urlencoded" header. (This is by far the most commonly used POST method).

Use the OptionPostFields option to specify what data to post.

Optionally, you can provide data to POST using the Read event but then you must make sure to not set OptionPostFields to anything but "". When providing data with an event, you must transmit it using chunked transfer-encoding.

You can override the default POST Content-Type: header by setting your own with OptionHTTPHeader.

Using POST 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 POST to a HTTP 1.1 server, you can send data without knowing the size before starting the POST 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 in the request.

When setting CURLOPT_POST to a non-zero value, it will automatically set OptionNoBody to 0 (since 7.14.1).

If you issue a POST request and then want to make a HEAD or GET using the same re-used handle, you must explictly set the new request type using OptionNoBody or OptionGet or similar.

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.OptionPostFields 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 which should be the full data to post in an HTTP POST operation.
Example:
dim xml as string // XML or JSON to send as payload
dim c as new CURLNMBS

c.OptionFollowLocation = true
c.OptionMaxRedirs = 3
c.OptionPostFields = xml
c.OptionUserAgent = "Test App"
c.OptionPost = true

// for SOAP use right content type
c.SetOptionHTTPHeader array("Content-Type: application/soap+xml; charset=utf-8")
Notes:
You must make sure that the data is formatted the way you want the server to receive it. libCURL will not convert or encode it for you. Most web servers will assume this data to be url-encoded. Take note.

This POST is a normal application/x-www-form-urlencoded kind (and libCURL will set that Content-Type by default when this option is used), which is the most commonly used one by HTML forms. See also the OptionPost. Using OptionPostFields implies OptionPost.

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

To make multipart/formdata posts (aka rfc1867-posts), check out the OptionPost 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.OptionPostFieldSize 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: The size of the post data.
Notes:
Optional you can set the size of your post data.
If you specify a postfield string, this size will be set automatically.

If you specify a size and no postfield string, the Read event will request data.
(Read and Write property)
CURLNMBS.OptionPostFieldSizeLarge 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: The size of the post data. (64 bit version)
This item is deprecated and should no longer be used. You can use OptionPostFieldSize instead.
Notes:
Optional you can set the size of your post data.
If you specify a postfield string, this size will be set automatically.

If you specify a size and no postfield string, the Read event will request data.
(Read and Write property)
CURLNMBS.OptionPostRedir 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: A bitmask to control how libCURL acts on redirects after POSTs that get a 301 or 302 response back.
Notes:
A parameter with bit 0 set (value CURL_REDIR_POST_301=1) tells the library to respect RFC 2616/10.3.2 and not convert POST requests into GET requests when following a 301 redirection. Setting bit 1 (value CURL_REDIR_POST_302=2) makes libCURL maintain the request method after a 302 redirect. CURL_REDIR_POST_ALL is a convenience define that sets both bits.

The non-RFC behaviour is ubiquitous in web browsers, so the library does the conversion by default to maintain consistency. However, a server may require a POST to remain a POST after such a redirection. This option is meaningful only when setting OptionFollowLocation. (Added in 7.17.1) (This option was known as CURLOPT_POST301 up to 7.19.0 as it only supported the 301 way before then)
(Read and Write property)
CURLNMBS.OptionProtocols 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: A bitmask of kProtocol* constants.
Notes:
If used, this bitmask limits what protocols libCURL may use in the transfer. This allows you to have a libCURL built to support a wide range of protocols but still limit specific transfers to only be allowed to use a subset of them. By default libCURL will accept all protocols it supports. See also OptionRedirProtocols. (Added in 7.19.4)
(Read and Write property)
CURLNMBS.OptionProxy 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 HTTP proxy to use.
Example:
dim c as CURLNMBS // your CURL object
dim psAddress as string // your proxy address
dim psPort as Integer // your proxy port

c.OptionProxy=psAddress
c.OptionProxyPort=psPort
c.OptionProxyType=c.kPROXY_HTTP
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.

The parameter should be a string holding the host name or dotted IP address. To specify port number in this string, append :[port] to the end of the host name. The proxy string may be prefixed with [protocol]:// since any such prefix will be ignored. The proxy's port number may optionally be specified with the separate option ProxyHost.

When you tell the library to use an HTTP proxy, libCURL will transparently convert operations to HTTP even if you specify an FTP URL etc. This may have an impact on what other features of the library you can use, such as CURLOPT_QUOTE and similar FTP specifics that don't work unless you tunnel through the HTTP proxy. Such tunneling is activated with HTTPProxyTunnel.

libCURL respects the environment variables http_proxy, ftp_proxy, all_proxy etc, if any of those is set. The Proxy option does however override any possibly set environment variables.

Starting with 7.14.1, the proxy host string given in environment variables can be specified the exact same way as the proxy can be set with Proxy, include protocol prefix (http://) and embedded user + password.

You can use WinHTTPClientMBS class on Windows or CFProxyMBS on Mac to discover system proxy settings.
(Read and Write property)
CURLNMBS.OptionProxyAuth 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 proxy 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 for your proxy authentication. 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 ProxyUserPassword option. The bitmask can be constructed by or'ing together the bits listed above for the HTTPAuth option. As of this writing, only Basic, Digest and NTLM work. (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.
(Read and Write property)
CURLNMBS.OptionProxyPassword 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 which should be pointing to the password to use for the transfer while connecting to Proxy.
Notes:
The OptionProxyPassword option should be used in conjunction with the OptionProxyUsername option. (Added in 7.19.1)
(Read and Write property)
CURLNMBS.OptionProxyPort 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 proxy port to connect to unless it is specified in the proxy string OptionProxy.
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.

You can use OptionProxy with port, e.g. "12.34.56.78:8080" or pass port here and proxy without port.
For some users it seems like the option with OptionProxy including port works better.
(Read and Write property)
CURLNMBS.OptionProxyTransferMode 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: If this integer value is set to 1 (one), it tells libCURL to set the transfer mode (binary or ASCII) for FTP transfers done via an HTTP proxy, by appending ;type=a or ;type=i to the URL.
Notes:
Without this setting, or it being set to 0 (zero, the default), OptionTransferText has no effect when doing FTP via a proxy. Beware that not all proxies support this feature. (Added in 7.18.0)
(Read and Write property)
CURLNMBS.OptionProxyType 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 option is to set type of the proxy.
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.

Available options for this are kPROXY_HTTP, kPROXY_SOCKS4 (added in 7.15.2) kPROXY_SOCKS5. The HTTP type is default.
(Read and Write property)
CURLNMBS.OptionProxyUsername 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, which should be pointing to the user name to use for the transfer while connecting to Proxy.
Notes:
In order to specify the password to be used in conjunction with the user name use the OptionProxyPassword option.
(Read and Write property)
CURLNMBS.OptionPut 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 non-zero parameter tells the library to use HTTP PUT to transfer data.
Notes:
The data should be set with OptionInFileSize.

This option is deprecated and starting with version 7.12.1 you should instead use OptionUpload.

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.OptionRandomFile 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 file name for the random file.
Notes:
The file will be used to read from to seed the random engine for SSL. The more random the specified file is, the more secure the SSL connection will become.

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.OptionRange 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 which should contain the specified range you want.
Notes:
It should be in the format "X-Y", where X or Y may be left out. HTTP transfers also support several intervals, separated with commas as in "X-Y,N-M". Using this kind of multiple intervals will cause the HTTP server to send the response document in pieces (using standard MIME separation techniques). Pass a NULL to this option to disable the use of ranges.

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.OptionRedirProtocols 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 that holds a bitmask of kProtocol* constants.
Notes:
If used, this bitmask limits what protocols libCURL may use in a transfer that it follows to in a redirect when OptionFollowLocation is enabled. This allows you to limit specific transfers to only be allowed to use a subset of protocols in redirections. By default libCURL will allow all protocols except for FILE and SCP. This is a difference compared to pre-7.19.4 versions which unconditionally would follow to all protocols supported. (Added in 7.19.4)
(Read and Write property)
CURLNMBS.OptionReferer 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 referer to pass to the server.
Notes:
It will be used to set the Referer: header in the http request sent to the remote server. This can be used to fool servers or scripts. You can also set any custom header with OptionHTTPHeader.

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.OptionResumeFrom 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: It contains the offset in number of bytes that you want the transfer to start from.
Notes:
Set this option to 0 to make the transfer start from the beginning (effectively disabling resume). For FTP, set this option to -1 to make the transfer start from the end of the target file (useful to continue an interrupted upload).

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.OptionResumeFromLarge 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: It contains the offset in number of bytes that you want the transfer to start from.
This item is deprecated and should no longer be used. You can use OptionResumeFrom instead.
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.OptionSocks5GSSAPINEC as Boolean
property, CURL, MBS CURL Plugin (CURLN), class CURLNMBS,
Plugin version: 10.0, Mac: Yes, Win: Yes, Linux: Yes, Console & Web: Yes, Feedback.

Function: Whether to protect SOCKS5 connection is protected.
Notes:
Set to true to enable or false to disable. As part of the gssapi negotiation a protection mode is negotiated. The rfc1961 says in section 4.3/4.4 it should be protected, but the NEC reference implementation does not. If enabled, this option allows the unprotected exchange of the protection mode negotiation. (Added in 7.19.4).
(Read and Write property)
CURLNMBS.OptionSocks5GSSAPIService 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 holding the name of the service.
Notes:
The default service name for a SOCKS5 server is rcmd/server-fqdn. This option allows you to change it. (Added in 7.19.4)
(Read and Write property)
CURLNMBS.OptionSSHAuthTypes 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: Define the SSH authorization types.
Notes:
Pass a long set to a bitmask consisting of one or more of CURLSSH_AUTH_PUBLICKEY, CURLSSH_AUTH_PASSWORD, CURLSSH_AUTH_HOST, CURLSSH_AUTH_KEYBOARD. Set CURLSSH_AUTH_ANY to let libCURL pick one. (Added in 7.16.1)

constants:
CURLSSH_AUTH_ANY = &hFFFFFFFF
CURLSSH_AUTH_NONE = 0
CURLSSH_AUTH_PUBLICKEY = 1
CURLSSH_AUTH_PASSWORD = 2
CURLSSH_AUTH_HOST = 4
CURLSSH_AUTH_KEYBOARD = 8
CURLSSH_AUTH_DEFAULT = CURLSSH_AUTH_ANY
(Read and Write property)
CURLNMBS.OptionSSHHostPublicKeyMD5 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 containing 32 hexadecimal digits with the 128 bit MD5 checksum of the remote host's public key.
Notes:
libCURL will reject the connection to the host unless the md5sums match. This option is only for SCP and SFTP transfers. (Added in 7.17.1)
(Read and Write property)

Previous items Next items

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




Links
MBS Xojo Plugins