Section 3: library functions
NAME curl_global_init – Global libcurl initialisation SYNOPSIS #include <curl/curl.h> CURLcode curl_global_init(long flags); DESCRIPTION This function sets up the program environment that libcurl needs. Think of it as an extension of the library loader. This function must be called at least once within a program (a program is all the code that shares a memory space)…
NAME curl_global_cleanup – global libcurl cleanup SYNOPSIS #include <curl/curl.h> void curl_global_cleanup(void); DESCRIPTION This function releases resources acquired by curl_global_init(3). You should call curl_global_cleanup(3) once for each call you make to curl_global_init(3), after you are done using libcurl. This function is not thread safe. You must not call it when any other thread in the program…
NAME curl_getenv – return value for environment name SYNOPSIS #include <curl/curl.h> char *curl_getenv(const char *name); DESCRIPTION curl_getenv() is a portable wrapper for the getenv() function, meant to emulate its behaviour and provide an identical interface for all operating systems libcurl builds on (including win32). AVAILABILITY This function will be removed from the public libcurl API…
NAME curl_getdate – Convert a date string to number of seconds since January 1, 1970 SYNOPSIS #include <curl/curl.h> time_t curl_getdate(char *datestring, time_t *now ); DESCRIPTION This function returns the number of seconds since January 1st 1970 in the UTC time zone, for the date and time that the datestring parameter specifies. The now parameter is…
NAME curl_free – reclaim memory that has been obtained through a libcurl call SYNOPSIS #include <curl/curl.h> void curl_free( char *ptr ); DESCRIPTION curl_free reclaims memory that has been obtained through a libcurl call. Use curl_free() instead of free() to avoid anomalies that can result from differences in memory management between your application and libcurl. SEE…
NAME curl_formget – serialize a previously built multipart/formdata HTTP POST chain SYNOPSIS #include <curl/curl.h> void curl_formget(struct curl_httppost *form, void *userp, curl_formget_callback append); DESCRIPTION curl_formget() is used to serialize data previously built/appended with curl_formadd(3). Accepts a void pointer as second argument named userp which will be passed as the first argument to the curl_formget_callback function. typedef…
NAME curl_formfree – free a previously build multipart/formdata HTTP POST chain SYNOPSIS #include <curl/curl.h> void curl_formfree(struct curl_httppost *form); DESCRIPTION curl_formfree() is used to clean up data previously built/appended with curl_formadd(3). This must be called when the data has been used, which typically means after curl_easy_perform(3) has been called. The pointer to free is the same…
NAME curl_formadd – add a section to a multipart/formdata HTTP POST SYNOPSIS #include <curl/curl.h> CURLFORMcode curl_formadd(struct curl_httppost ** firstitem, struct curl_httppost ** lastitem, …); DESCRIPTION curl_formadd() is used to append sections when building a multipart/formdata HTTP POST (sometimes referred to as RFC2388-style posts). Append one section at a time until you’ve added all the sections…
NAME curl_escape – URL encodes the given string SYNOPSIS #include <curl/curl.h> char *curl_escape( char *url, int length ); DESCRIPTION Obsolete function. Use curl_easy_escape(3) instead! This function will convert the given input string to an URL encoded string and return that as a new allocated string. All input characters that are not a-z, A-Z or 0-9…
NAME curl_easy_unescape – URL decodes the given string SYNOPSIS #include <curl/curl.h> char *curl_easy_unescape( CURL *curl, char *url, int inlength , int *outlength ); DESCRIPTION This function converts the given URL encoded input string to a "plain string" and returns that in an allocated memory area. All input characters that are URL encoded (%XX where XX…
NAME curl_easy_strerror – return string describing error code SYNOPSIS #include <curl/curl.h> const char *curl_easy_strerror(CURLcode errornum); DESCRIPTION The curl_easy_strerror() function returns a string describing the CURLcode error code passed in the argument errornum. AVAILABILITY This function was added in libcurl 7.12.0 RETURN VALUE A pointer to a zero terminated string. SEE ALSO libcurl-errors(3), curl_multi_strerror(3), curl_share_strerror(3) Index
NAME curl_easy_setopt – set options for a curl easy handle SYNOPSIS #include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLoption option, parameter); DESCRIPTION curl_easy_setopt() is used to tell libcurl how to behave. By using the appropriate options to curl_easy_setopt, you can change libcurl’s behavior. All options are set with the option followed by a parameter. That parameter can…
NAME curl_easy_send – sends raw data over an "easy" connection SYNOPSIS #include <curl/easy.h> CURLcode curl_easy_send( CURL *curl, const void *buffer, size_t buflen, size_t *n); DESCRIPTION This function sends arbitrary data over the established connection. You may use it together with curl_easy_recv(3) to implement custom protocols using libcurl. This functionality can be particularly useful if you…
NAME curl_easy_reset – reset all options of a libcurl session handle SYNOPSIS #include <curl/curl.h> void curl_easy_reset(CURL *handle); DESCRIPTION Re-initializes all options previously set on a specified CURL handle to the default values. This puts back the handle to the same state as it was in when it was just created with curl_easy_init(3). It does not…
NAME curl_easy_recv – receives raw data on an "easy" connection SYNOPSIS #include <curl/easy.h> CURLcode curl_easy_recv( CURL *curl, void *buffer, size_t buflen, size_t *n); DESCRIPTION This function receives raw data from the established connection. You may use it together with curl_easy_send(3) to implement custom protocols using libcurl. This functionality can be particularly useful if you use…
NAME curl_easy_perform – Perform a file transfer SYNOPSIS #include <curl/curl.h> CURLcode curl_easy_perform(CURL *handle); DESCRIPTION This function is called after the init and all the curl_easy_setopt(3) calls are made, and will perform the transfer as described in the options. It must be called with the same handle as input as the curl_easy_init call returned. You can…
NAME curl_easy_pause – pause and unpause a connection SYNOPSIS #include <curl/curl.h> CURLcode curl_easy_pause(CURL *handle, int bitmask ); DESCRIPTION Using this function, you can explicitly mark a running connection to get paused, and you can unpause a connection that was previously paused. A connection can be paused by using this function or by letting the read…
NAME curl_easy_init – Start a libcurl easy session SYNOPSIS #include <curl/curl.h> CURL *curl_easy_init( ); DESCRIPTION This function must be the first function to call, and it returns a CURL easy handle that you must use as input to other easy-functions. curl_easy_init initializes curl and this call MUST have a corresponding call to curl_easy_cleanup(3) when the…
NAME curl_easy_getinfo – extract information from a curl handle SYNOPSIS #include <curl/curl.h> CURLcode curl_easy_getinfo(CURL *curl, CURLINFO info, … ); DESCRIPTION Request internal information from the curl session with this function. The third argument MUST be a pointer to a long, a pointer to a char *, a pointer to a struct curl_slist * or a…
NAME curl_easy_escape – URL encodes the given string SYNOPSIS #include <curl/curl.h> char *curl_easy_escape( CURL *curl, char *url, int length ); DESCRIPTION This function converts the given input string to an URL encoded string and returns that as a new allocated string. All input characters that are not a-z, A-Z, 0-9, ‘-‘, ‘.’, ‘_’ or ‘~’…