Section 3: library functions
CURLOPT_CUSTOMREQUEST – custom string for request Synopsis#include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_CUSTOMREQUEST, char *request); DescriptionPass 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 only change…
CURLOPT_CRLFILE – specify a Certificate Revocation List file Synopsis#include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_CRLFILE, char *file); DescriptionPass a char * to a zero terminated string naming a file with the concatenation of CRL (in PEM format) to use in the certificate validation that occurs during the SSL exchange. When curl is built to use NSS…
CURLOPT_CRLF – enable/disable CRLF conversion Synopsis#include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_CRLF, long conv); DescriptionPass a long. If the value is set to 1 (one), libcurl converts Unix newlines to CRLF newlines on transfers. Disable this option again by setting the value to 0 (zero). This is a legacy option of questionable use. Default0 ProtocolsAll ExampleTODO…
CURLOPT_COPYPOSTFIELDS – have libcurl copy data to POST Synopsis#include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_COPYPOSTFIELDS, char *data); DescriptionPass a char * as parameter, which should be the full data to post in a HTTP POST operation. It behaves as the CURLOPT_POSTFIELDS(3) option, but the original data is instead copied by the library, allowing the application to…
CURLOPT_COOKIESESSION – start a new cookie session Synopsis#include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_COOKIESESSION, long init); DescriptionPass a long set to 1 to mark this as a new cookie "session". It will force libcurl to ignore all cookies it is about to load that are "session cookies" from the previous session. By default, libcurl always stores…
CURLOPT_COOKIELIST – add to or manipulate cookies held in memory Synopsis#include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_COOKIELIST, char *cookie);DescriptionPass a char * to a cookie string. Such a cookie can be either a single line in Netscape / Mozilla format or just regular HTTP-style header (Set-Cookie: …) format. This will also enable the cookie engine. This…
CURLOPT_COOKIEJAR – file name to store cookies to Synopsis#include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_COOKIEJAR, char *filename); DescriptionPass a filename as char *, zero terminated. This will make libcurl write all internally known cookies to the specified file when curl_easy_cleanup(3) is called. If no cookies are known, no file will be created. Specify "-" as filename…
CURLOPT_COOKIEFILE – file name to read cookies from Synopsis#include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_COOKIEFILE, char *filename); DescriptionPass a pointer to a zero terminated string as parameter. It should point to the file name of your file holding cookie data to read. The cookie data can be in either the old Netscape / Mozilla cookie data…
CURLOPT_COOKIE – set contents of HTTP Cookie header Synopsis#include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_COOKIE, char *cookie); DescriptionPass a pointer to a zero terminated string as parameter. It will be used to set a cookie in the HTTP request. The format of the string should be NAME=CONTENTS, where NAME is the cookie name and CONTENTS is…
CURLOPT_CONV_TO_NETWORK_FUNCTION – convert data to network from host encoding Synopsis#include <curl/curl.h> CURLcode conv_callback(char *ptr, size_t length); CURLcode curl_easy_setopt(CURL *handle, CURLOPT_CONV_TO_NETWORK_FUNCTION, conv_callback);DescriptionPass a pointer to your callback function, which should match the prototype shown above. Applies to non-ASCII platforms. curl_version_info(3) will return the CURL_VERSION_CONV feature bit set if this option is provided. The data to be…
CURLOPT_CONV_FROM_UTF8_FUNCTION – convert data from UTF8 to host encoding Synopsis#include <curl/curl.h> CURLcode conv_callback(char *ptr, size_t length); CURLcode curl_easy_setopt(CURL *handle, CURLOPT_CONV_FROM_UTF8_FUNCTION, conv_callback);DescriptionPass a pointer to your callback function, which should match the prototype shown above. Applies to non-ASCII platforms. curl_version_info(3) will return the CURL_VERSION_CONV feature bit set if this option is provided. The data to be…
CURLOPT_CONV_FROM_NETWORK_FUNCTION – convert data from network to host encoding Synopsis#include <curl/curl.h> CURLcode conv_callback(char *ptr, size_t length); CURLcode curl_easy_setopt(CURL *handle, CURLOPT_CONV_FROM_NETWORK_FUNCTION, conv_callback);DescriptionPass a pointer to your callback function, which should match the prototype shown above. Applies to non-ASCII platforms. curl_version_info(3) will return the CURL_VERSION_CONV feature bit set if this option is provided. The data to be…
CURLOPT_CONNECT_ONLY – stop when connected to target server Synopsis#include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_CONNECT_ONLY, long only); DescriptionPass a long. If the parameter equals 1, it tells the library to perform all the required proxy authentication and connection setup, but no data transfer, and then return. The option can be used to simply test a connection…
CURLOPT_CONNECTTIMEOUT_MS – timeout for the connect phase Synopsis#include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_CONNECTTIMEOUT_MS, long timeout); DescriptionPass a long. It should contain the maximum time in milliseconds that you allow the connection phase to the server to take. This only limits the connection phase, it has no impact once it has connected. Set to zero to…
CURLOPT_CONNECTTIMEOUT – timeout for the connect phase Synopsis#include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_CONNECTTIMEOUT, long timeout); DescriptionPass a long. It should contain the maximum time in seconds that you allow the connection phase to the server to take. This only limits the connection phase, it has no impact once it has connected. Set to zero to…
CURLOPT_CLOSESOCKETFUNCTION – callback to socket close replacement function Synopsis#include <curl/curl.h> int closesocket_callback(void *clientp, curl_socket_t item); CURLcode curl_easy_setopt(CURL *handle, CURLOPT_CLOSESOCKETFUNCTION, closesocket_callback); DescriptionPass a pointer to your callback function, which should match the prototype shown above. This callback function gets called by libcurl instead of the close(3) or closesocket(3) call when sockets are closed (not for any…
CURLOPT_CLOSESOCKETDATA – pointer passed to the socket close callback Synopsis#include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_CLOSESOCKETDATA, void *pointer); DescriptionPass a pointer that will be untouched by libcurl and passed as the first argument in the closesocket callback set with CURLOPT_CLOSESOCKETFUNCTION(3). DefaultThe default value of this parameter is NULL. ProtocolsAll except file: ExampleTODO AvailabilityAdded in 7.21.7 Return…
CURLOPT_CHUNK_END_FUNCTION – callback after a transfer with FTP wildcardmatch Synopsis#include <curl/curl.h> long chunk_end_callback(void *ptr); CURLcode curl_easy_setopt(CURL *handle, CURLOPT_CHUNK_END_FUNCTION, chunk_end_callback);DescriptionPass a pointer to your callback function, which should match the prototype shown above. This function gets called by libcurl as soon as a part of the stream has been transferred (or skipped). Return CURL_CHUNK_END_FUNC_OK if everything…
CURLOPT_CHUNK_DATA – custom pointer to the FTP chunk callbacks Synopsis#include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_CHUNK_DATA, void *pointer); DescriptionPass a pointer that will be untouched by libcurl and passed as the ptr argument to the CURL_CHUNK_BGN_FUNTION(3) and CURL_CHUNK_END_FUNTION(3). DefaultNULL ProtocolsFTP ExampleTODO AvailabilityAdded in 7.21.0 Return ValueReturns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not….
CURLOPT_CHUNK_BGN_FUNCTION – callback before a transfer with FTP wildcardmatch Synopsis#include <curl/curl.h> long chunk_bgn_callback(const void *transfer_info, void *ptr, int remains); CURLcode curl_easy_setopt(CURL *handle, CURLOPT_CHUNK_BGN_FUNCTION, chunk_bgn_callback);DescriptionPass a pointer to your callback function, which should match the prototype shown above. This callback function gets called by libcurl before a part of the stream is going to be transferred…