NAME curl_version_info – returns run-time libcurl version info SYNOPSIS #include <curl/curl.h> curl_version_info_data *curl_version_info( CURLversion type); DESCRIPTION Returns a pointer to a filled in struct with information about various run-time features in libcurl. type should be set to the version of this functionality by the time you write your program. This way, libcurl will always return…
NAME curl_version – returns the libcurl version string SYNOPSIS #include <curl/curl.h> char *curl_version( ); DESCRIPTION Returns a human readable string with the version number of libcurl and some of its important components (like OpenSSL version). RETURN VALUE A pointer to a zero terminated string. SEE ALSO curl_version_info(3) Index
NAME curl_unescape – URL decodes the given string SYNOPSIS #include <curl/curl.h> char *curl_unescape( char *url, int length ); DESCRIPTION Obsolete function. Use curl_easy_unescape(3) instead! This function will convert the given URL encoded input string to a "plain string" and return that as a new allocated string. All input characters that are URL encoded (%XX where…
NAME curl_strequal, curl_strnequal – case insensitive string comparisons SYNOPSIS #include <curl/curl.h> int curl_strequal(char *str1, char *str2); int curl_strenqual(char *str1, char *str2, size_t len); DESCRIPTION The curl_strequal() function compares the two strings str1 and str2, ignoring the case of the characters. It returns a non-zero (TRUE) integer if the strings are identical. The curl_strnequal() function is…
NAME curl_slist_free_all – free an entire curl_slist list SYNOPSIS #include <curl/curl.h> void curl_slist_free_all(struct curl_slist *list); DESCRIPTION curl_slist_free_all() removes all traces of a previously built curl_slist linked list. RETURN VALUE Nothing. SEE ALSO curl_slist_append(3), Index
NAME curl_slist_append – add a string to an slist SYNOPSIS #include <curl/curl.h> struct curl_slist *curl_slist_append(struct curl_slist *list, const char * string); DESCRIPTION curl_slist_append() appends a specified string to a linked list of strings. The existing list should be passed as the first argument while the new list is returned from this function. The specified string…
NAME curl_share_strerror – return string describing error code SYNOPSIS #include <curl/curl.h> const char *curl_share_strerror(CURLSHcode errornum); DESCRIPTION The curl_share_strerror() function returns a string describing the CURLSHcode 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_easy_strerror(3) Index
NAME curl_share_setopt – Set options for a shared object SYNOPSIS #include <curl/curl.h> CURLSHcode curl_share_setopt(CURLSH *share, CURLSHoption option, parameter); DESCRIPTION Set the option to parameter for the given share. OPTIONS CURLSHOPT_LOCKFUNC The parameter must be a pointer to a function matching the following prototype: void lock_function(CURL *handle, curl_lock_data data, curl_lock_access access, void *userptr); data defines what…
NAME curl_share_init – Create a shared object SYNOPSIS #include <curl/curl.h> CURLSH *curl_share_init( ); DESCRIPTION This function returns a CURLSH handle to be used as input to all the other share-functions, sometimes referred to as a share handle in some places in the documentation. This init call MUST have a corresponding call to curl_share_cleanup when all…
NAME curl_share_cleanup – Clean up a shared object SYNOPSIS #include <curl/curl.h> CURLSHcode curl_share_cleanup(CURLSH *share_handle); DESCRIPTION This function deletes a shared object. The share handle cannot be used anymore when this function has been called. RETURN VALUE CURLSHE_OK (zero) means that the option was set properly, non-zero means an error occurred as <curl/curl.h> defines. See the…
NAME curl_multi_wait – polls on all easy handles in a multi handle SYNOPSIS #include <curl/curl.h> CURLMcode curl_multi_wait(CURLM *multi_handle, struct curl_waitfd extra_fds[], unsigned int extra_nfds, int timeout_ms, int *numfds); DESCRIPTION This function polls on all file descriptors used by the curl easy handles contained in the given multi handle set. It will block until activity is…
NAME curl_multi_timeout – how long to wait for action before proceeding SYNOPSIS #include <curl/curl.h> CURLMcode curl_multi_timeout(CURLM *multi_handle, long *timeout); DESCRIPTION An application using the libcurl multi interface should call curl_multi_timeout(3) to figure out how long it should wait for socket actions – at most – before proceeding. Proceeding means either doing the socket-style timeout action:…
NAME curl_multi_strerror – return string describing error code SYNOPSIS #include <curl/curl.h> const char *curl_multi_strerror(CURLMcode errornum); DESCRIPTION The curl_multi_strerror() function returns a string describing the CURLMcode 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_easy_strerror(3), curl_share_strerror(3) Index
NAME curl_multi_socket_action – reads/writes available data given an action SYNOPSIS #include <curl/curl.h> CURLMcode curl_multi_socket_action(CURLM *multi_handle, curl_socket_t sockfd, int ev_bitmask, int *running_handles); DESCRIPTION When the application has detected action on a socket handled by libcurl, it should call curl_multi_socket_action(3) with the sockfd argument set to the socket with the action. When the events on a socket…
NAME curl_multi_socket – reads/writes available data SYNOPSIS #include <curl/curl.h> CURLMcode curl_multi_socket(CURLM *multi_handle, curl_socket_t sockfd, int *running_handles); CURLMcode curl_multi_socket_all(CURLM *multi_handle, int *running_handles); DESCRIPTION These functions are deprecated. Do not use! See curl_multi_socket_action(3) instead! At return, the integer running_handles points to will contain the number of still running easy handles within the multi handle. When this number…
NAME curl_multi_setopt – set options for a curl multi handle SYNOPSIS #include <curl/curl.h> CURLMcode curl_multi_setopt(CURLM * multi_handle, CURLMoption option, param); DESCRIPTION curl_multi_setopt() is used to tell a libcurl multi handle how to behave. By using the appropriate options to curl_multi_setopt(3), you can change libcurl’s behaviour when using that multi handle. All options are set with…
NAME curl_multi_remove_handle – remove an easy handle from a multi session SYNOPSIS #include <curl/curl.h> CURLMcode curl_multi_remove_handle(CURLM *multi_handle, CURL *easy_handle); DESCRIPTION Removes a given easy_handle from the multi_handle. This will make the specified easy handle be removed from this multi handle’s control. When the easy handle has been removed from a multi stack, it is again…
NAME curl_multi_perform – reads/writes available data from each easy handle SYNOPSIS #include <curl/curl.h> CURLMcode curl_multi_perform(CURLM *multi_handle, int *running_handles); DESCRIPTION This function handles transfers on all the added handles that need attention in an non-blocking fashion. When an application has found out there’s data available for the multi_handle or a timeout has elapsed, the application should…
NAME curl_multi_init – create a multi handle SYNOPSIS #include <curl/curl.h> CURLM *curl_multi_init( ); DESCRIPTION This function returns a CURLM handle to be used as input to all the other multi-functions, sometimes referred to as a multi handle in some places in the documentation. This init call MUST have a corresponding call to curl_multi_cleanup(3) when the…
NAME curl_multi_info_read – read multi stack informationals SYNOPSIS #include <curl/curl.h> CURLMsg *curl_multi_info_read( CURLM *multi_handle, int *msgs_in_queue); DESCRIPTION Ask the multi handle if there are any messages/informationals from the individual transfers. Messages may include informationals such as an error code from the transfer or just the fact that a transfer is completed. More details on these should…