Section 3: library functions
CURLOPT_FRESH_CONNECT – force a new connection to be used Synopsis #include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_FRESH_CONNECT, long fresh); Description Pass a long. Set to 1 to make the next transfer use a new (fresh) connection by force instead of trying to re-use an existing one. This option should be used with caution and only if…
CURLOPT_FORBID_REUSE – make connection get closed at once after use Synopsis #include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_FORBID_REUSE, long close); Description Pass a long. Set close to 1 to make libcurl explicitly close the connection when done with the transfer. Normally, libcurl keeps all connections alive when done with one transfer in case a succeeding one…
CURLOPT_FOLLOWLOCATION – follow HTTP 3xx redirects Synopsis #include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_FOLLOWLOCATION, long enable); Description A parameter set to 1 tells the library to follow any Location: header that the server sends as part of a HTTP header in a 3xx response. This means that libcurl will re-send the same request on the new…
CURLOPT_FNMATCH_FUNCTION – wildcard matching function callback Synopsis #include <curl/curl.h> int fnmatch_callback(void *ptr, const char *pattern, const char *string); CURLcode curl_easy_setopt(CURL *handle, CURLOPT_FNMATCH_FUNCTION, fnmatch_callback); Description Pass a pointer to your callback function, which should match the prototype shown above. This callback s used for wildcard matching. Return CURL_FNMATCHFUNC_MATCH if pattern matches the string, CURL_FNMATCHFUNC_NOMATCH if not…
CURLOPT_FNMATCH_DATA – custom pointer to fnmatch callback Synopsis #include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_FNMATCH_DATA, void *pointer); Description Pass a pointer that will be untouched by libcurl and passed as the ptr argument to the CURL_FNMATCH_FUNCTION(3). Default NULL Protocols FTP Example TODO Availability Added in 7.21.0 Return Value Returns CURLE_OK if the option is supported, and…
CURLOPT_FILETIME – get the modification time of the remote resource Synopsis #include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_FILETIME, long gettime); Description Pass a long. If it is 1, libcurl will attempt to get the modification time of the remote document in this operation. This requires that the remote server sends the time or replies to a…
CURLOPT_FAILONERROR – request failure on HTTP response >= 400 Synopsis #include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_FAILONERROR, long fail); Description A long parameter set to 1 tells the library to fail the request if the HTTP code returned is equal to or larger than 400. The default action would be to return the page normally, ignoring…
CURLOPT_EXPECT_100_TIMEOUT_MS – timeout for Expect: 100-continue response Synopsis #include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_EXPECT_100_TIMEOUT_MS, long milliseconds); Description Pass a long to tell libcurl the number of milliseconds to wait for a server response with the HTTP status 100 (Continue), 417 (Expectation Failed) or similar after sending a HTTP request containing an Expect: 100-continue header. If…
CURLOPT_ERRORBUFFER – set error buffer for error messages Synopsis #include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_ERRORBUFFER, char *buf); Description Pass a char * to a buffer that the libcurl may store human readable error messages in on failures or problems. This may be more helpful than just the return code from curl_easy_perform(3) and related functions. The…
CURLOPT_EGDSOCKET – set EGD socket path Synopsis #include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_EGDSOCKET, char *path); Description Pass a char * to the zero terminated path name to the Entropy Gathering Daemon socket. It will be used to seed the random engine for SSL. Default NULL Protocols All TLS based protocols: HTTPS, FTPS, IMAPS, POP3, SMTPS…
CURLOPT_DNS_USE_GLOBAL_CACHE – enable/disable global DNS cache Synopsis #include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_DNS_USE_GLOBAL_CACHE, long enable); Description Pass a long. If the enable value is 1, it tells curl to use a global DNS cache that will survive between easy handle creations and deletions. This is not thread-safe and this will use a global variable. WARNING:…
CURLOPT_DNS_SERVERS – set preferred DNS servers Synopsis #include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_DNS_SERVERS, char *servers); Description Pass a char * that is the list of DNS servers to be used instead of the system default. The format of the dns servers option is: host[:port][,host[:port]]… For example: 192.168.1.100,192.168.1.101,3.4.5.6 Default NULL – use system default Protocols All…
CURLOPT_DNS_LOCAL_IP6 – IPv6 address to bind DNS resolves to Synopsis #include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_DNS_LOCAL_IP6, char *address); Description Set the local IPv6 address that the resolver should bind to. The argument should be of type char * and contain a single IPv6 address as a string. Set this option to NULL to use the…
CURLOPT_DNS_LOCAL_IP4 – IPv4 address to bind DNS resolves to Synopsis #include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_DNS_LOCAL_IP4, char *address); Description Set the local IPv4 address that the resolver should bind to. The argument should be of type char * and contain a single numerical IPv4 address as a string. Set this option to NULL to use…
CURLOPT_DNS_INTERFACE – set interface to speak DNS over Synopsis #include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_DNS_INTERFACE, char *ifname); Description Pass a char * as parameter. Set the name of the network interface that the DNS resolver should bind to. This must be an interface name (not an address). Set this option to NULL to use the…
CURLOPT_DNS_CACHE_TIMEOUT – set life-time for DNS cache entries Synopsis #include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_DNS_CACHE_TIMEOUT, long age); Description Pass a long, this sets the timeout in seconds. Name resolves will be kept in memory and used for this number of seconds. Set to zero to completely disable caching, or set to -1 to make the…
CURLOPT_DIRLISTONLY – ask for names only in a directory listing Synopsis #include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_DIRLISTONLY, long listonly); Description For FTP and SFTP based URLs a parameter set to 1 tells the library to list the names of files in a directory, rather than performing a full directory listing that would normally include file…
CURLOPT_DEBUGFUNCTION – debug callback Synopsis #include <curl/curl.h> typedef enum { CURLINFO_TEXT = 0, CURLINFO_HEADER_IN, /* 1 */ CURLINFO_HEADER_OUT, /* 2 */ CURLINFO_DATA_IN, /* 3 */ CURLINFO_DATA_OUT, /* 4 */ CURLINFO_SSL_DATA_IN, /* 5 */ CURLINFO_SSL_DATA_OUT, /* 6 */ CURLINFO_END } curl_infotype; int debug_callback(CURL *handle, curl_infotype type, char *data, size_t size, void *userptr); CURLcode curl_easy_setopt(CURL *handle, CURLOPT_DEBUGFUNCTION,…
CURLOPT_DEBUGDATA – custom pointer for debug callback Synopsis #include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_DEBUGDATA, void *pointer); Description Pass a pointer to whatever you want passed in to your CURLOPT_DEBUGFUNCTION(3) in the last void * argument. This pointer is not used by libcurl, it is only passed to the callback. Default NULL Protocols All Example http://curl.haxx.se/libcurl/c/debug.html…
CURLOPT_CUSTOMREQUEST – custom string for request Synopsis #include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_CUSTOMREQUEST, char *request); Description Pass a pointer to a zero terminated string as parameter. When you change the request method by setting CURLOPT_CUSTOMREQUEST(3) to something, you don’t actually change how libcurl behaves or acts in regards to the particular request method, it will…