Section 3: library functions
CURLOPT_READFUNCTION – read callback for data uploads Synopsis#include <curl/curl.h> size_t read_callback(char *buffer, size_t size, size_t nitems, void *instream); CURLcode curl_easy_setopt(CURL *handle, CURLOPT_READFUNCTION, read_callback); DescriptionPass a pointer to your callback function, as the prototype shows above. This callback function gets called by libcurl as soon as it needs to read data in order to send it…
CURLOPT_READDATA – custom pointer passed to the read callback Synopsis#include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_READDATA, void *pointer); DescriptionData pointer to pass to the file read function. If you use the CURLOPT_READFUNCTION(3) option, this is the pointer you’ll get as input in the 4th argument to the callback. If you don’t specify a read callback but…
CURLOPT_RANGE – set byte range to request Synopsis#include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_RANGE, char *range); DescriptionPass a char * as parameter, which should contain the specified range you want to retrieve. It should be in the format "X-Y", where either X or Y may be left out and X and Y are byte indexes. HTTP…
CURLOPT_RANDOM_FILE – specify a source for random data Synopsis#include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_RANDOM_FILE, char *path); DescriptionPass a char * to a zero terminated file name. The file will be used to read from to seed the random engine for SSL and more. DefaultNULL, not used ProtocolsAll ExampleTODO AvailabilityAlways Return ValueReturns CURLE_OK on success or…
CURLOPT_QUOTE – (S)FTP commands to run before transfer Synopsis#include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_QUOTE, struct curl_slist *cmds); DescriptionPass a pointer to a linked list of FTP or SFTP commands to pass to the server prior to your request. This will be done before any other commands are issued (even before the CWD command for FTP)….
CURLOPT_PUT – make a HTTP PUT request Synopsis#include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PUT, long put); DescriptionA parameter set to 1 tells the library to use HTTP PUT to transfer data. The data should be set with CURLOPT_READDATA(3) and CURLOPT_INFILESIZE(3). This option is deprecated since version 7.12.1. Use CURLOPT_UPLOAD(3)! Default0, disabled ProtocolsHTTP ExampleTODO AvailabilityDeprecated since 7.12.1….
CURLOPT_PROXY_TRANSFER_MODE – append FTP transfer mode to URL for proxy Synopsis#include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXY_TRANSFER_MODE, long enabled); DescriptionPass a long. If the value is set to 1 (one), it tells libcurl to set the transfer mode (binary or ASCII) for FTP transfers done via a HTTP proxy, by appending ;type=a or ;type=i to the…
CURLOPT_PROXYUSERPWD – user name and password to use for proxy authentication Synopsis#include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXYUSERPWD, char *userpwd); DescriptionPass a char * as parameter, which should be [user name]:[password] to use for the connection to the HTTP proxy. Both the name and the password will be URL decoded before use, so to include for…
CURLOPT_PROXYUSERNAME – user name to use for proxy authentication Synopsis#include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXYUSERNAME, char *username);DescriptionPass a char * as parameter, which should be pointing to the zero terminated user name to use for the transfer. CURLOPT_PROXYUSERNAME(3) sets the user name to be used in protocol authentication with the proxy. To specify the proxy…
CURLOPT_PROXYTYPE – proxy protocol type Synopsis#include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXYTYPE, long type); DescriptionPass a long with this option to set type of the proxy. Available options for this are CURLPROXY_HTTP, CURLPROXY_HTTP_1_0 CURLPROXY_SOCKS4, CURLPROXY_SOCKS5, CURLPROXY_SOCKS4A and CURLPROXY_SOCKS5_HOSTNAME. The HTTP type is default. If you set CURLOPT_PROXYTYPE(3) to CURLPROXY_HTTP_1_0, it will only affect how libcurl speaks…
CURLOPT_PROXYPORT – port number the proxy listens on Synopsis#include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXYPORT, long port); DescriptionPass a long with this option to set the proxy port to connect to unless it is specified in the proxy string CURLOPT_PROXY(3) or uses the default one. While this accepts a ‘long’, the port number is 16 bit…
CURLOPT_PROXYPASSWORD – password to use with proxy authentication Synopsis#include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXYPASSWORD, char *pwd); DescriptionPass a char * as parameter, which should be pointing to the zero terminated password to use for authentication with the proxy. The CURLOPT_PROXYPASSWORD(3) option should be used in conjunction with the CURLOPT_PROXYUSERNAME(3) option. Defaultblank ProtocolsMost ExampleTODO AvailabilityAdded in…
CURLOPT_PROXYHEADER – custom HTTP headers to pass to proxy Synopsis#include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXYHEADER, struct curl_slist *headers);DescriptionPass a pointer to a linked list of HTTP headers to pass in your HTTP request sent to a proxy. The rules for this list is identical to the CURLOPT_HTTPHEADER(3) option’s. The headers set with this option is…
CURLOPT_PROXYAUTH – set HTTP proxy authentication methods to try Synopsis#include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXYAUTH, long bitmask); DescriptionPass a long as parameter, which is set to a bitmask, to tell libcurl which HTTP authentication method(s) you want it to use for your proxy authentication. If more than one bit is set, libcurl will first query…
CURLOPT_PROXY – set proxy to use Synopsis#include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXY, char *proxy); DescriptionSet the proxy to use for the upcoming request. The parameter should be a char * to a zero terminated string holding the host name or dotted IP address. To specify port number in this string, append :[port] to the end…
CURLOPT_PROTOCOLS – set allowed protocols Synopsis#include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROTOCOLS, long bitmask); DescriptionPass a long that holds a bitmask of CURLPROTO_* defines. If used, this bitmask limits what protocols libcurl may use in the transfer. This allows you to have a libcurl built to support a wide range of protocols but still limit specific…
CURLOPT_PROGRESSFUNCTION – callback to progress meter function Synopsis#include <curl/curl.h> int progress_callback(void *clientp, double dltotal, double dlnow, double ultotal, double ulnow); CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROGRESSFUNCTION, progress_callback); DescriptionPass a pointer to your callback function, which should match the prototype shown above. We encourage users to use the newer CURLOPT_XFERINFOFUNCTION(3) instead, if you can. This function gets called…
CURLOPT_PROGRESSDATA – custom pointer passed to the progress callback Synopsis#include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROGRESSDATA, void *pointer); DescriptionPass a pointer that will be untouched by libcurl and passed as the first argument in the progress callback set with CURLOPT_PROGRESSFUNCTION(3). DefaultThe default value of this parameter is NULL. ProtocolsAll Examplehttp://curl.haxx.se/libcurl/c/progressfunc.html AvailabilityAlways Return ValueReturns CURLE_OK See AlsoCURLOPT_PROGRESSFUNCTION(3),…
CURLOPT_PRIVATE – store a private pointer Synopsis#include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PRIVATE, void *pointer); DescriptionPass a void * as parameter, pointing to data that should be associated with this curl handle. The pointer can subsequently be retrieved using curl_easy_getinfo(3) with the CURLINFO_PRIVATE option. libcurl itself never does nothing with this data. DefaultNULL ProtocolsAll ExampleTODO AvailabilityAdded…
CURLOPT_PREQUOTE – commands to run before FTP or SFTP transfer Synopsis#include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PREQUOTE, char *cmds); DescriptionPass a pointer to a linked list of FTP or SFTP commands to pass to the server after the transfer type is set. The linked list should be a fully valid list of struct curl_slist structs properly…