83 lines
3.0 KiB
Groff
83 lines
3.0 KiB
Groff
.\" **************************************************************************
|
|
.\" * _ _ ____ _
|
|
.\" * Project ___| | | | _ \| |
|
|
.\" * / __| | | | |_) | |
|
|
.\" * | (__| |_| | _ <| |___
|
|
.\" * \___|\___/|_| \_\_____|
|
|
.\" *
|
|
.\" * Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
|
|
.\" *
|
|
.\" * This software is licensed as described in the file COPYING, which
|
|
.\" * you should have received as part of this distribution. The terms
|
|
.\" * are also available at https://curl.se/docs/copyright.html.
|
|
.\" *
|
|
.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
|
|
.\" * copies of the Software, and permit persons to whom the Software is
|
|
.\" * furnished to do so, under the terms of the COPYING file.
|
|
.\" *
|
|
.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
|
|
.\" * KIND, either express or implied.
|
|
.\" *
|
|
.\" * SPDX-License-Identifier: curl
|
|
.\" *
|
|
.\" **************************************************************************
|
|
.\"
|
|
.TH curl_easy_cleanup 3 "22 Aug 2007" "libcurl" "libcurl"
|
|
.SH NAME
|
|
curl_easy_cleanup - End a libcurl easy handle
|
|
.SH SYNOPSIS
|
|
.nf
|
|
#include <curl/curl.h>
|
|
|
|
void curl_easy_cleanup(CURL *handle);
|
|
.fi
|
|
.SH DESCRIPTION
|
|
This function is the opposite of \fIcurl_easy_init(3)\fP. It closes down and
|
|
frees all resources previously associated with this easy handle.
|
|
|
|
This call closes all connections this handle has used and possibly has kept
|
|
open until now unless the easy handle was attached to a multi handle while
|
|
doing the transfers. Do not call this function if you intend to transfer more
|
|
files, reusing handles is a key to good performance with libcurl.
|
|
|
|
Occasionally you may get your progress callback or header callback called from
|
|
within \fIcurl_easy_cleanup(3)\fP (if previously set for the handle using
|
|
\fIcurl_easy_setopt(3)\fP). 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 easy \fBhandle\fP after this function has been called and have
|
|
returned, is illegal.
|
|
|
|
To close an easy handle that has been used with the multi interface, make sure
|
|
to first call \fIcurl_multi_remove_handle(3)\fP to remove it from the multi
|
|
handle before it is closed.
|
|
|
|
Passing in a NULL pointer in \fIhandle\fP makes this function return
|
|
immediately with no action.
|
|
.SH EXAMPLE
|
|
.nf
|
|
int main(void)
|
|
{
|
|
CURL *curl = curl_easy_init();
|
|
if(curl) {
|
|
CURLcode res;
|
|
curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
|
|
res = curl_easy_perform(curl);
|
|
if(res)
|
|
printf("error: %s\\n", curl_easy_strerror(res));
|
|
curl_easy_cleanup(curl);
|
|
}
|
|
}
|
|
.fi
|
|
.SH AVAILABILITY
|
|
Added in 7.1
|
|
.SH RETURN VALUE
|
|
None
|
|
.SH "SEE ALSO"
|
|
.BR curl_easy_duphandle (3),
|
|
.BR curl_easy_init (3),
|
|
.BR curl_easy_reset (3),
|
|
.BR curl_multi_cleanup (3),
|
|
.BR curl_multi_remove_handle (3)
|