Section 3: library functions
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…
CURLOPT_INFILESIZE – set size of the input file to send off Synopsis#include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_INFILESIZE, long 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 long. See also CURLOPT_INFILESIZE_LARGE(3) for…
CURLOPT_IGNORE_CONTENT_LENGTH – ignore Content-Length in HTTP response Synopsis#include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_IGNORE_CONTENT_LENGTH, long ignore);DescriptionIf ignore is set to 1, ignore the Content-Length header in the HTTP response. This is useful for Apache 1.x (and similar servers) which will report incorrect content length for files over 2 gigabytes. If this option is used, curl will…
CURLOPT_HTTP_VERSION – specify HTTP protocol version to use Synopsis#include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_HTTP_VERSION, long version); DescriptionPass version a long, set to one of the values described below. They force libcurl to use the specific HTTP versions. This is not sensible to do unless you have a good reason. You have to set this option…
CURLOPT_HTTP_TRANSFER_DECODING – enable/disable HTTP transfer decoding Synopsis#include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_HTTP_TRANSFER_DECODING, long enabled);DescriptionPass a long to tell libcurl how to act on transfer decoding. If set to zero, transfer decoding will be disabled, if set to 1 it is enabled (default). libcurl does chunked transfer decoding by default unless this option is set to…
CURLOPT_HTTP_CONTENT_DECODING – enable/disable HTTP content decoding Synopsis#include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_HTTP_CONTENT_DECODING, long enabled);DescriptionPass a long to tell libcurl how to act on content decoding. If set to zero, content decoding will be disabled. If set to 1 it is enabled. Libcurl has no default content decoding but requires you to use CURLOPT_ACCEPT_ENCODING(3) for that….
CURLOPT_HTTPPROXYTUNNEL – tunnel through HTTP proxy Synopsis#include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_HTTPPROXYTUNNEL, long tunnel); DescriptionSet the parameter to 1 to make libcurl tunnel all operations through the HTTP proxy. There is a big difference between using a proxy and to tunnel through it. If you don’t know what this means, you probably don’t want this…
CURLOPT_HTTPPOST – specify the multipart formpost content Synopsis#include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_HTTPPOST, struct curl_httppost *formpost);DescriptionTells libcurl you want a multipart/formdata HTTP POST to be made and you instruct what data to pass on to the server in the formpost argument. Pass a pointer to a linked list of curl_httppost structs as parameter. The easiest…