NAME curl_multi_fdset – extracts file descriptor information from a multi handle SYNOPSIS #include <curl/curl.h> CURLMcode curl_multi_fdset(CURLM *multi_handle, fd_set *read_fd_set, fd_set *write_fd_set, fd_set *exc_fd_set, int *max_fd); DESCRIPTION This function extracts file descriptor information from a given multi_handle. libcurl returns its fd_set sets. The application can use these to select() on, but be sure to FD_ZERO them…
NAME curl_multi_cleanup – close down a multi session SYNOPSIS #include <curl/curl.h> CURLMcode curl_multi_cleanup( CURLM *multi_handle ); DESCRIPTION Cleans up and removes a whole multi stack. It does not free or touch any individual easy handles in any way – they still need to be closed individually, using the usual curl_easy_cleanup(3) way. The order of cleaning…
NAME curl_multi_assign – set data to association with an internal socket SYNOPSIS #include <curl/curl.h> CURLMcode curl_multi_assign(CURLM *multi_handle, curl_socket_t sockfd, void *sockptr); DESCRIPTION This function assigns an association in the multi handle between the given socket and a private pointer of the application. This is (only) useful for curl_multi_socket(3) uses. When set, the sockptr pointer will be…
NAME curl_multi_add_handle – add an easy handle to a multi session SYNOPSIS #include <curl/curl.h> CURLMcode curl_multi_add_handle(CURLM *multi_handle, CURL *easy_handle); DESCRIPTION Adds a standard easy handle to the multi stack. This function call will make this multi_handle control the specified easy_handle. Furthermore, libcurl now initiates the connection associated with the specified easy_handle. When an easy handle…
NAME curl_maprintf, curl_mfprintf, curl_mprintf, curl_msnprintf, curl_msprintf curl_mvaprintf, curl_mvfprintf, curl_mvprintf, curl_mvsnprintf, curl_mvsprintf – formatted output conversion SYNOPSIS #include <curl/mprintf.h> int curl_mprintf(const char *format, …); int curl_mfprintf(FILE *fd, const char *format, …); int curl_msprintf(char *buffer, const char *format, …); int curl_msnprintf(char *buffer, size_t maxlength, const char *format, …); int curl_mvprintf(const char *format, va_list args); int curl_mvfprintf(FILE *fd,…
NAME curl_global_init_mem – Global libcurl initialisation with memory callbacks SYNOPSIS #include <curl/curl.h> CURLcode curl_global_init_mem(long flags, curl_malloc_callback m, curl_free_callback f, curl_realloc_callback r, curl_strdup_callback s, curl_calloc_callback c ); DESCRIPTION This function works exactly as curl_global_init(3) with one addition: it allows the application to set callbacks to replace the otherwise used internal memory functions. This man page only…
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…