Topics   All   Mac OS X (Only)   Windows (Only)   Crossplatform   Server (Not)   Client   Components   Old   Guides
New in version: 4.0   4.1   4.2   4.3   4.4   5.0   5.1   5.2   5.3   5.4   6.0   6.1   6.2   6.3    Statistic  

Component: CURL

Up- and Download with FTP/SFTP/FTPS/HTTP/HTTPS.

You can use CURL functions for webservices, ftp uploads, directory listing and other network tasks.

Name Description Mac/Win Version
CURL.AddInputFile Adds input to file data from the container value. Both 2.7
CURL.AddInputGIF Adds input to GIF data from the container value. Both 3.1
CURL.AddInputJPEG Adds input to JPEG data from the container value. Both 2.7
CURL.AddInputPDF Adds input to PDF data from the container value. Both 4.0
CURL.AddInputPNG Adds input to PNG data from the container value. Both 2.7
CURL.AddInputText Adds input data for this transfer to be the text you provide. Both 2.7
CURL.Cancel Cancels a running transfer in background. Both 2.5
CURL.Check Checks for curl events. Both 5.2
CURL.Cleanup End a CURL session. Both 2.5
CURL.CloseDebugFile Closes the debug output file. Both 2.6
CURL.CloseHeaderFile Closes the header output file. Both 2.6
CURL.CloseInputFile Closes the header output file. Both 2.6
CURL.CloseOutputFile Closes the data output file. Both 2.6
CURL.CreateDebugOutputFile Creates output file for writing debug messages. Both 2.6
CURL.CreateHeaderOutputFile Creates output file for writing header text. Both 2.6
CURL.CreateOutputFile Creates output file for downloading data. Both 2.6
CURL.ErrorCode Returns the last CURL error code. Both 2.5
CURL.ErrorMessage Returns the last CURL error message. Both 2.5
CURL.FormAddKeyContainer Add a section to a multipart/formdata HTTP POST. Both 2.6
CURL.FormAddKeyContainerContentType Add a section to a multipart/formdata HTTP POST. Both 2.6
CURL.FormAddKeyFile Add a section to a multipart/formdata HTTP POST. Both 2.6
CURL.FormAddKeyFileContentType Add a section to a multipart/formdata HTTP POST. Both 2.6
CURL.FormAddKeyText Add a section to a multipart/formdata HTTP POST. Both 2.6
CURL.FormAddKeyTextContentType Add a section to a multipart/formdata HTTP POST. Both 2.6
CURL.FormAddKeyValue Add a section to a multipart/formdata HTTP POST. Both 2.5
CURL.FormAddKeyValueContentType Add a section to a multipart/formdata HTTP POST. Both 2.5
CURL.FormFinish Finishes constructing a form. Both 2.5
CURL.GetAppConnectTime Get the time, in seconds, it took from the start until the SSL/SSH connect/handshake to the remote host was completed. Both 2.5
CURL.GetCertInfo Queries information on the certificate chain. Both 5.2
CURL.GetConditionUnmet Get the number 1 if the condition provided in the previous request didn't match. Both 2.5
CURL.GetConnectTime Get the time, in seconds, it took from the start until the connect to the remote host (or proxy) was completed. Both 2.5
CURL.GetContentLengthDownload Get the content-length of the download. Both 2.5
CURL.GetContentLengthUpload Get the specified size of the upload. Both 2.5
CURL.GetContentType Get the content-type of the downloaded object. Both 2.5
CURL.GetCookieList Get list of all cookies cURL known (expired ones, too). Both 2.5
CURL.GetDebugAsText Returns the debug output of the transaction as text. Both 2.5
CURL.GetDebugLength Queries the current length in bytes of the debug messages buffer. Both 2.5
CURL.GetDebugWithData Whether to include data in the debug log. Both 6.2
CURL.GetDebugWithProgress Queries whether to include progress in debug messages. Both 6.3
CURL.GetDebugWithTime Queries whether times are included in debug messages. Both 6.2
CURL.GetEffectiveURL Get the last used effective URL. Both 2.5
CURL.GetFTPEntryPath Get a string holding the path of the entry path. Both 2.5
CURL.GetFileTime Get the remote time of the retrieved document. Both 2.5
CURL.GetFinishedEvaluate Queries expression to be run when transfer is finished. Both 6.1
CURL.GetFinishedFileName Queries the file name for the finished script to call. Both 5.2
CURL.GetFinishedScriptName Queries the script name to call when transfer finished. Both 5.2
CURL.GetHTTPAuthAvail Get a bitmask indicating the authentication method(s) available. Both 2.5
CURL.GetHTTPConnectCode Get the last received proxy response code to a CONNECT request. Both 2.5
CURL.GetHeaderAsText Returns the headers of the transaction as text. Both 2.5
CURL.GetHeaderLength Queries the current length in bytes of the header buffer. Both 2.5
CURL.GetHeaderSize Get the total size of all the headers received. Measured in number of bytes. Both 2.5
CURL.GetInputAsText Returns the input of the transaction as text. Both 2.8
CURL.GetInputLength Queries the current length in bytes of the input buffer. Both 2.5
CURL.GetLocalIP Get a string holding the local (source) IP address of the most recent connection done with this curl handle. Both 2.5
CURL.GetLocalPort Get the local (source) port of the most recent connection done with this curl handle. Both 2.5
CURL.GetNameLookupTime Get the time, in seconds, it took from the start until the name resolving was completed. Both 2.5
CURL.GetNumConnects Query how many new connections libcurl had to create to achieve the previous transfer (only the successful connects are counted). Both 2.5
CURL.GetOSErrNo Get the errno variable from a connect failure. Both 2.5
CURL.GetPreTransferTime Get the time, in seconds, it took from the start until the file transfer is just about to begin. Both 2.5
CURL.GetPrimaryIP Get the string holding the IP address of the most recent connection done with this curl handle. Both 2.5
CURL.GetPrimaryPort Get the destination port of the most recent connection done with this curl handle. Both 2.5
CURL.GetProgressCurrentDownload Queries current number of bytes downloaded. Both 2.5
CURL.GetProgressCurrentUpload Queries current number of bytes uploaded. Both 2.5
CURL.GetProgressEvaluate Queries expression to be run when transfer makes progress. Both 6.1
CURL.GetProgressFileName Queries progress script file name. Both 5.2
CURL.GetProgressPercent Queries progress in percent. Both 5.2
CURL.GetProgressScriptName Queries script name to be called for progress. Both 5.2
CURL.GetProgressTotalDownload Queries total number of bytes to download. Both 2.5
CURL.GetProgressTotalUpload Queries total number of bytes to upload. Both 2.5
CURL.GetProxyAuthAvail Get a bitmask indicating the authentication method(s) available for your proxy authentication. Both 2.5
CURL.GetRTSPCSEQRecv Query RTSP sequence counter received. Both 5.2
CURL.GetRTSPClientCSEQ Query RTSP Client sequence counter. Both 5.2
CURL.GetRTSPServerCSEQ Query RTSP Server sequence counter. Both 5.2
CURL.GetRTSPSessionID Query RTSP session ID. Both 5.2
CURL.GetRedirectCount Get the total number of redirections that were actually followed. Both 2.5
CURL.GetRedirectTime Get the total time, in seconds, it took for all redirection steps include name lookup, connect, pretransfer and transfer before final transaction was started. Both 2.5
CURL.GetRedirectURL Get the URL a redirect would take you to if you would enable CURL.SetOptionFollowLocation. Both 2.5
CURL.GetRequestSize Get the total size of the issued requests. Both 2.5
CURL.GetResponseCode Get the last received HTTP or FTP code. Both 2.5
CURL.GetResultAsContainer Returns the result of the transaction as container value with auto detection of type. Both 5.2
CURL.GetResultAsData Returns the result of the transaction as data file. Both 2.5
CURL.GetResultAsEmail Queries the result of the CURL transfer and parses as email. Both 5.3
CURL.GetResultAsGIF Returns the result of the transaction as GIF image. Both 3.1
CURL.GetResultAsJPEG Returns the result of the transaction as JPEG image. Both 2.5
CURL.GetResultAsPDF Returns the result of the transaction as PDF. Both 4.0
CURL.GetResultAsPNG Returns the result of the transaction as PNG image. Both 2.5
CURL.GetResultAsText Returns the result of the transaction as text. Both 2.5
CURL.GetResultLength Queries the current length in bytes of the result buffer. Both 2.5
CURL.GetSSLEngines Get a linked-list of OpenSSL crypto-engines supported. Both 2.5
CURL.GetSSLVerifyResult Get the result of the certification verification that was requested. Both 2.5
CURL.GetSizeDownload Get the total amount of bytes that were downloaded. Both 2.5
CURL.GetSizeUpload Get the total amount of bytes that were uploaded. Both 2.5
CURL.GetSpeedDownload Get the average download speed that curl measured for the complete download. Both 2.5
CURL.GetSpeedUpload Get the average upload speed that curl measured for the complete upload. Both 2.5
CURL.GetStartTransferTime Get the time, in seconds, it took from the start until the first byte is received by libcurl. Both 2.5
CURL.GetTag Queries the tag value. Both 5.2
CURL.GetTotalTime Get the total time in seconds for the previous transfer, including name resolving, TCP connect etc. Both 2.5
CURL.Host Queries host value from compiling. Both 2.5
CURL.IsRunning Checks whether a transfer is still running. Both 2.5
CURL.LibSSHVersion Queries the SSH library version used. Both 6.2
CURL.List Lists all IDs of CURL transfers currently. Both 5.4
CURL.New Start a new CURL easy session. Both 2.5
CURL.NumberOfRunningTransfers Queries number of running transfers. Both 5.2
CURL.OpenInputFile Opens file for reading data needed for upload, email sending or HTTP Post. Both 2.6
CURL.OpenSSLVersion Queries OpenSSL Version. Both 6.2
CURL.Perform Perform a file transfer. Both 2.5
CURL.PerformAsync Perform a curl transfer asynchronously. Both 5.2
CURL.PerformInBackground Perform a file transfer in background. Both 2.5
CURL.Protocols Queries list of supported protocols. Both 2.5
CURL.Reset Resets the CURL session. Both 5.2
CURL.RunningTransfers Queries list of running transfers. Both 5.2
CURL.SSLVersion Returns SSL Library version. Both 2.5
CURL.SetDebugWithData Whether to include data in the debug log. Both 6.2
CURL.SetDebugWithProgress Sets whether to include progress in debug messages. Both 6.3
CURL.SetDebugWithTime Sets wether times are included in debug log. Both 6.2
CURL.SetFinishedEvaluate Sets expression to be run when transfer is finished. Both 6.1
CURL.SetFinishedScript Sets which script to call when a transfer finished. Both 5.2
CURL.SetInputFile Sets input to file data from the container value. Both 2.5
CURL.SetInputGIF Sets input to GIF data from the container value. Both 3.1
CURL.SetInputJPEG Sets input to JPEG data from the container value. Both 2.5
CURL.SetInputPDF Sets input to PDF data from the container value. Both 4.0
CURL.SetInputPNG Sets input to PNG data from the container value. Both 2.5
CURL.SetInputText Sets input data for this transfer to be the text you provide. Both 2.5
CURL.SetOptionAddressScope Sets the IPv6 scope_id. Both 2.5
CURL.SetOptionAppend Whether to append file instead of overwriting it. Both 2.5
CURL.SetOptionAutoReferer Set whether to set automatically the referrer. Both 2.5
CURL.SetOptionBufferSize Sets the buffer size. Both 2.5
CURL.SetOptionCAINFO Sets a path to find certificate file. Both 2.5
CURL.SetOptionCAPATH Sets the certificate directory. Both 2.5
CURL.SetOptionCRLF Whether to convert newline characters. Both 2.5
CURL.SetOptionCRLFile Sets the CRL file path. Both 2.5
CURL.SetOptionCertInfo Whether to collect certificate information. Both 2.5
CURL.SetOptionConnectTimeoutMS Sets the connection timeout in milliseconds. Both 2.5
CURL.SetOptionConnectionTimeout Sets the connection timeout in seconds. Both 2.5
CURL.SetOptionCookie Sets the cookie for the current http transfer. Both 2.5
CURL.SetOptionCookieFile Sets the cookie file location. Both 2.5
CURL.SetOptionCookieJar Sets the cookie storage file. Both 2.5
CURL.SetOptionCookieList Sets the cookie string. Both 2.5
CURL.SetOptionCookieSession Set to 1 to mark this as a new cookie "session". Both 2.5
CURL.SetOptionCustomRequest Sets a custom request. Both 2.5
CURL.SetOptionDNSCacheTimeout Sets the DNS Cache Timeout in seconds. Both 2.5
CURL.SetOptionDNSInterface Set the name of the network interface that the DNS resolver should bind to. Both 5.2
CURL.SetOptionDNSLocalIPv4 Set the local IPv4 address that the resolver should bind to. Both 5.2
CURL.SetOptionDNSLocalIPv6 Set the local IPv6 address that the resolver should bind to. Both 5.2
CURL.SetOptionDirListOnly Whether to only query names in file listing. Both 2.5
CURL.SetOptionEGDSocket Sets a path name to the Entropy Gathering Daemon socket. Both 2.5
CURL.SetOptionFTPAccount Sets the FTP account name. Both 2.5
CURL.SetOptionFTPAlternativeToUser Whether to use alternative USER command. Both 2.5
CURL.SetOptionFTPCreateMissingDirs Whether to create missing directories. Both 2.5
CURL.SetOptionFTPFileMethod Which command to use for reaching a file. Both 2.5
CURL.SetOptionFTPPort Sets the ports to use for FTP. Both 2.5
CURL.SetOptionFTPResponseTimeout Sets the timeout for FTP responses. Both 2.5
CURL.SetOptionFTPSSLAuth Sets which SSL Authentication to use. Both 2.5
CURL.SetOptionFTPSSLCCC If enabled, this option makes libcurl use CCC (Clear Command Channel). Both 2.5
CURL.SetOptionFTPSkipPasvIP Whether to skip IP address for PASV. Both 2.5
CURL.SetOptionFTPUseEPRT Whether to use EPRT command. Both 2.5
CURL.SetOptionFTPUseEPSV Whether to use EPSV command. Both 2.5
CURL.SetOptionFTPUsePret Whether to use PRET command. Both 2.5
CURL.SetOptionFailOnError Whether to fail on http errors. Both 2.5
CURL.SetOptionFileOnlyMode Disables collecting data for Result functions. Both 2.6
CURL.SetOptionFileTime Whether to query file time. Both 2.5
CURL.SetOptionFollowLocation Enables or disables following locations. Both 2.5
CURL.SetOptionForbitReuse Whether to disallow reusing connections. Both 2.5
CURL.SetOptionFreshConnect Sets whether to not reuse old connections. Both 2.5
CURL.SetOptionGet Sets the transfer to be a HTTP Get. Both 2.5
CURL.SetOptionHTTP200Aliases Sets list of aliases to be treated as valid HTTP 200 responses. Both 2.5
CURL.SetOptionHTTPAuth Defines which HTTP authentication methods are used. Both 2.5
CURL.SetOptionHTTPContentDecoding Sets how to act on content decoding. Both 2.5
CURL.SetOptionHTTPHeader Sets the http header list. Both 2.5
CURL.SetOptionHTTPProxyTunnel Set to 1 to make the library tunnel all operations through a given HTTP proxy. Both 2.5
CURL.SetOptionHTTPTransferDecoding Sets how to act on transfer decoding. Both 2.5
CURL.SetOptionHTTPVersion Sets which HTTP version is used. Both 2.5
CURL.SetOptionHeader Whether to include headers in output. Both 2.5
CURL.SetOptionIPResolve Allows an application to select what kind of IP addresses to use when resolving host names. Both 2.5
CURL.SetOptionIgnoreContentLength Whether to ignore the Content-Length header. Both 2.5
CURL.SetOptionInFileSize Sets the file input size. Both 2.5
CURL.SetOptionInterface This sets the interface name to use as outgoing network interface. Both 2.5
CURL.SetOptionIssuerCert Sets the file path for the CA certificate in PEM format. Both 2.5
CURL.SetOptionKRBLevel Sets the kerberos security level for FTP. Both 2.5
CURL.SetOptionKeyPassword Sets the password for the SSL or SSH private key. Both 2.5
CURL.SetOptionLocalPort This sets the local port number of the socket used for connection. Both 2.5
CURL.SetOptionLocalPortRange This is the number of attempts curl should make to find a working local port number. Both 2.5
CURL.SetOptionLoginOptions Sets login options string to use for the transfer. Both 5.4
CURL.SetOptionLowSpeedLimit Sets the minimum required speed. Both 2.5
CURL.SetOptionLowSpeedTime Sets how long a transfer is allowed to run with low speed. Both 2.5
CURL.SetOptionMailAuth Sets the mail auth option. Both 2.9
CURL.SetOptionMailFrom Sets the mail sender. Both 2.5
CURL.SetOptionMailRecipients Sets the recipients list. Both 2.5
CURL.SetOptionMaxConnects Sets the persistent connection cache size. Both 2.5
CURL.SetOptionMaxFileSize Sets the maximum file size for download. Both 2.5
CURL.SetOptionMaxRecvSpeedLarge Sets the maximum download speed. Both 2.5
CURL.SetOptionMaxRedirs Sets the redirection limit. Both 2.5
CURL.SetOptionMaxSendSpeedLarge Sets the maximum sending speed. Both 2.5
CURL.SetOptionNETRCFile Sets the full path to the netrc file. Both 2.5
CURL.SetOptionNetRC Sets netrc file preference. Both 2.5
CURL.SetOptionNewDirectoryPerms Sets the new directory permissions. Both 2.5
CURL.SetOptionNewFilePerms Sets the new file permissions. Both 2.5
CURL.SetOptionNoBody Whether to ignore the body of the download. Both 2.5
CURL.SetOptionNoProxy Sets which hosts don't use a proxy. Both 2.5
CURL.SetOptionPassword Sets the password for this transfer. Both 2.5
CURL.SetOptionPort Sets the port number for the connection. Both 2.5
CURL.SetOptionPost Sets transfer to be a HTTP Post. Both 2.5
CURL.SetOptionPostFieldSize Sets the length of post field data. Both 2.5
CURL.SetOptionPostFields Sets the post fields. Both 2.5
CURL.SetOptionPostQuote Sets the list of FTP or SFTP commands to pass to the server after your FTP transfer request. Both 2.5
CURL.SetOptionPostRedir Sets the redirect policy. Both 2.5
CURL.SetOptionPreQuote Sets the list of FTP commands to pass to the server after the transfer type is set. Both 2.5
CURL.SetOptionProtocols Limit which protocols are used. Both 2.5
CURL.SetOptionProxy Set HTTP proxy to use. Both 2.5
CURL.SetOptionProxyAuth Sets which authentication methods are used. Both 2.5
CURL.SetOptionProxyPassword The password to use for the transfer while connecting to Proxy. Both 2.5
CURL.SetOptionProxyPort The proxy port to connect to unless it is specified in the proxy string with CURL.SetOptionProxy. Both 2.5
CURL.SetOptionProxyTransferMode Wether to pass transfer mode to proxy. Both 2.5
CURL.SetOptionProxyType Sets the type of the proxy. Both 2.5
CURL.SetOptionProxyUsername The user name to use for the transfer while connecting to Proxy. Both 2.5
CURL.SetOptionPut Sets transfer to be a HTTP Put. Both 2.5
CURL.SetOptionQuote Sets the list of FTP or SFTP commands to pass to the server prior to your FTP request. Both 2.5
CURL.SetOptionRandomFile Sets random file. Both 2.5
CURL.SetOptionRange Sets the range. Both 2.5
CURL.SetOptionRedirProtocols Limit which protocols are used for redirection. Both 2.5
CURL.SetOptionReferer Sets the referrer. Both 2.5
CURL.SetOptionResumeFrom Sets the resume from offset. Both 2.5
CURL.SetOptionSSHAuthTypes Sets the SSL authentication types. Both 2.5
CURL.SetOptionSSHHostPublicKeyMD5 Sets MD5 hash for public key. Both 2.5
CURL.SetOptionSSHKnownHosts Sets the file path of the known_host file to use. Both 2.5
CURL.SetOptionSSHPrivateKeyfile Sets the file path for your private key. Both 2.5
CURL.SetOptionSSHPublicKeyfile Sets the file path for the public key file. Both 2.5
CURL.SetOptionSSLCert Sets the file path for the certificate. Both 2.5
CURL.SetOptionSSLCertType Sets the format of the certificate. Both 2.5
CURL.SetOptionSSLCipherList Sets the list of ciphers to use for the SSL connection. Both 2.5
CURL.SetOptionSSLEngine Sets which crypto engine is used. Both 2.5
CURL.SetOptionSSLEngineDefault Sets the actual crypto engine as the default for (asymmetric) crypto operations. Both 2.5
CURL.SetOptionSSLKey Sets the file path for the private key. Both 2.5
CURL.SetOptionSSLKeyType Sets the format of the private key. Both 2.5
CURL.SetOptionSSLSessionIDCache Controls SSL session-ID caching. Both 2.5
CURL.SetOptionSSLVerifyHost Sets whether to verify host. Both 2.5
CURL.SetOptionSSLVerifyPeer Whether to verify the peer. Both 2.5
CURL.SetOptionSSLVersion Sets which version of SSL/TLS to attempt to use. Both 2.5
CURL.SetOptionSocks5GSSAPINec Sets how to run the protection mode negotiation. Both 2.5
CURL.SetOptionSocks5GSSAPIService Sets the name of the service. Both 2.5
CURL.SetOptionTCPKeepAlive Enable TCP keep-alive probing. Both 5.2
CURL.SetOptionTCPKeepIdle Set TCP keep-alive idle time wait. Both 5.2
CURL.SetOptionTCPKeepInterval Set TCP keep-alive interval. Both 5.2
CURL.SetOptionTCPNoDelay Sets the TCP delay option. Both 2.5
CURL.SetOptionTFTPBlockSize Specify block size to use for TFTP data transmission. Both 2.5
CURL.SetOptionTLSAuthPassword Sets the TSL authentication password. Both 3.5
CURL.SetOptionTLSAuthType Sets the TLS authentication type. Both 3.5
CURL.SetOptionTLSAuthUsername Sets the TSL authentication user name. Both 3.5
CURL.SetOptionTelnetOptions Sets a list of telnet options. Both 2.5
CURL.SetOptionTimeCondition Sets the time Both 2.5
CURL.SetOptionTimeOut Sets the maximum time in seconds that you allow the transfer operation to take. Both 2.5
CURL.SetOptionTimeValue Sets the time value. Both 2.5
CURL.SetOptionTimeoutMS Sets the transfer timeout in milliseconds. Both 2.5
CURL.SetOptionTransferEncoding Ask for HTTP Transfer Encoding. Both 5.2
CURL.SetOptionTransferText Whether to use ASCII mode for FTP transfer. Both 2.5
CURL.SetOptionURL Sets the actual URL to deal with. Both 2.5
CURL.SetOptionUnrestrictedAuth Controls wether authentication is reused. Both 2.5
CURL.SetOptionUpload Sets this transfer to be an upload. Both 2.5
CURL.SetOptionUseSSL Sets whether to use SSL for next transfers. Both 2.5
CURL.SetOptionUserAgent The user agent text string. Both 2.5
CURL.SetOptionUsername Sets the user name string for the transfer. Both 2.5
CURL.SetOptionVerbose Whether to store log messages. Both 2.5
CURL.SetOptionWildCardMatch Enable wildcard matching. Both 5.2
CURL.SetProgressEvaluate Sets expression to be run when transfer makes progress. Both 6.1
CURL.SetProgressScript Sets the progress script. Both 5.2
CURL.SetTag Sets the tag value. Both 5.2
CURL.SetUpdateProgressDialog Sets whether progress dialog should be automatically updated. Both 2.5
CURL.Version Queries curl version string. Both 2.5

268 functions.

Feedback: Report problem or ask question.




Links
MBS Realbasic tutorial videos - Förderverein St. Arnulf Nickenich