Section 3: library functions
CURLOPT_NOSIGNAL – skip all signal handling Synopsis #include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_NOSIGNAL, long onoff); Description If onoff is 1, 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 here to allow multi-threaded unix applications to still set/use all…
CURLOPT_NOPROXY – disable proxy use for specific hosts Synopsis #include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_NOPROXY, char *noproxy); Description Pass a pointer to a zero terminated string. The string consists of a comma separated list of host names that do not require a proxy to get reached, even if one is specified. The only wildcard available…
CURLOPT_NOPROGRESS – switch off the progress meter Synopsis #include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_NOPROGRESS, long onoff); Description If onoff is to 1, it tells the library to shut off the progress meter completely for requests done with this handle. It will also prevent the CURLOPT_PROGRESSFUNCTION(3) from getting called. Future versions of libcurl are likely to…
CURLOPT_NOBODY – do the download request without getting the body Synopsis #include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_NOBODY, long opt); Description A long parameter set to 1 tells libcurl to not include the body-part in the output when doing what would otherwise be a download. For HTTP(S), this makes libcurl do a HEAD request. For most…
CURLOPT_NEW_FILE_PERMS – permissions for remotely created files Synopsis #include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_NEW_FILE_PERMS, long mode); Description Pass a long as a parameter, containing the value of the permissions that will be assigned to newly created files on the remote server. The default value is 0644, but any valid value can be used. The only…
CURLOPT_NEW_DIRECTORY_PERMS – permissions for remotely created directories Synopsis #include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_NEW_DIRECTORY_PERMS, long mode); Description Pass a long as a parameter, containing the value of the permissions that will be assigned to newly created directories on the remote server. The default value is 0755, but any valid value can be used. The only…
CURLOPT_NETRC_FILE – file name to read .netrc info from Synopsis #include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_NETRC_FILE, char *file); Description Pass a char * as parameter, pointing to a zero terminated string containing the full path name to the file you want libcurl to use as .netrc file. If this option is omitted, and CURLOPT_NETRC(3) is…
CURLOPT_NETRC – request that .netrc is used Synopsis #include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_NETRC, long level); Description This parameter controls the preference level of libcurl between using user names and passwords from your ~/.netrc file, relative to user names and passwords in the URL supplied with CURLOPT_URL(3). libcurl uses a user name (and supplied or…
CURLOPT_MAX_SEND_SPEED_LARGE – rate limit data upload speed Synopsis #include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_MAX_SEND_SPEED_LARGE, curl_off_t maxspeed); Description Pass a curl_off_t as parameter with the maxspeed. If an upload exceeds this speed (counted in bytes per second) on cumulative average during the transfer, the transfer will pause to keep the average rate less than or equal…
CURLOPT_MAX_RECV_SPEED_LARGE – rate limit data download speed Synopsis #include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_MAX_RECV_SPEED_LARGE, curl_off_t speed); Description Pass a curl_off_t as parameter. If a download exceeds this speed (counted in bytes per second) on cumulative average during the transfer, the transfer will pause to keep the average rate less than or equal to the parameter…
CURLOPT_MAXREDIRS – maximum number of redirects allowed Synopsis #include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_MAXREDIRS, long amount); Description Pass a long. The set number will be the redirection limit amount. If that many redirections have been followed, the next redirect will cause an error (CURLE_TOO_MANY_REDIRECTS). This option only makes sense if the CURLOPT_FOLLOWLOCATION(3) is used at…
CURLOPT_MAXFILESIZE_LARGE – maximum file size allowed to download Synopsis #include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_MAXFILESIZE_LARGE, curl_off_t size); Description Pass a curl_off_t 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…
CURLOPT_MAXFILESIZE – maximum file size allowed to download Synopsis #include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_MAXFILESIZE, long size); Description Pass 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…
CURLOPT_MAXCONNECTS – maximum connection cache size Synopsis #include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_MAXCONNECTS, long amount); Description Pass 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…
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); Description Pass 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)…
CURLOPT_MAIL_FROM – SMTP sender address Synopsis #include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_MAIL_FROM, char *from); Description Pass 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…
CURLOPT_MAIL_AUTH – SMTP authentication address Synopsis #include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_MAIL_AUTH, char *auth); Description Pass 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…
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); Description Pass 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. Default 0, disabled Protocols All Example…
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); Description Pass 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….
CURLOPT_LOGIN_OPTIONS – set login options Synopsis #include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_LOGIN_OPTIONS, char *options); Description Pass 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…