| 1 |
.\" ************************************************************************** |
| 2 |
.\" * _ _ ____ _ |
| 3 |
.\" * Project ___| | | | _ \| | |
| 4 |
.\" * / __| | | | |_) | | |
| 5 |
.\" * | (__| |_| | _ <| |___ |
| 6 |
.\" * \___|\___/|_| \_\_____| |
| 7 |
.\" * |
| 8 |
.\" * Copyright (C) 1998 - 2018, Daniel Stenberg, <[email protected]>, et al. |
| 9 |
.\" * |
| 10 |
.\" * This software is licensed as described in the file COPYING, which |
| 11 |
.\" * you should have received as part of this distribution. The terms |
| 12 |
.\" * are also available at https://curl.haxx.se/docs/copyright.html. |
| 13 |
.\" * |
| 14 |
.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell |
| 15 |
.\" * copies of the Software, and permit persons to whom the Software is |
| 16 |
.\" * furnished to do so, under the terms of the COPYING file. |
| 17 |
.\" * |
| 18 |
.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY |
| 19 |
.\" * KIND, either express or implied. |
| 20 |
.\" * |
| 21 |
.\" ************************************************************************** |
| 22 |
.\" |
| 23 |
.TH curl_easy_cleanup 3 "22 Aug 2007" "libcurl 7.17.0" "libcurl Manual" |
| 24 |
.SH NAME |
| 25 |
curl_easy_cleanup - End a libcurl easy handle |
| 26 |
.SH SYNOPSIS |
| 27 |
.B #include <curl/curl.h> |
| 28 |
|
| 29 |
.BI "void curl_easy_cleanup(CURL *" handle ");" |
| 30 |
.SH DESCRIPTION |
| 31 |
This function must be the last function to call for an easy session. It is the |
| 32 |
opposite of the \fIcurl_easy_init(3)\fP function and must be called with the |
| 33 |
same \fIhandle\fP as input that a \fIcurl_easy_init(3)\fP call returned. |
| 34 |
|
| 35 |
This might close all connections this handle has used and possibly has kept |
| 36 |
open until now - unless it was attached to a multi handle while doing the |
| 37 |
transfers. Don't call this function if you intend to transfer more files, |
| 38 |
re-using handles is a key to good performance with libcurl. |
| 39 |
|
| 40 |
Occasionally you may get your progress callback or header callback called from |
| 41 |
within \fIcurl_easy_cleanup(3)\fP (if previously set for the handle using |
| 42 |
\fIcurl_easy_setopt(3)\fP). Like if libcurl decides to shut down the |
| 43 |
connection and the protocol is of a kind that requires a command/response |
| 44 |
sequence before disconnect. Examples of such protocols are FTP, POP3 and IMAP. |
| 45 |
|
| 46 |
Any use of the \fBhandle\fP after this function has been called and have |
| 47 |
returned, is illegal. \fIcurl_easy_cleanup(3)\fP kills the handle and all |
| 48 |
memory associated with it! |
| 49 |
|
| 50 |
Passing in a NULL pointer in \fIhandle\fP will make this function return |
| 51 |
immediately with no action. |
| 52 |
.SH "OLD TIMES" |
| 53 |
For libcurl versions before 7.17,: after you've called this function, you can |
| 54 |
safely remove all the strings you've previously told libcurl to use, as it |
| 55 |
won't use them anymore now. |
| 56 |
.SH RETURN VALUE |
| 57 |
None |
| 58 |
.SH EXAMPLE |
| 59 |
.nf |
| 60 |
CURL *curl = curl_easy_init(); |
| 61 |
if(curl) { |
| 62 |
CURLcode res; |
| 63 |
curl_easy_setopt(curl, CURLOPT_URL, "http://example.com"); |
| 64 |
res = curl_easy_perform(curl); |
| 65 |
curl_easy_cleanup(curl); |
| 66 |
} |
| 67 |
.fi |
| 68 |
.SH "SEE ALSO" |
| 69 |
.BR curl_easy_init "(3), " curl_easy_duphandle "(3), " |
| 70 |
.BR curl_easy_reset "(3), " |
| 71 |
.BR curl_multi_cleanup "(3), " curl_multi_remove_handle "(3) " |