Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Thursday, June 13, 2019
 
 

curl_easy_cleanup (3)

Name

curl_easy_cleanup - End a libcurl easy handle

Synopsis

#include <curl/curl.h>

void curl_easy_cleanup(CURL *handle);

Description

curl_easy_cleanup(3)            libcurl Manual            curl_easy_cleanup(3)



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 han-
       dle using curl_easy_setopt(3)). Like if libcurl decides  to  shut  down
       the  connection  and  the  protocol  is  of a kind that requires a com-
       mand/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);
       }


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | web/curl         |
       +---------------+------------------+
       |Stability      | Uncommitted      |
       +---------------+------------------+
SEE ALSO
       curl_easy_init(3),     curl_easy_duphandle(3),      curl_easy_reset(3),
       curl_multi_cleanup(3), curl_multi_remove_handle(3)



NOTES
       This     software     was    built    from    source    available    at
       https://github.com/oracle/solaris-userland.   The  original   community
       source    was    downloaded    from    https://github.com/curl/curl/ar-
       chive/curl-7_64_0.zip

       Further information about this software can be found on the open source
       community website at http://curl.haxx.se/.



libcurl 7.17.0                    22 Aug 2007             curl_easy_cleanup(3)