Section 3: library functions
CURLOPT_MAXFILESIZE – maximum file size allowed to download Synopsis#include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_MAXFILESIZE, long size); DescriptionPass a long as parameter. This allows you to specify the maximum size (in bytes) of a file to download. If the file requested is found larger than this value, the transfer will not start and CURLE_FILESIZE_EXCEEDED will be…
CURLOPT_MAXCONNECTS – maximum connection cache size Synopsis#include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_MAXCONNECTS, long amount); DescriptionPass a long. The set amount will be the maximum number of simultaneously open persistent connections that libcurl may cache in the pool associated with this handle. The default is 5, and there isn’t much point in changing this value unless…
CURLOPT_MAIL_RCPT – list of SMTP mail recipients Synopsis#include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_MAIL_RCPT, struct curl_slist *rcpts);DescriptionPass a pointer to a linked list of recipients to pass to the server in your SMTP mail request. The linked list should be a fully valid list of struct curl_slist structs properly filled in. Use curl_slist_append(3) to create the…
CURLOPT_MAIL_FROM – SMTP sender address Synopsis#include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_MAIL_FROM, char *from); DescriptionPass a pointer to a zero terminated string as parameter. This should be used to specify the sender’s email address when sending SMTP mail with libcurl. An originator email address should be specified with angled brackets (<>) around it, which if not…
CURLOPT_MAIL_AUTH – SMTP authentication address Synopsis#include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_MAIL_AUTH, char *auth); DescriptionPass a pointer to a zero terminated string as parameter. This will be used to specify the authentication address (identity) of a submitted message that is being relayed to another server. This optional parameter allows co-operating agents in a trusted environment to…
CURLOPT_LOW_SPEED_TIME – set low speed limit time period Synopsis#include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_LOW_SPEED_TIME, long speedtime); DescriptionPass a long as parameter. It contains the time in number seconds that the transfer speed should be below the CURLOPT_LOW_SPEED_LIMIT(3) for the library to consider it too slow and abort. Default0, disabled ProtocolsAll ExampleTODO AvailabilityAlways Return ValueReturns CURLE_OK…
CURLOPT_LOW_SPEED_LIMIT – set low speed limit in bytes per second Synopsis#include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_LOW_SPEED_LIMIT, long speedlimit); DescriptionPass a long as parameter. It contains the average transfer speed in bytes per second that the transfer should be below during CURLOPT_LOW_SPEED_TIME(3) seconds for libcurl to consider it to be too slow and abort. Default0, disabled…
CURLOPT_LOGIN_OPTIONS – set login options Synopsis#include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_LOGIN_OPTIONS, char *options); DescriptionPass a char * as parameter, which should be pointing to the zero terminated options string to use for the transfer. For more information about the login options please see RFC2384, RFC5092 and IETF draft draft-earhart-url-smtp-00.txt CURLOPT_LOGIN_OPTIONS(3) can be used to set…
CURLOPT_LOCALPORTRANGE – number of additional local ports to try Synopsis#include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_LOCALPORTRANGE, long range); DescriptionPass a long. The range argument is the number of attempts libcurl will make to find a working local port number. It starts with the given CURLOPT_LOCALPORT(3) and adds one to the number for each retry. Setting this…
CURLOPT_LOCALPORT – set local port number to use for socket Synopsis#include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_LOCALPORT, long port); DescriptionPass a long. This sets the local port number of the socket used for the connection. This can be used in combination with CURLOPT_INTERFACE(3) and you are recommended to use CURLOPT_LOCALPORTRANGE(3) as well when this option is…
CURLOPT_KRBLEVEL – set FTP kerberos security level Synopsis#include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_KRBLEVEL, char *level); DescriptionPass a char * as parameter. Set the kerberos security level for FTP; this also enables kerberos awareness. This is a string that should match one of the following: ‘clear’, ‘safe’, ‘confidential’ or ‘private’. If the string is set but…
CURLOPT_KEYPASSWD – set passphrase to private key Synopsis#include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_KEYPASSWD, char *pwd); DescriptionPass a pointer to a zero terminated string as parameter. It will be used as the password required to use the CURLOPT_SSLKEY(3) or CURLOPT_SSH_PRIVATE_KEYFILE(3) private key. You never needed a pass phrase to load a certificate but you need one…
CURLOPT_ISSUERCERT – issuer SSL certificate filename Synopsis#include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_ISSUERCERT, char *file); DescriptionPass a char * to a zero terminated string naming a file holding a CA certificate in PEM format. If the option is set, an additional check against the peer certificate is performed to verify the issuer is indeed the one…
CURLOPT_IPRESOLVE – specify which IP protocol version to use Synopsis#include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_IPRESOLVE, long resolve); DescriptionAllows an application to select what kind of IP addresses to use when resolving host names. This is only interesting when using host names that resolve addresses using more than one version of IP. The allowed values are:…
CURLOPT_IOCTLFUNCTION – callback for I/O operations Synopsis#include <curl/curl.h> typedef enum { CURLIOE_OK, /* I/O operation successful */ CURLIOE_UNKNOWNCMD, /* command was unknown to callback */ CURLIOE_FAILRESTART, /* failed to restart the read */ CURLIOE_LAST /* never use */ } curlioerr; typedef enum { CURLIOCMD_NOP, /* no operation */ CURLIOCMD_RESTARTREAD, /* restart the read stream from…
CURLOPT_IOCTLDATA – custom pointer passed to I/O callback Synopsis#include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_IOCTLDATA, void *pointer); DescriptionPass the pointer that will be untouched by libcurl and passed as the 3rd argument in the ioctl callback set with CURLOPT_IOCTLFUNCTION(3). DefaultBy default, the value of this parameter is NULL. ProtocolsUsed with HTTP ExampleTODO AvailabilityAdded in 7.12.3 Return…
CURLOPT_INTERLEAVEFUNCTION – callback function for RTSP interleaved data Synopsis#include <curl/curl.h> size_t interleave_callback(void *ptr, size_t size, size_t nmemb, void *userdata); CURLcode curl_easy_setopt(CURL *handle, CURLOPT_INTERLEAVEFUNCTION, interleave_callback);DescriptionPass a pointer to your callback function, which should match the prototype shown above. This callback function gets called by libcurl as soon as it has received interleaved RTP data. This function…
CURLOPT_INTERLEAVEDATA – custom pointer to RTSP interleave callback Synopsis#include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_INTERLEAVEDATA, void *pointer); DescriptionThis is the userdata pointer that will be passed to CURLOPT_INTERLEAVEFUNCTION(3) when interleaved RTP data is received. DefaultNULL ProtocolsRTSP ExampleTODO AvailabilityAdded in 7.20.0 Return ValueReturns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. See AlsoCURLOPT_INTERLEAVEFUNCTION(3), CURLOPT_RTSP_REQUEST(3),
CURLOPT_INTERFACE – source interface for outgoing traffic Synopsis#include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_INTERFACE, char *interface); DescriptionPass a char * as parameter. This sets the interface name to use as outgoing network interface. The name can be an interface name, an IP address, or a host name. If the parameter starts with "if!" then it is…
CURLOPT_INFILESIZE_LARGE – set size of the input file to send off Synopsis#include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_INFILESIZE_LARGE, curl_off_t filesize);DescriptionWhen uploading a file to a remote site, filesize should be used to tell libcurl what the expected size of the input file is. This value must be passed as a curl_off_t. For uploading using SCP, this…