Meet us at at Real World in Orlando, Florida.
All functions
Mac OS X
Windows
Crossplatform
Components
Guides
New in version:
2.0
2.1
2.2
2.3
2.4
2.5
2.6
2.7
2.8
Component: CURL
| Name | Description | Mac/Win |
|---|---|---|
| CURL.AddInputFile | Adds input to file data from the container value. | Both |
| CURL.AddInputJPEG | Adds input to JPEG data from the container value. | Both |
| CURL.AddInputPNG | Adds input to PNG data from the container value. | Both |
| CURL.AddInputText | Adds input data for this transfer to be the text you provide. | Both |
| CURL.Cancel | Cancels a running transfer in background. | Both |
| CURL.Cleanup | End a CURL session. | Both |
| CURL.CloseDebugFile | Closes the debug output file. | Both |
| CURL.CloseHeaderFile | Closes the header output file. | Both |
| CURL.CloseInputFile | Closes the header output file. | Both |
| CURL.CloseOutputFile | Closes the data output file. | Both |
| CURL.CreateDebugOutputFile | Creates output file for writing debug messages. | Both |
| CURL.CreateHeaderOutputFile | Creates output file for writing header text. | Both |
| CURL.CreateOutputFile | Creates output file for downloading data. | Both |
| CURL.ErrorCode | Returns the last CURL error code. | Both |
| CURL.ErrorMessage | Returns the last CURL error message. | Both |
| CURL.FormAddKeyContainer | Add a section to a multipart/formdata HTTP POST. | Both |
| CURL.FormAddKeyContainerContentType | Add a section to a multipart/formdata HTTP POST. | Both |
| CURL.FormAddKeyFile | Add a section to a multipart/formdata HTTP POST. | Both |
| CURL.FormAddKeyFileContentType | Add a section to a multipart/formdata HTTP POST. | Both |
| CURL.FormAddKeyText | Add a section to a multipart/formdata HTTP POST. | Both |
| CURL.FormAddKeyTextContentType | Add a section to a multipart/formdata HTTP POST. | Both |
| CURL.FormAddKeyValue | Add a section to a multipart/formdata HTTP POST. | Both |
| CURL.FormAddKeyValueContentType | Add a section to a multipart/formdata HTTP POST. | Both |
| CURL.FormFinish | Finishes constructing a form. | Both |
| 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 |
| CURL.GetConditionUnmet | Get the number 1 if the condition provided in the previous request didn't match. | Both |
| CURL.GetConnectTime | Get the time, in seconds, it took from the start until the connect to the remote host (or proxy) was completed. | Both |
| CURL.GetContentLengthDownload | Get the content-length of the download. | Both |
| CURL.GetContentLengthUpload | Get the specified size of the upload. | Both |
| CURL.GetContentType | Get the content-type of the downloaded object. | Both |
| CURL.GetCookieList | Get list of all cookies cURL known (expired ones, too). | Both |
| CURL.GetDebugAsText | Returns the debug output of the transaction as text. | Both |
| CURL.GetDebugLength | Queries the current length in bytes of the debug messages buffer. | Both |
| CURL.GetEffectiveURL | Get the last used effective URL. | Both |
| CURL.GetFileTime | Get the remote time of the retrieved document. | Both |
| CURL.GetFTPEntryPath | Get a string holding the path of the entry path. | Both |
| CURL.GetHeaderAsText | Returns the headers of the transaction as text. | Both |
| CURL.GetHeaderLength | Queries the current length in bytes of the header buffer. | Both |
| CURL.GetHeaderSize | Get the total size of all the headers received. Measured in number of bytes. | Both |
| CURL.GetHTTPAuthAvail | Get a bitmask indicating the authentication method(s) available. | Both |
| CURL.GetHTTPConnectCode | Get the last received proxy response code to a CONNECT request. | Both |
| CURL.GetInputLength | Queries the current length in bytes of the input buffer. | Both |
| CURL.GetLocalIP | Get a string holding the local (source) IP address of the most recent connection done with this curl handle. | Both |
| CURL.GetLocalPort | Get the local (source) port of the most recent connection done with this curl handle. | Both |
| CURL.GetNameLookupTime | Get the time, in seconds, it took from the start until the name resolving was completed. | Both |
| CURL.GetNumConnects | Query how many new connections libcurl had to create to achieve the previous transfer (only the successful connects are counted). | Both |
| CURL.GetOSErrNo | Get the errno variable from a connect failure. | Both |
| CURL.GetPreTransferTime | Get the time, in seconds, it took from the start until the file transfer is just about to begin. | Both |
| CURL.GetPrimaryIP | Get the string holding the IP address of the most recent connection done with this curl handle. | Both |
| CURL.GetPrimaryPort | Get the destination port of the most recent connection done with this curl handle. | Both |
| CURL.GetProgressCurrentDownload | Queries current number of bytes downloaded. | Both |
| CURL.GetProgressCurrentUpload | Queries current number of bytes uploaded. | Both |
| CURL.GetProgressTotalDownload | Queries total number of bytes to download. | Both |
| CURL.GetProgressTotalUpload | Queries total number of bytes to upload. | Both |
| CURL.GetProxyAuthAvail | Get a bitmask indicating the authentication method(s) available for your proxy authentication. | Both |
| CURL.GetRedirectCount | Get the total number of redirections that were actually followed. | Both |
| 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 |
| CURL.GetRedirectURL | Get the URL a redirect would take you to if you would enable CURL.SetOptionFollowLocation. | Both |
| CURL.GetRequestSize | Get the total size of the issued requests. | Both |
| CURL.GetResponseCode | Get the last received HTTP or FTP code. | Both |
| CURL.GetResultAsData | Returns the result of the transaction as PNG image. | Both |
| CURL.GetResultAsJPEG | Returns the result of the transaction as JPEG image. | Both |
| CURL.GetResultAsPNG | Returns the result of the transaction as PNG image. | Both |
| CURL.GetResultAsText | Returns the result of the transaction as text. | Both |
| CURL.GetResultLength | Queries the current length in bytes of the result buffer. | Both |
| CURL.GetSizeDownload | Get the total amount of bytes that were downloaded. | Both |
| CURL.GetSizeUpload | Get the total amount of bytes that were uploaded. | Both |
| CURL.GetSpeedDownload | Get the average download speed that curl measured for the complete download. | Both |
| CURL.GetSpeedUpload | Get the average upload speed that curl measured for the complete upload. | Both |
| CURL.GetSSLEngines | Get a linked-list of OpenSSL crypto-engines supported. | Both |
| CURL.GetSSLVerifyResult | Get the result of the certification verification that was requested. | Both |
| CURL.GetStartTransferTime | Get the time, in seconds, it took from the start until the first byte is received by libcurl. | Both |
| CURL.GetTotalTime | Get the total time in seconds for the previous transfer, including name resolving, TCP connect etc. | Both |
| CURL.Host | Queries host value from compiling. | Both |
| CURL.IsRunning | Checks whether a transfer is still running. | Both |
| CURL.New | Start a new CURL easy session. | Both |
| CURL.OpenInputFile | Opens file for reading data needed for upload, email sending or HTTP Post. | Both |
| CURL.Perform | Perform a file transfer. | Both |
| CURL.PerformInBackground | Perform a file transfer in background. | Both |
| CURL.Protocols | Queries list of supported protocols. | Both |
| CURL.SetInputFile | Sets input to file data from the container value. | Both |
| CURL.SetInputJPEG | Sets input to JPEG data from the container value. | Both |
| CURL.SetInputPNG | Sets input to PNG data from the container value. | Both |
| CURL.SetInputText | Sets input data for this transfer to be the text you provide. | Both |
| CURL.SetOptionAddressScope | Sets the IPv6 scope_id. | Both |
| CURL.SetOptionAutoReferer | Set whether to set automatically the referrer. | Both |
| CURL.SetOptionBufferSize | Sets the buffer size. | Both |
| CURL.SetOptionCAINFO | Sets a path to find certificate file. | Both |
| CURL.SetOptionCAPATH | Sets the certificate directory. | Both |
| CURL.SetOptionCertInfo | Whether to collect certificate information. | Both |
| CURL.SetOptionConectionTimeout | Sets the connection timeout in seconds. | Both |
| CURL.SetOptionConnectTimeoutMS | Sets the connection timeout in milliseconds. | Both |
| CURL.SetOptionCookie | Sets the cookie for the current http transfer. | Both |
| CURL.SetOptionCookieFile | Sets the cookie file location. | Both |
| CURL.SetOptionCookieJar | Sets the cookie storage file. | Both |
| CURL.SetOptionCookieList | Sets the cookie string. | Both |
| CURL.SetOptionCookieSession | Set to 1 to mark this as a new cookie "session". | Both |
| CURL.SetOptionCRLF | Whether to convert newline characters. | Both |
| CURL.SetOptionCRLFile | Sets the CRL file path. | Both |
| CURL.SetOptionCustomRequest | Sets a custom request. | Both |
| CURL.SetOptionDNSCacheTimeout | Sets the DNS Cache Timeout in seconds. | Both |
| CURL.SetOptionEGDSocket | Sets a path name to the Entropy Gathering Daemon socket. | Both |
| CURL.SetOptionFailOnError | Whether to fail on http errors. | Both |
| CURL.SetOptionFileOnlyMode | Disables collecting data for Result functions. | Both |
| CURL.SetOptionFileTime | Whether to query file time. | Both |
| CURL.SetOptionFollowLocation | Enables or disables following locations. | Both |
| CURL.SetOptionForbitReuse | Whether to disallow reusing connections. | Both |
| CURL.SetOptionFreshConnect | Sets whether to not reuse old connections. | Both |
| CURL.SetOptionFTPAccount | Sets the FTP account name. | Both |
| CURL.SetOptionFTPAlternativeToUser | Whether to use alternative USER command. | Both |
| CURL.SetOptionFTPAppend | Whether to append file instead of overwriting it. | Both |
| CURL.SetOptionFTPCreateMissingDirs | Whether to create missing directories. | Both |
| CURL.SetOptionFTPFileMethod | Which command to use for reaching a file. | Both |
| CURL.SetOptionFTPListOnly | Whether to only query names in file listing. | Both |
| CURL.SetOptionFTPPort | Sets the ports to use for FTP. | Both |
| CURL.SetOptionFTPResponseTimeout | Sets the timeout for FTP responses. | Both |
| CURL.SetOptionFTPSkipPasvIP | Whether to skip IP address for PASV. | Both |
| CURL.SetOptionFTPSSL | Sets whether to use SSL for FTP transfers. | Both |
| CURL.SetOptionFTPSSLAuth | Sets which SSL Authentication to use. | Both |
| CURL.SetOptionFTPSSLCCC | If enabled, this option makes libcurl use CCC (Clear Command Channel). | Both |
| CURL.SetOptionFTPUseEPRT | Whether to use EPRT command. | Both |
| CURL.SetOptionFTPUseEPSV | Whether to use EPSV command. | Both |
| CURL.SetOptionFTPUsePret | Whether to use PRET command. | Both |
| CURL.SetOptionGet | Sets the transfer to be a HTTP Get. | Both |
| CURL.SetOptionHeader | Whether to include headers in output. | Both |
| CURL.SetOptionHTTP200Aliases | Sets list of aliases to be treated as valid HTTP 200 responses. | Both |
| CURL.SetOptionHTTPAuth | Defines which HTTP authentication methods are used. | Both |
| CURL.SetOptionHTTPContentDecoding | Sets how to act on content decoding. | Both |
| CURL.SetOptionHTTPHeader | Sets the http header list. | Both |
| CURL.SetOptionHTTPProxyTunnel | Set to 1 to make the library tunnel all operations through a given HTTP proxy. | Both |
| CURL.SetOptionHTTPTransferDecoding | Sets how to act on transfer decoding. | Both |
| CURL.SetOptionHTTPVersion | Sets which HTTP version is used. | Both |
| CURL.SetOptionIgnoreContentLength | Whether to ignore the Content-Length header. | Both |
| CURL.SetOptionInFileLarge | Sets the file input size. | Both |
| CURL.SetOptionInFileSize | Sets the file input size. | Both |
| CURL.SetOptionInterface | This sets the interface name to use as outgoing network interface. | Both |
| CURL.SetOptionIPResolve | Allows an application to select what kind of IP addresses to use when resolving host names. | Both |
| CURL.SetOptionIssuerCert | Sets the file path for the CA certificate in PEM format. | Both |
| CURL.SetOptionKRB4Level | Sets the kerberos security level for FTP. | Both |
| CURL.SetOptionLocalPort | This sets the local port number of the socket used for connection. | Both |
| CURL.SetOptionLocalPortRange | This is the number of attempts curl should make to find a working local port number. | Both |
| CURL.SetOptionLowSpeedLimit | Sets the minimum required speed. | Both |
| CURL.SetOptionLowSpeedTime | Sets how long a transfer is allowed to run with low speed. | Both |
| CURL.SetOptionMailFrom | Sets the mail sender. | Both |
| CURL.SetOptionMailRecipients | Sets the recipients list. | Both |
| CURL.SetOptionMaxConnects | Sets the persistent connection cache size. | Both |
| CURL.SetOptionMaxFileSize | Sets the maximum file size for download. | Both |
| CURL.SetOptionMaxFileSizeLarge | Sets the maximum file size for download. | Both |
| CURL.SetOptionMaxRecvSpeedLarge | Sets the maximum download speed. | Both |
| CURL.SetOptionMaxRedirs | Sets the redirection limit. | Both |
| CURL.SetOptionMaxSendSpeedLarge | Sets the maximum sending speed. | Both |
| CURL.SetOptionNetRC | Sets netrc file preference. | Both |
| CURL.SetOptionNETRCFile | Sets the full path to the netrc file. | Both |
| CURL.SetOptionNewDirectoryPerms | Sets the new directory permissions. | Both |
| CURL.SetOptionNewFilePerms | Sets the new file permissions. | Both |
| CURL.SetOptionNoBody | Whether to ignore the body of the download. | Both |
| CURL.SetOptionNoProxy | Sets which hosts don't use a proxy. | Both |
| CURL.SetOptionPassword | Sets the password for this transfer. | Both |
| CURL.SetOptionPort | Sets the port number for the connection. | Both |
| CURL.SetOptionPost | Sets transfer to be a HTTP Post. | Both |
| CURL.SetOptionPostFields | Sets the post fields. | Both |
| CURL.SetOptionPostFieldSize | Sets the length of post field data. | Both |
| CURL.SetOptionPostFieldSizeLarge | Sets the length of post field data. | Both |
| CURL.SetOptionPostQuote | Sets the list of FTP or SFTP commands to pass to the server after your FTP transfer request. | Both |
| CURL.SetOptionPostRedir | Sets the redirect policy. | Both |
| CURL.SetOptionPreQuote | Sets the list of FTP commands to pass to the server after the transfer type is set. | Both |
| CURL.SetOptionProtocols | Limit which protocols are used. | Both |
| CURL.SetOptionProxy | Set HTTP proxy to use. | Both |
| CURL.SetOptionProxyAuth | Sets which authentication methods are used. | Both |
| CURL.SetOptionProxyPassword | The password to use for the transfer while connecting to Proxy. | Both |
| CURL.SetOptionProxyPort | The proxy port to connect to unless it is specified in the proxy string with CURL.SetOptionProxy. | Both |
| CURL.SetOptionProxyTransferMode | Wether to pass transfer mode to proxy. | Both |
| CURL.SetOptionProxyType | Sets the type of the proxy. | Both |
| CURL.SetOptionProxyUsername | The user name to use for the transfer while connecting to Proxy. | Both |
| CURL.SetOptionPut | Sets transfer to be a HTTP Put. | Both |
| CURL.SetOptionQuote | Sets the list of FTP or SFTP commands to pass to the server prior to your FTP request. | Both |
| CURL.SetOptionRandomFile | Sets random file. | Both |
| CURL.SetOptionRange | Sets the range. | Both |
| CURL.SetOptionRedirProtocols | Limit which protocols are used for redirection. | Both |
| CURL.SetOptionReferer | Sets the referrer. | Both |
| CURL.SetOptionResumeFrom | Sets the resume from offset. | Both |
| CURL.SetOptionResumeFromLarge | Sets the resume from offset. | Both |
| CURL.SetOptionSocks5GSSAPINec | Sets how to run the protection mode negotiation. | Both |
| CURL.SetOptionSocks5GSSAPIService | Sets the name of the service. | Both |
| CURL.SetOptionSSHAuthTypes | Sets the SSL authentication types. | Both |
| CURL.SetOptionSSHHostPublicKeyMD5 | Sets MD5 hash for public key. | Both |
| CURL.SetOptionSSHKnownHosts | Sets the file path of the known_host file to use. | Both |
| CURL.SetOptionSSHPrivateKeyfile | Sets the file path for your private key. | Both |
| CURL.SetOptionSSHPublicKeyfile | Sets the file path for the public key file. | Both |
| CURL.SetOptionSSLCert | Sets the file path for the certificate. | Both |
| CURL.SetOptionSSLCertPassword | Sets the certificate passsord. | Both |
| CURL.SetOptionSSLCertType | Sets the format of the certificate. | Both |
| CURL.SetOptionSSLCipherList | Sets the list of ciphers to use for the SSL connection. | Both |
| CURL.SetOptionSSLEngine | Sets which crypto engine is used. | Both |
| CURL.SetOptionSSLEngineDefault | Sets the actual crypto engine as the default for (asymmetric) crypto operations. | Both |
| CURL.SetOptionSSLKey | Sets the file path for the private key. | Both |
| CURL.SetOptionSSLKeyPassword | Sets the password for the private key. | Both |
| CURL.SetOptionSSLKeyType | Sets the format of the private key. | Both |
| CURL.SetOptionSSLSessionIDCache | Controls SSL session-ID caching. | Both |
| CURL.SetOptionSSLVerifyHost | Sets whether to verify host. | Both |
| CURL.SetOptionSSLVerifyPeer | Whether to verify the peer. | Both |
| CURL.SetOptionSSLVersion | Sets which version of SSL/TLS to attempt to use. | Both |
| CURL.SetOptionTCPNoDelay | Sets the TCP delay option. | Both |
| CURL.SetOptionTelnetOptions | Sets a list of telnet options. | Both |
| CURL.SetOptionTFTPBlockSize | Specify block size to use for TFTP data transmission. | Both |
| CURL.SetOptionTimeCondition | Sets the time | Both |
| CURL.SetOptionTimeOut | Sets the maximum time in seconds that you allow the transfer operation to take. | Both |
| CURL.SetOptionTimeoutMS | Sets the transfer timeout in milliseconds. | Both |
| CURL.SetOptionTimeValue | Sets the time value. | Both |
| CURL.SetOptionTransferText | Whether to use ASCII mode for FTP transfer. | Both |
| CURL.SetOptionUnrestrictedAuth | Controls wether authentication is reused. | Both |
| CURL.SetOptionUpload | Sets this transfer to be an upload. | Both |
| CURL.SetOptionURL | The actual URL to deal with. | Both |
| CURL.SetOptionUserAgent | The user agent text string. | Both |
| CURL.SetOptionUsername | Sets the user name string for the transfer. | Both |
| CURL.SetOptionVerbose | Set the parameter to 1 to get curl to display a lot of verbose information about its operations. | Both |
| CURL.SetUpdateProgressDialog | Sets whether progress dialog should be automatically updated. | Both |
| CURL.SSLVersion | Returns SSL Library version. | Both |
| CURL.Version | Queries curl version string. | Both |
Feedback: Report problem or ask question.
