Platforms to show: All Mac Windows Linux Cross-Platform

Back to CURLMBS class.

Previous items Next items

CURLMBS.GetInfoConnectTime as Double

Type Topic Plugin Version macOS Windows Linux iOS Targets
method CURL MBS CURL Plugin 9.8 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
The time, in seconds, it took from the start until the connect to the remote host (or proxy) was completed.

The Lasterror property is set. 0 for success.

CURLMBS.GetInfoContentLengthDownload as Double

Type Topic Plugin Version macOS Windows Linux iOS Targets
method CURL MBS CURL Plugin 9.8 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
The content-length of the download.

The Lasterror property is set. 0 for success.
This is the value read from the Content-Length: field.

CURLMBS.GetInfoContentLengthUpload as Double

Type Topic Plugin Version macOS Windows Linux iOS Targets
method CURL MBS CURL Plugin 9.8 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
The specified size of the upload.

The Lasterror property is set. 0 for success.

CURLMBS.GetInfoContentType as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
method CURL MBS CURL Plugin 9.8 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
The content-type of the downloaded object.

The Lasterror property is set. 0 for success.
This is the value read from the Content-Type: field. If you get "", it means that the server didn't send a valid Content-Type header or that the protocol used doesn't support this.

CURLMBS.GetInfoCookieList as CURLListMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method CURL MBS CURL Plugin 9.8 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
A linked-list of all cookies CURL knows (expired ones, too).

The Lasterror property is set. 0 for success.
If there are no cookies (cookies for the handle have not been enabled or simply none have been received) the result is nil.

CURLMBS.GetInfoEffectiveMethod as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
method CURL MBS CURL Plugin 20.4 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Get the last used effective HTTP method.

In cases when you've asked libcurl to follow redirects, the method may very well not be the same method the first request would use.

CURLMBS.GetInfoEffectiveURL as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
method CURL MBS CURL Plugin 9.8 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
The last used effective URL.

The Lasterror property is set. 0 for success.

CURLMBS.GetInfoFileTime as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method CURL MBS CURL Plugin 9.8 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
the remote time of the retrieved document (in number of seconds since 1 jan 1970 in the GMT/UTC time zone).
Example
// init CURL with options
Var d as new CURLMBS
d.OptionFileTime = true
d.OptionURL = "http://www.monkeybreadsoftware.de/images/mbs.jpg"

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

// calculate date object
Var 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

The Lasterror property is set. 0 for success.
If you get -1, it can be because of many reasons (unknown, the server hides it or the server doesn't support the command that tells document time etc) and the time of the document is unknown. Note that you must tell the server to collect this information before the transfer is made, by using the OptionFileTime option or you will unconditionally get a -1 back. (Added in 7.5)

CURLMBS.GetInfoFTPEntryPath as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
method CURL MBS CURL Plugin 15.2 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Returns a string holding the path of the entry path.

That is the initial path libCURL ended up in when logging on to the remote FTP server.
Empty string if unknown.

CURLMBS.GetInfoHeaderSize as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method CURL MBS CURL Plugin 9.8 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
The total size of all the headers received.

The Lasterror property is set. 0 for success.

CURLMBS.GetInfoHTTPAuthAvail as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method CURL MBS CURL Plugin 9.8 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
A bitmask indicating the authentication method(s) available.

The Lasterror property is set. 0 for success.
The meaning of the bits is explained in the HTTPAuth option.

CURLMBS.GetInfoHTTPConnectCode as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method CURL MBS CURL Plugin 9.8 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
The last received proxy response code to a CONNECT request.

The Lasterror property is set. 0 for success.
none

CURLMBS.GetInfoHTTPVersion as integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method CURL MBS CURL Plugin 18.2 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Get the http version used in the connection.

The returned value will be kHTTP_VERSION_1_0, kHTTP_VERSION_1_1, or kHTTP_VERSION_2_0, or 0 if the version can't be determined.

CURLMBS.GetInfoLastSocket as Integer   Deprecated

Type Topic Plugin Version macOS Windows Linux iOS Targets
method CURL MBS CURL Plugin 15.2 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
This item is deprecated and should no longer be used. You can use GetInfoActiveSocket instead.
Receive the last socket used by this CURL session.

If the socket is no longer valid, -1 is returned. When you finish working with the socket, the destructor will free the handle as usual and let libCURL close the socket and cleanup other resources associated with the handle. This is typically used in combination with OptionConnectOnly. (Added in 7.15.2)

NOTE: this API is not really working on win64, since the SOCKET type on win64 is 64 bit large while its 'long' is only 32 bits.

CURLMBS.GetInfoLocalIP as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
method CURL MBS CURL Plugin 15.2 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Queries local IP.
Example
Var c as new CURLMBS

// do some transfer
c.OptionURL = "http://www.mbsplugins.de/"
Var e as Integer = c.perform

// now check local IP
MsgBox c.GetInfoLocalIP

CURLMBS.GetInfoLocalPort as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method CURL MBS CURL Plugin 15.2 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Return the local port of the most recent (primary) connection.
Example
Var c as new CURLMBS

// do some transfer
c.OptionURL = "http://www.mbsplugins.de/"
Var e as Integer = c.perform

// now check local IP and port
MsgBox c.GetInfoLocalIP+":"+str(c.GetInfoLocalPort)

CURLMBS.GetInfoNameLookupTime as Double

Type Topic Plugin Version macOS Windows Linux iOS Targets
method CURL MBS CURL Plugin 9.8 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
The time, in seconds, it took from the start until the name resolving was completed.

The Lasterror property is set. 0 for success.

CURLMBS.GetInfoNumConnects as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method CURL MBS CURL Plugin 9.8 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
How many new connections libCURL had to create to achieve the previous transfer.

The Lasterror property is set. 0 for success.
(only the successful connects are counted)
Combined with RedirectCount you are able to know how many times libCURL successfully reused existing connection(s) or not. See the Connection Options to see how libCURL tries to make persistent connections to save time.

CURLMBS.GetInfoOSErrno as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method CURL MBS CURL Plugin 9.8 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
The errno variable from a connect failure.

The Lasterror property is set. 0 for success.

CURLMBS.GetInfoPreTransferTime as Double

Type Topic Plugin Version macOS Windows Linux iOS Targets
method CURL MBS CURL Plugin 9.8 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
The time, in seconds, it took from the start until the file transfer is just about to begin.

The Lasterror property is set. 0 for success.
This includes all pre-transfer commands and negotiations that are specific to the particular protocol(s) involved.

CURLMBS.GetInfoPrimaryIP as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
method CURL MBS CURL Plugin 15.2 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Return the ip address of the most recent (primary) connection.
Example
Var c as new CURLMBS

// do some transfer
c.OptionURL = "http://www.mbsplugins.de/"
Var e as Integer = c.perform

// now check primary IP and port
MsgBox c.GetInfoPrimaryIP+":"+str(c.GetInfoPrimaryport)

CURLMBS.GetInfoPrimaryPort as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method CURL MBS CURL Plugin 15.2 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Return the (remote) port of the most recent (primary) connection.
Example
Var c as new CURLMBS

// do some transfer
c.OptionURL = "http://www.mbsplugins.de/"
Var e as Integer = c.perform

// now check primary IP and port
MsgBox c.GetInfoPrimaryIP+":"+str(c.GetInfoPrimaryport)

CURLMBS.GetInfoProtocol as integer   Deprecated

Type Topic Plugin Version macOS Windows Linux iOS Targets
method CURL MBS CURL Plugin 18.2 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
This item is deprecated and should no longer be used.
Get the protocol used in the connection.

See kProtocol* constants.

CURLMBS.GetInfoProxyAuthAvail as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method CURL MBS CURL Plugin 9.8 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
A bitmask indicating the authentication method(s) available for your proxy authentication.

The Lasterror property is set. 0 for success.

CURLMBS.GetInfoProxyError as integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method CURL MBS CURL Plugin 20.5 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Queries proxy error code.

CURLMBS.GetInfoProxySSLVerifyResult as integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method CURL MBS CURL Plugin 18.2 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Get the result of the proxy certificate verification.

receive the result of the certificate verification that was requested (using the OptionProxySSLVerifyPeer option. This is only used for HTTPS proxies.

CURLMBS.GetInfoRedirectCount as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method CURL MBS CURL Plugin 9.8 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
The total number of redirections that were actually followed.

The Lasterror property is set. 0 for success.

CURLMBS.GetInfoRedirectTime as Double

Type Topic Plugin Version macOS Windows Linux iOS Targets
method CURL MBS CURL Plugin 9.8 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
the total time, in seconds, it took for all redirection steps include name lookup, connect, pretransfer and transfer before final transaction was started.

The Lasterror property is set. 0 for success.
RedirectTime contains the complete execution time for multiple redirections. (Added in 7.9.7)

CURLMBS.GetInfoRedirectURL as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
method CURL MBS CURL Plugin 15.2 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
The redirection URL.

CURLMBS.GetInfoReferer as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
method CURL MBS CURL Plugin 21.2 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Queries referrer text.

CURLMBS.GetInfoRequestSize as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method CURL MBS CURL Plugin 9.8 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
The total size of the issued requests.

The Lasterror property is set. 0 for success.
This is so far only for HTTP requests. Note that this may be more than one request if FOLLOWLOCATION is true.

CURLMBS.GetInfoResponseCode as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method CURL MBS CURL Plugin 9.8 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
The last received HTTP or FTP code.

The Lasterror property is set. 0 for success.
This will be zero if no server response code has been received. Note that a proxy's CONNECT response should be read with GetInfoHTTPConnectCode and not this.

With HTTP transfer, a successful transfer reports 200 here. If the page is not found, you get 404. Or any other HTTP Response code.

CURLMBS.GetInfoRetryAfter as integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method CURL MBS CURL Plugin 20.4 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Returns the Retry-After retry delay.

Receive the number of seconds the HTTP server suggesets the client should wait until the next request is issued.
The information from the "Retry-After:" header.

While the HTTP header might contain a fixed date string, the RetryAfter will always return number of seconds to wait - or zero if there was no header or the header couldn't be parsed.

CURLMBS.GetInfoRTSPClientCSEQ as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method CURL MBS CURL Plugin 15.2 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Query RTSP Client sequence counter.

CURLMBS.GetInfoRTSPCSEQRecv as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method CURL MBS CURL Plugin 15.2 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Query RTSP sequence counter received.

CURLMBS.GetInfoRTSPServerCSEQ as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method CURL MBS CURL Plugin 15.2 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Query RTSP Server sequence counter.

CURLMBS.GetInfoRTSPSessionID as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
method CURL MBS CURL Plugin 15.2 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Query RTSP session ID.

CURLMBS.GetInfoScheme as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
method CURL MBS CURL Plugin 18.2 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Get the URL scheme (sometimes called protocol) used in the connection

CURLMBS.GetInfoSizeDownload as Double

Type Topic Plugin Version macOS Windows Linux iOS Targets
method CURL MBS CURL Plugin 9.8 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
The total amount of bytes that were downloaded.

The Lasterror property is set. 0 for success.
The amount is only for the latest transfer and will be reset again for each new transfer.

CURLMBS.GetInfoSizeUpload as Double

Type Topic Plugin Version macOS Windows Linux iOS Targets
method CURL MBS CURL Plugin 9.8 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
The total amount of bytes that were uploaded.

The Lasterror property is set. 0 for success.

CURLMBS.GetInfoSpeedDownload as Double

Type Topic Plugin Version macOS Windows Linux iOS Targets
method CURL MBS CURL Plugin 9.8 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
The average download speed that CURL measured for the complete download.

The Lasterror property is set. 0 for success.

CURLMBS.GetInfoSpeedUpload as Double

Type Topic Plugin Version macOS Windows Linux iOS Targets
method CURL MBS CURL Plugin 9.8 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
The average upload speed that CURL measured for the complete upload.

The Lasterror property is set. 0 for success.

CURLMBS.GetInfoSSLEngines as CURLListMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method CURL MBS CURL Plugin 9.8 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Receive a linked-list of OpenSSL crypto-engines supported.

The Lasterror property is set. 0 for success.
Note that engines are normally implemented in separate dynamic libraries. Hence not all the returned engines may be available at run-time.

CURLMBS.GetInfoSSLVerifyResult as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method CURL MBS CURL Plugin 9.8 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
the result of the certification verification that was requested (using the SSLVerifyPeer option).

The Lasterror property is set. 0 for success.

CURLMBS.GetInfoStartTransferTime as Double

Type Topic Plugin Version macOS Windows Linux iOS Targets
method CURL MBS CURL Plugin 9.8 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
the time, in seconds, it took from the start until the first byte is just about to be transferred.

The Lasterror property is set. 0 for success.
This includes the pretransfer time and also the time the server needs to calculate the result.

CURLMBS.GetInfoTotalTime as Double

Type Topic Plugin Version macOS Windows Linux iOS Targets
method CURL MBS CURL Plugin 9.8 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
The total time in seconds for the previous transfer, including name resolving, TCP connect etc.

The Lasterror property is set. 0 for success.

CURLMBS.OpenMTInputFile(file as folderitem, Offset as Integer = 0) as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method CURL MBS CURL Plugin 11.2 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Opens input file for reading data while PerformMT runs.
Example
Var c As New CURLMBS
Var file As FolderItem = SpecialFolder.Desktop.Child("test.rtf")

If c.OpenMTInputFile(file) Then
// okay
Else
MessageBox "Failed to open file to upload."
Return
End If

// do a SFTP upload
c.OptionURL = "sftp://monkeybreadsoftware.de/folder/test.rtf"
c.OptionUpload = True
c.OptionUsername = "test"
c.OptionPassword = "test"
c.CollectOutputData = false

Var e As Integer = c.Perform

Var ErrorMessage As String = c.LasterrorMessage
Var ErrorLog As String = c.DebugMessages
Var ResultData As String = c.OutputData

Break

The read event is not called with PerformMT.
Offset is helpful for HTTP PUT requests with range, so you can start with an offset.
With 15.2 version of plugin, this also works with Perform.

Must be called before Perform or PerformMT, so we can stream data from the file.
The file is closed automatically when Perform methods finish their work.

The function returns false in case of an error, e.g. if file is already open by another application, the foleritem/path is invalid, the offset is negative or we can't determinate the file size.
It may be wise to have a fallback in your code to use a binarystream in that case (if that one can read the file) and then read all the data in a string and put into the InputData property.

See also:

CURLMBS.OpenMTInputFile(Path as String, Offset as Integer = 0) as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method CURL MBS CURL Plugin 19.5 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Opens input file for reading data while PerformMT runs.

The read event is not called with PerformMT.
Offset is helpful for HTTP PUT requests with range, so you can start with an offset.

Must be called before Perform or PerformMT, so we can stream data from the file.
The file is closed automatically when Perform methods finish their work.

The function returns false in case of an error, e.g. if file is already open by another application, the foleritem/path is invalid, the offset is negative or we can't determinate the file size.
It may be wise to have a fallback in your code to use a binarystream in that case (if that one can read the file) and then read all the data in a string and put into the InputData property.

See also:

Previous items Next items

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


The biggest plugin in space...