"Fossies" - the Fresh Open Source Software Archive

Member "curl-7.67.0/docs/libcurl/curl_easy_cleanup.3" (6 Nov 2019, 3074 Bytes) of package /linux/www/curl-7.67.0.tar.xz:


Caution: As a special service "Fossies" has tried to format the requested manual source page into HTML format but links to other man pages may be missing or even erroneous. Alternatively you can here view or download the uninterpreted manual source code. A member file download can also be achieved by clicking within a package contents listing on the according byte size field. See also the latest Fossies "Diffs" side-by-side code changes report for "curl_easy_cleanup.3": 7.66.0_vs_7.67.0.

curl_easy_cleanup

NAME
SYNOPSIS
DESCRIPTION
OLD TIMES
RETURN VALUE
EXAMPLE
SEE ALSO

NAME

curl_easy_cleanup - End a libcurl easy handle

SYNOPSIS

#include <curl/curl.h>

void curl_easy_cleanup(CURL *handle);

DESCRIPTION

This function must be the last function to call for an easy session. It is the opposite of the curl_easy_init(3) function and must be called with the same handle as input that a curl_easy_init(3) call returned.

This might close all connections this handle has used and possibly has kept open until now - unless it was attached to a multi handle while doing the transfers. Don’t call this function if you intend to transfer more files, re-using handles is a key to good performance with libcurl.

Occasionally you may get your progress callback or header callback called from within curl_easy_cleanup(3) (if previously set for the handle using curl_easy_setopt(3)). Like if libcurl decides to shut down the connection and the protocol is of a kind that requires a command/response sequence before disconnect. Examples of such protocols are FTP, POP3 and IMAP.

Any use of the handle after this function has been called and have returned, is illegal. curl_easy_cleanup(3) kills the handle and all memory associated with it!

Passing in a NULL pointer in handle will make this function return immediately with no action.

OLD TIMES

For libcurl versions before 7.17,: after you’ve called this function, you can safely remove all the strings you’ve previously told libcurl to use, as it won’t use them anymore now.

RETURN VALUE

None

EXAMPLE

CURL *curl = curl_easy_init();
if(curl) {
CURLcode res;
curl_easy_setopt(curl, CURLOPT_URL, "http://example.com");
res = curl_easy_perform(curl);
curl_easy_cleanup(curl);
}

SEE ALSO

curl_easy_init(3), curl_easy_duphandle(3), curl_easy_reset(3), curl_multi_cleanup(3), curl_multi_remove_handle(3)